Class Salient\Http\Uri

`implements`	`UriInterface`
`uses`	`HasMutator`


					final
	public

__construct(string $uri = '', bool $strict = false)

Creates a new Uri object

Parameters

$strict

If false, unencoded characters are percent-encoded before parsing.

#


					
	public
					static

from(UriInterface|Stringable|string $uri): static

Resolve a value to a Uri object

#


					
	public
					static

fromParts(
	array{scheme?: string, host?: string, port?: int, user?: string, pass?: string, path?: string, query?: string, fragment?: string} $parts,
): static

Get a new instance from an array of URI components

Accepts arrays returned by {@see parse_url()}, {@see UriInterface::parse()} and {@see UriInterface::toParts()}.

#


					
	public
					static

parse(string $uri, ?int $component = null, bool $strict = false)

Parse a URI into its components

This method should be used instead of {@see parse_url()} in scenarios where using multiple URI parsers could introduce inconsistent behaviour or security vulnerabilities.

Parameters

$strict

If false, unencoded characters are percent-encoded before parsing.

Implements

Salient\Contract\Http\UriInterface::parse()

#


					
	public
					static

unparse(
	array{scheme?: string, host?: string, port?: int, user?: string, pass?: string, path?: string, query?: string, fragment?: string} $parts,
): string

Convert an array of URI components to a URI

Accepts arrays returned by {@see parse_url()}, {@see UriInterface::parse()} and {@see UriInterface::toParts()}.

#


					
	public
					static

resolveReference(UriInterface|Stringable|string $reference, UriInterface|Stringable|string $baseUri): string

Resolve a URI reference relative to a given base URI

#


					
	public
					static

isAuthorityForm(string $requestTarget): bool

Check if a value is a valid authority-form request target

[RFC7230], Section 5.3.3: "When making a CONNECT request to establish a tunnel through one or more proxies, a client MUST send only the target URI's authority component (excluding any userinfo and its "@" delimiter) as the request-target."

#


					
	public

toParts(): array

Get the URI as an array of components

Components not present in the URI are not returned.

Implements

Salient\Contract\Http\UriInterface::toParts()

#


					
	public

isReference(): bool

Check if the URI is a relative reference

Implements

Salient\Contract\Http\UriInterface::isReference()

#


					
	public

getScheme(): string

Retrieve the scheme component of the URI.

If no scheme is present, this method MUST return an empty string.

The value returned MUST be normalized to lowercase, per RFC 3986 Section 3.1.

The trailing ":" character is not part of the scheme and MUST NOT be added.

Returns

The URI scheme.

Implements

Psr\Http\Message\UriInterface::getScheme()

#


					
	public

getAuthority(): string

Retrieve the authority component of the URI.

If no authority information is present, this method MUST return an empty string.

The authority syntax of the URI is:

[user-info@]host[:port]

If the port component is not set or is the standard port for the current scheme, it SHOULD NOT be included.

Returns

The URI authority, in "[user-info@]host[:port]" format.

Implements

Psr\Http\Message\UriInterface::getAuthority()

#


					
	public

getUserInfo(): string

Retrieve the user information component of the URI.

If no user information is present, this method MUST return an empty string.

If a user is present in the URI, this will return that value; additionally, if the password is also present, it will be appended to the user value, with a colon (":") separating the values.

The trailing "@" character is not part of the user information and MUST NOT be added.

Returns

The URI user information, in "username[:password]" format.

Implements

Psr\Http\Message\UriInterface::getUserInfo()

#


					
	public

getHost(): string

Retrieve the host component of the URI.

If no host is present, this method MUST return an empty string.

The value returned MUST be normalized to lowercase, per RFC 3986 Section 3.2.2.

Returns

The URI host.

Implements

Psr\Http\Message\UriInterface::getHost()

#


					
	public

getPort(): ?int

Retrieve the port component of the URI.

If a port is present, and it is non-standard for the current scheme, this method MUST return it as an integer. If the port is the standard port used with the current scheme, this method SHOULD return null.

If no port is present, and no scheme is present, this method MUST return a null value.

If no port is present, but a scheme is present, this method MAY return the standard port for that scheme, but SHOULD return null.

Returns

The URI port.

Implements

Psr\Http\Message\UriInterface::getPort()

#


					
	public

getPath(): string

Retrieve the path component of the URI.

The path can either be empty or absolute (starting with a slash) or rootless (not starting with a slash). Implementations MUST support all three syntaxes.

Normally, the empty path "" and absolute path "/" are considered equal as defined in RFC 7230 Section 2.7.3. But this method MUST NOT automatically do this normalization because in contexts with a trimmed base path, e.g. the front controller, this difference becomes significant. It's the task of the user to handle both "" and "/".

The value returned MUST be percent-encoded, but MUST NOT double-encode any characters. To determine what characters to encode, please refer to RFC 3986, Sections 2 and 3.3.

As an example, if the value should include a slash ("/") not intended as delimiter between path segments, that value MUST be passed in encoded form (e.g., "%2F") to the instance.

Returns

The URI path.

Implements

Psr\Http\Message\UriInterface::getPath()

#


					
	public

getQuery(): string

Retrieve the query string of the URI.

If no query string is present, this method MUST return an empty string.

The leading "?" character is not part of the query and MUST NOT be added.

The value returned MUST be percent-encoded, but MUST NOT double-encode any characters. To determine what characters to encode, please refer to RFC 3986, Sections 2 and 3.4.

As an example, if a value in a key/value pair of the query string should include an ampersand ("&") not intended as a delimiter between values, that value MUST be passed in encoded form (e.g., "%26") to the instance.

Returns

The URI query string.

Implements

Psr\Http\Message\UriInterface::getQuery()

#


					
	public

getFragment(): string

Retrieve the fragment component of the URI.

If no fragment is present, this method MUST return an empty string.

The leading "#" character is not part of the fragment and MUST NOT be added.

The value returned MUST be percent-encoded, but MUST NOT double-encode any characters. To determine what characters to encode, please refer to RFC 3986, Sections 2 and 3.5.

Returns

The URI fragment.

Implements

Psr\Http\Message\UriInterface::getFragment()

#


					
	public

withScheme(string $scheme): UriInterface

Return an instance with the specified scheme.

This method MUST retain the state of the current instance, and return an instance that contains the specified scheme.

Implementations MUST support the schemes "http" and "https" case insensitively, and MAY accommodate other schemes if required.

An empty scheme is equivalent to removing the scheme.

Parameters

$scheme

The scheme to use with the new instance.

Returns

A new instance with the specified scheme.

Implements

Psr\Http\Message\UriInterface::withScheme()

#


					
	public

withUserInfo(string $user, ?string $password = null): UriInterface

Return an instance with the specified user information.

This method MUST retain the state of the current instance, and return an instance that contains the specified user information.

Password is optional, but the user information MUST include the user; an empty string for the user is equivalent to removing user information.

Parameters

`$user`	The user name to use for authority.
`$password`	The password associated with $user.

Returns

A new instance with the specified user information.

Implements

Psr\Http\Message\UriInterface::withUserInfo()

#


					
	public

withHost(string $host): UriInterface

Return an instance with the specified host.

This method MUST retain the state of the current instance, and return an instance that contains the specified host.

An empty host value is equivalent to removing the host.

Parameters

$host

The hostname to use with the new instance.

Returns

A new instance with the specified host.

Implements

Psr\Http\Message\UriInterface::withHost()

#


					
	public

withPort(?int $port): UriInterface

Return an instance with the specified port.

This method MUST retain the state of the current instance, and return an instance that contains the specified port.

Implementations MUST raise an exception for ports outside the established TCP and UDP port ranges.

A null value provided for the port is equivalent to removing the port information.

Parameters

$port

The port to use with the new instance; a null value removes the port information.

Returns

A new instance with the specified port.

Implements

Psr\Http\Message\UriInterface::withPort()

#


					
	public

withPath(string $path): UriInterface

Return an instance with the specified path.

This method MUST retain the state of the current instance, and return an instance that contains the specified path.

The path can either be empty or absolute (starting with a slash) or rootless (not starting with a slash). Implementations MUST support all three syntaxes.

If the path is intended to be domain-relative rather than path relative then it must begin with a slash ("/"). Paths not starting with a slash ("/") are assumed to be relative to some base path known to the application or consumer.

Users can provide both encoded and decoded path characters. Implementations ensure the correct encoding as outlined in getPath().

Parameters

$path

The path to use with the new instance.

Returns

A new instance with the specified path.

Implements

Psr\Http\Message\UriInterface::withPath()

#


					
	public

withQuery(string $query): UriInterface

Return an instance with the specified query string.

This method MUST retain the state of the current instance, and return an instance that contains the specified query string.

Users can provide both encoded and decoded query characters. Implementations ensure the correct encoding as outlined in getQuery().

An empty query string value is equivalent to removing the query string.

Parameters

$query

The query string to use with the new instance.

Returns

A new instance with the specified query string.

Implements

Psr\Http\Message\UriInterface::withQuery()

#


					
	public

withFragment(string $fragment): UriInterface

Return an instance with the specified URI fragment.

This method MUST retain the state of the current instance, and return an instance that contains the specified URI fragment.

Users can provide both encoded and decoded fragment characters. Implementations ensure the correct encoding as outlined in getFragment().

An empty fragment value is equivalent to removing the fragment.

Parameters

$fragment

The fragment to use with the new instance.

Returns

A new instance with the specified fragment.

Implements

Psr\Http\Message\UriInterface::withFragment()

#


					
	public

normalise(
	int-mask-of<Uri::EXPAND_EMPTY_PATH|Uri::COLLAPSE_MULTIPLE_SLASHES> $flags = Uri::EXPAND_EMPTY_PATH,
): UriInterface

Get a normalised instance

Removes "/./" and "/../" segments from the path. [RFC3986]-compliant scheme- and protocol-based normalisation may also be performed.

Scheme, host and percent-encoded octets in the URI are not normalised by this method because they are always normalised.

Implements

Salient\Contract\Http\UriInterface::normalise()

#


					
	public

follow($reference): UriInterface

Resolve a URI reference to a target URI with the instance as its base URI

Implements [RFC3986] Section 5.2.2 ("Transform References").

Implements

Salient\Contract\Http\UriInterface::follow()

#


					
	public

removeDotSegments(): static

Get an instance with "/./" and "/../" segments removed from the path

Compliant with [RFC3986] Section 5.2.4 ("Remove Dot Segments").

#


					
	public

__toString(): string

Return the string representation as a URI reference.

Depending on which components of the URI are present, the resulting string is either a full URI or relative reference according to RFC 3986, Section 4.1. The method concatenates the various components of the URI, using the appropriate delimiters:

If a scheme is present, it MUST be suffixed by ":".
If an authority is present, it MUST be prefixed by "//".
The path can be concatenated without delimiters. But there are two cases where the path has to be adjusted to make the URI reference valid as PHP does not allow to throw an exception in __toString():
- If the path is rootless and an authority is present, the path MUST be prefixed by "/".
- If the path is starting with more than one "/" and no authority is present, the starting slashes MUST be reduced to one.
If a query is present, it MUST be prefixed by "?".
If a fragment is present, it MUST be prefixed by "#".

Implements

Psr\Http\Message\UriInterface::__toString()

#


					
	public

jsonSerialize(): string

Implements

JsonSerializable::jsonSerialize()

#

Constants
`public`	`EXPAND_EMPTY_PATH = 1` Replace empty HTTP and HTTPS paths with "/" Replace empty HTTP and HTTPS paths with "/"	#
`public`	`COLLAPSE_MULTIPLE_SLASHES = 2` Collapse two or more subsequent slashes in the path (e.g. "//") to a single slash ("/") Collapse two or more subsequent slashes in the path (e.g. "//") to a single slash ("/")	#
`protected`	`SCHEME_PORT = ['http' => 80, 'https' => 443]`	#

Properties
`protected`	`?string`	`$Scheme = null`	#
`protected`	`?string`	`$User = null`	#
`protected`	`?string`	`$Password = null`	#
`protected`	`?string`	`$Host = null`	#
`protected`	`?int`	`$Port = null`	#
`protected`	`string`	`$Path = ''`	#
`protected`	`?string`	`$Query = null`	#
`protected`	`?string`	`$Fragment = null`	#

Namespaces

Classes

Traits

Parameters

Parameters

Implements

Implements

Implements

Returns

Implements

Returns

Implements

Returns

Implements

Returns

Implements

Returns

Implements

Returns

Implements

Returns

Implements

Returns

Implements

Parameters

Returns

Implements

Parameters

Returns

Implements

Parameters

Returns

Implements

Parameters

Returns

Implements

Parameters

Returns

Implements

Parameters

Returns

Implements

Parameters

Returns

Implements

Implements

Implements

Implements

Implements