Interface League\Uri\Contracts\UriInterface

Returns the string representation as a URI reference.

Returns the string representation as a URI reference.

Returns the string representation as a URI reference.

Retrieve the scheme component of the URI.

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

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.

Retrieve the authority component of the URI.

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

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

Retrieve the user information component of the URI.

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

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.

Retrieve the host component of the URI.

If no host is present this method MUST return a null value.

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

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.

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.

Retrieve the query string of the URI.

If no host is present this method MUST return a null value.

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.

Retrieve the fragment component of the URI.

If no host is present this method MUST return a null value.

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 an associative array containing all the URI components.

The returned array is similar to PHP's parse_url return value with the following differences:

• All components are present in the returned array
• Empty and undefined component are treated differently. And empty component is set to the empty string while an undefined component is set to the `null` value.

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.

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

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; a null value for the user is equivalent to removing user information.

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.

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

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.

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

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.

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

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().

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

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().

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

returns the user component of the URI.

returns the scheme-specific information about how to gain authorization to access the resource.

returns an associative array containing all the URI components.