AuthorityInterface
extends
UriComponentInterface
in
Table of Contents
- __toString() : string
- Returns the instance string representation.
- getContent() : string|null
- Returns the instance content.
- getHost() : string|null
- Returns the host component of the authority.
- getPort() : int|null
- Returns the port component of the authority.
- getUriComponent() : string
- Returns the instance string representation with its optional URI delimiters.
- getUserInfo() : string|null
- Returns the user information component of the authority.
- jsonSerialize() : string|null
- Returns the instance json representation.
- withContent() : self
- Returns an instance with the specified content.
- withHost() : self
- Return an instance with the specified host.
- withPort() : self
- Return an instance with the specified port.
- withUserInfo() : self
- Return an instance with the specified user information.
Methods
__toString()
Returns the instance string representation.
public
__toString() : string
If the instance is defined, 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.
If the instance is not defined an empty string is returned
Return values
string —getContent()
Returns the instance content.
public
getContent() : string|null
If the instance is defined, the value returned MUST be encoded according to the selected encoding algorithm. In any case, the value MUST NOT double-encode any character depending on the selected encoding algorithm.
To determine what characters to encode, please refer to RFC 3986, Sections 2 and 3. or RFC 3987 Section 3. By default the content is encoded according to RFC3986
If the instance is not defined null is returned
Return values
string|null —getHost()
Returns the host component of the authority.
public
getHost() : string|null
Return values
string|null —getPort()
Returns the port component of the authority.
public
getPort() : int|null
Return values
int|null —getUriComponent()
Returns the instance string representation with its optional URI delimiters.
public
getUriComponent() : string
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.
If the instance is not defined an empty string is returned
Return values
string —getUserInfo()
Returns the user information component of the authority.
public
getUserInfo() : string|null
Return values
string|null —jsonSerialize()
Returns the instance json representation.
public
jsonSerialize() : string|null
If the instance is defined, 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 or RFC 1738.
If the instance is not defined null is returned
Return values
string|null —withContent()
Returns an instance with the specified content.
public
withContent(string|null $content) : self
This method MUST retain the state of the current instance, and return an instance that contains the specified content.
Users can provide both encoded and decoded content characters.
A null value is equivalent to removing the component content.
Parameters
- $content : string|null
Tags
Return values
self —withHost()
Return an instance with the specified host.
public
withHost(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 : string|null
Tags
Return values
self —withPort()
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
self —withUserInfo()
Return an instance with the specified user information.
public
withUserInfo(string|null $user[, 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 : string|null
- $password : string|null = null