Return the string representation as a URI reference.
Composes a URI reference string from its various components.
Whether the URI has the default port of the current scheme.
Whether the URI is absolute, i.e. it has a scheme.
Whether the URI is a network-path reference.
Whether the URI is a absolute-path reference.
Whether the URI is a relative-path reference.
Whether the URI is a same-document reference.
Removes dot segments from a path and returns the new path.
Converts the relative URI into a new URI that is resolved against the base URI.
Creates a new URI with a specific query string value removed.
Creates a new URI with a specific query string value.
Creates a new URI with multiple specific query string values.
Creates a URI from a hash of parse_url components.
Retrieve the scheme component of the URI.
Retrieve the authority component of the URI.
Retrieve the user information component of the URI.
Retrieve the host component of the URI.
Retrieve the port component of the URI.
Retrieve the path component of the URI.
Retrieve the query string of the URI.
Retrieve the fragment component of the URI.
Return an instance with the specified scheme.
Return an instance with the specified user information.
Return an instance with the specified host.
Return an instance with the specified port.
Return an instance with the specified path.
Return an instance with the specified query string.
Return an instance with the specified URI fragment.
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 "#".
Usually this method does not need to be called manually but instead is used indirectly via Psr\Http\Message\UriInterface::__toString.
PSR-7 UriInterface treats an empty component the same as a missing component as getQuery(), getFragment() etc. always return a string. This explains the slight difference to RFC 3986 Section 5.3.
Another adjustment is that the authority separator is added even when the authority is missing/empty for the "file" scheme. This is because PHP stream functions like file_get_contents only work with file:///myfile but not with file:/myfile although they are equivalent according to RFC 3986. But file:/// is the more common syntax for the file scheme anyway (Chrome for example redirects to that format).
Psr\Http\Message\UriInterface::getPort may return null or the standard port. This method can be used independently of the implementation.
A relative reference that begins with two slash characters is termed an network-path reference.
A relative reference that begins with a single slash character is termed an absolute-path reference.
A relative reference that does not begin with a slash character is termed a relative-path reference.
A same-document reference refers to a URI that is, aside from its fragment component, identical to the base URI. When no base URI is given, only an empty URI reference (apart from its fragment) is considered a same-document reference.
since version 1.4. Use UriResolver::removeDotSegments instead.
since version 1.4. Use UriResolver::resolve instead.
Any existing query string values that exactly match the provided key are removed.
Psr\Http\Message\UriInterface $uri URI to use as a base.
string $key Query string key to remove.
Any existing query string values that exactly match the provided key are removed and replaced with the given key value pair.
A value of null will set the query string key without a value, e.g. "key" instead of "key=value".
string $key Key to set.
It has the same behavior as withQueryValue() but for an associative array of key => value.
If the components do not form a valid 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.
If no authority information is present, this method MUST return an empty string.
If the port component is not set or is the standard port for the current scheme, it SHOULD NOT be included.
The URI authority, in "[user-info@]host[:port]" format.
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.
The URI user information, in "username[:password]" format.
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.
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.
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.
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.
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.
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.
string $scheme The scheme to use with the new instance.
A new instance with the specified scheme.
for invalid or unsupported schemes.
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.
string $user The user name to use for authority.
null|string $password = null The password associated with $user.
A new instance with the specified user information.
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.
string $host The hostname to use with the new instance.
A new instance with the specified host.
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.
The port to use with the new instance; a null value removes the port information.
A new instance with the specified port.
This method MUST retain the state of the current instance, and return an instance that contains the specified path.
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().
string $path The path to use with the new instance.
A new instance with the specified path.
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.
string $query The query string to use with the new instance.
A new instance with the specified query string.
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.
string $fragment The fragment to use with the new instance.
A new instance with the specified fragment.
Absolute http and https URIs require a host per RFC 7230 Section 2.7 but in generic URIs the host can be empty. So for http(s) URIs we apply this default host when no host is given yet to form a valid URI.