UriInterface
extends
JsonSerializable, Stringable
in
Tags
Table of Contents
Methods
- __toString() : string
- Returns the string representation as a URI reference.
- getAuthority() : string|null
- Retrieve the authority component of the URI.
- getComponents() : ComponentMap
- Returns an associative array containing all the URI components.
- getFragment() : string|null
- Retrieve the fragment component of the URI.
- getHost() : string|null
- Retrieve the host component of the URI.
- getPath() : string
- Retrieve the path component of the URI.
- getPort() : int|null
- Retrieve the port component of the URI.
- getQuery() : string|null
- Retrieve the query string of the URI.
- getScheme() : string|null
- Retrieve the scheme component of the URI.
- getUserInfo() : string|null
- Retrieve the user information component of the URI.
- jsonSerialize() : string
- Returns the string representation as a URI reference.
- toString() : string
- Returns the string representation as a URI reference.
- withFragment() : self
- Return an instance with the specified URI fragment.
- withHost() : self
- Return an instance with the specified host.
- withPath() : self
- Return an instance with the specified path.
- withPort() : self
- Return an instance with the specified port.
- withQuery() : self
- Return an instance with the specified query string.
- withScheme() : self
- Return an instance with the specified scheme.
- withUserInfo() : self
- Return an instance with the specified user information.
Methods
__toString()
Returns the string representation as a URI reference.
public
__toString() : string
Tags
Return values
stringgetAuthority()
Retrieve the authority component of the URI.
public
getAuthority() : string|null
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.
Tags
Return values
string|nullgetComponents()
Returns an associative array containing all the URI components.
public
getComponents() : ComponentMap
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.
Tags
Return values
ComponentMapgetFragment()
Retrieve the fragment component of the URI.
public
getFragment() : string|null
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.
Tags
Return values
string|nullgetHost()
Retrieve the host component of the URI.
public
getHost() : string|null
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.
Tags
Return values
string|nullgetPath()
Retrieve the path component of the URI.
public
getPath() : string
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.
Tags
Return values
stringgetPort()
Retrieve the port component of the URI.
public
getPort() : int|null
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.
Return values
int|nullgetQuery()
Retrieve the query string of the URI.
public
getQuery() : string|null
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.
Tags
Return values
string|nullgetScheme()
Retrieve the scheme component of the URI.
public
getScheme() : string|null
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.
Tags
Return values
string|nullgetUserInfo()
Retrieve the user information component of the URI.
public
getUserInfo() : string|null
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.
Return values
string|nulljsonSerialize()
Returns the string representation as a URI reference.
public
jsonSerialize() : string
Tags
Return values
stringtoString()
Returns the string representation as a URI reference.
public
toString() : string
Tags
Return values
stringwithFragment()
Return an instance with the specified URI fragment.
public
withFragment(Stringable|string|null $fragment) : self
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.
Parameters
- $fragment : Stringable|string|null
Tags
Return values
selfwithHost()
Return an instance with the specified host.
public
withHost(Stringable|string|null $host) : self
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.
Parameters
- $host : Stringable|string|null
Tags
Return values
selfwithPath()
Return an instance with the specified path.
public
withPath(Stringable|string $path) : self
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().
Parameters
- $path : Stringable|string
Tags
Return values
selfwithPort()
Return an instance with the specified port.
public
withPort(int|null $port) : self
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.
Parameters
- $port : int|null
Tags
Return values
selfwithQuery()
Return an instance with the specified query string.
public
withQuery(Stringable|string|null $query) : self
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.
Parameters
- $query : Stringable|string|null
Tags
Return values
selfwithScheme()
Return an instance with the specified scheme.
public
withScheme(Stringable|string|null $scheme) : self
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.
Parameters
- $scheme : Stringable|string|null
Tags
Return values
selfwithUserInfo()
Return an instance with the specified user information.
public
withUserInfo(Stringable|string|null $user[, Stringable|string|null $password = null ]) : self
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.
Parameters
- $user : Stringable|string|null
- $password : Stringable|string|null = null