Documentation

HostInterface extends UriComponentInterface
in

Table of Contents

Methods

__toString()  : string
Returns the instance string representation.
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.
isRegisteredName()  : bool
Tells whether the host is a registered name.
jsonSerialize()  : string|null
Returns the instance json representation.
toAscii()  : string|null
Returns the ascii representation.
toString()  : string
Returns the instance string representation.
toUnicode()  : string|null
Returns the unicode representation.
value()  : string|null
Returns the instance string representation.

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

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

isRegisteredName()

Tells whether the host is a registered name.

public isRegisteredName() : 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

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

toUnicode()

Returns the unicode representation.

public toUnicode() : string|null
Return values
string|null

value()

Returns the instance string representation.

public value() : 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, Sections 2 and 3.

If the instance is not defined null is returned

Return values
string|null 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results