Documentation

DomainHostInterface extends Countable, HostInterface, IteratorAggregate
in

Tags
extends

\IteratorAggregate

Table of Contents

__toString()  : string
Returns the instance string representation.
append()  : self
Appends a label to the host.
count()  : int
Returns the labels total number.
get()  : string|null
Retrieves a single host label.
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.
getIterator()  : Iterator<string|int, string>
Iterate over the Domain labels.
getUriComponent()  : string
Returns the instance string representation with its optional URI delimiters.
isAbsolute()  : bool
Tells whether the domain is absolute.
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.
keys()  : array<string|int, int>
Returns the associated key for a specific label or all the keys.
prepend()  : self
Prepends a label to the host.
toAscii()  : string|null
Returns the ascii representation.
toUnicode()  : string|null
Returns the unicode representation.
withContent()  : self
Returns an instance with the specified content.
withLabel()  : self
Returns an instance with the modified label.
withoutLabel()  : self
Returns an instance without the specified label.
withoutRootLabel()  : self
Returns an instance without its Root label.
withRootLabel()  : self
Returns an instance with its Root label.

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 —

append()

Appends a label to the host.

public append(string $label) : self
Parameters
$label : string
Return values
self —

get()

Retrieves a single host label.

public get(int $offset) : string|null

If the label offset has not been set, returns the null value.

Parameters
$offset : int
Return values
string|null —

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 —

getIterator()

Iterate over the Domain labels.

public getIterator() : Iterator<string|int, string>
Return values
Iterator<string|int, string> —

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 —

isAbsolute()

Tells whether the domain is absolute.

public isAbsolute() : bool
Return values
bool —

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 —

keys()

Returns the associated key for a specific label or all the keys.

public keys([string|null $label = null ]) : array<string|int, int>
Parameters
$label : string|null = null
Return values
array<string|int, int> —

prepend()

Prepends a label to the host.

public prepend(string $label) : self
Parameters
$label : string
Return values
self —

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
Tags
throws
SyntaxError

for invalid component or transformations that would result in a object in invalid state.

throws
IdnSupportMissing

for component or transformations requiring IDN support when IDN support is not present or misconfigured.

Return values
self —

withLabel()

Returns an instance with the modified label.

public withLabel(int $key, string $label) : self

This method MUST retain the state of the current instance, and return an instance that contains the new label

If $key is non-negative, the added label will be the label at $key position from the start. If $key is negative, the added label will be the label at $key position from the end.

Parameters
$key : int
$label : string
Tags
throws
SyntaxError

If the key is invalid

Return values
self —

withoutLabel()

Returns an instance without the specified label.

public withoutLabel(int ...$keys) : self

This method MUST retain the state of the current instance, and return an instance that contains the modified component

If $key is non-negative, the removed label will be the label at $key position from the start. If $key is negative, the removed label will be the label at $key position from the end.

Parameters
$keys : int
Tags
throws
SyntaxError

If the key is invalid

Return values
self —

Search results