* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ declare(strict_types=1); namespace League\Uri\Components; use BackedEnum; use Deprecated; use League\Uri\Contracts\UriComponentInterface; use League\Uri\Contracts\UriInterface; use League\Uri\Exceptions\SyntaxError; use League\Uri\SchemeType; use League\Uri\StringCoercionMode; use League\Uri\UriScheme; use League\Uri\UriString; use Psr\Http\Message\UriInterface as Psr7UriInterface; use Stringable; use Throwable; use Uri\Rfc3986\Uri as Rfc3986Uri; use Uri\WhatWg\Url as WhatWgUrl; use function count; use function in_array; use function preg_match; use function sprintf; use function strtolower; final class Scheme extends Component { private const REGEXP_SCHEME = ',^[a-z]([-a-z0-9+.]+)?$,i'; private readonly ?string $scheme; private readonly ?UriScheme $uriScheme; private function __construct(BackedEnum|Stringable|string|null $scheme) { $this->scheme = $this->validate($scheme); $this->uriScheme = UriScheme::tryFrom((string) $this->scheme); } public function isWebsocket(): bool { return in_array($this->scheme, ['ws', 'wss'], true); } public function isHttp(): bool { return in_array($this->scheme, ['http', 'https'], true); } public function isSsl(): bool { return in_array($this->scheme, ['https', 'wss'], true); } public function isSpecial(): bool { return $this->isWhatWgSpecial() || in_array($this->scheme, ['data', 'file'], true); } public function isWhatWgSpecial(): bool { return $this->uriScheme?->isWhatWgSpecial() ?? false; } public function defaultPort(): Port { return Port::new($this->uriScheme?->port()); } public function hasDefaultPort(): bool { static $emptyPort = null; $emptyPort ??= Port::new(); return !$emptyPort->equals($this->defaultPort()); } public function type(): SchemeType { return $this->uriScheme?->type() ?? SchemeType::Unknown; } /** * Validate a scheme. * * @throws SyntaxError if the scheme is invalid */ private function validate(BackedEnum|Stringable|string|null $scheme): ?string { $scheme = self::filterComponent($scheme); if (null === $scheme) { return null; } $fScheme = strtolower($scheme); /** @var array $inMemoryCache */ static $inMemoryCache = []; if (isset($inMemoryCache[$fScheme])) { return $fScheme; } if (1 !== preg_match(self::REGEXP_SCHEME, $fScheme)) { throw new SyntaxError(sprintf("The scheme '%s' is invalid.", $scheme)); } if (100 < count($inMemoryCache)) { unset($inMemoryCache[array_key_first($inMemoryCache)]); } $inMemoryCache[$fScheme] = 1; return $fScheme; } public static function new(BackedEnum|Stringable|string|null $value = null): self { return new self($value); } /** * Create a new instance from a string.or a stringable structure or returns null on failure. */ public static function tryNew(BackedEnum|Stringable|string|null $uri = null): ?self { try { return self::new($uri); } catch (Throwable) { return null; } } /** * Create a new instance from a URI object. */ public static function fromUri(WhatWgUrl|Rfc3986Uri|BackedEnum|Stringable|string $uri): self { $uri = self::filterUri($uri); return new self( $uri instanceof Psr7UriInterface ? UriString::parse($uri)['scheme'] : $uri->getScheme() ); } public function value(): ?string { return $this->scheme; } public function getUriComponent(): string { return $this->value().(null === $this->scheme ? '' : ':'); } public function equals(mixed $value): bool { if (!StringCoercionMode::Native->isCoercible($value)) { return false; } if (!$value instanceof UriComponentInterface) { $value = self::tryNew(StringCoercionMode::Native->coerce($value)); if (null === $value) { return false; } } return $value->getUriComponent() === $this->getUriComponent(); } /** * DEPRECATION WARNING! This method will be removed in the next major point release. * * @deprecated Since version 7.0.0 * @see Scheme::new() * * @codeCoverageIgnore */ #[Deprecated(message:'use League\Uri\Components\Scheme::new() instead', since:'league/uri-components:7.0.0')] public static function createFromString(Stringable|string $scheme): self { return self::new($scheme); } /** * DEPRECATION WARNING! This method will be removed in the next major point release. * * @deprecated Since version 7.0.0 * @see Scheme::fromUri() * * @codeCoverageIgnore * * Create a new instance from a URI object. */ #[Deprecated(message:'use League\Uri\Components\Scheme::fromUri() instead', since:'league/uri-components:7.0.0')] public static function createFromUri(Psr7UriInterface|UriInterface $uri): self { return self::fromUri($uri); } }