HostInterface
extends
UriComponentInterface
in
Table of Contents
- __toString() : string
- Returns the instance string representation.
- getContent() : string|null
- Returns the instance content.
- getIp() : string|null
- Returns the IP component If the Host is an IP address.
- getIpVersion() : string|null
- Returns the IP version.
- getUriComponent() : string
- Returns the instance string representation with its optional URI delimiters.
- isDomain() : bool
- Tells whether the host is a domain name.
- isIp() : bool
- Tells whether the host is an IP Address.
- jsonSerialize() : string|null
- Returns the instance json representation.
- toAscii() : string|null
- Returns the ascii representation.
- toUnicode() : string|null
- Returns the unicode representation.
- withContent() : self
- Returns an instance with the specified content.
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 —getIp()
Returns the IP component If the Host is an IP address.
public
getIp() : string|null
If the host is a not an IP this method will return null
Return values
string|null —getIpVersion()
Returns the IP version.
public
getIpVersion() : string|null
If the host is a not an IP this method will return null
Return values
string|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 —isDomain()
Tells whether the host is a domain name.
public
isDomain() : bool
Return values
bool —isIp()
Tells whether the host is an IP Address.
public
isIp() : bool
Return values
bool —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 —toAscii()
Returns the ascii representation.
public
toAscii() : string|null
Return values
string|null —toUnicode()
Returns the unicode representation.
public
toUnicode() : string|null
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