| Fully Qualified Name: | Laminas\Validator\Hostname |
| Extends: | AbstractValidator |
Please note there are two standalone test scripts for testing IDN characters due to problems with file encoding.
The first is tests/Laminas/Validator/HostnameTestStandalone.php which is designed to be run on the command line.
The second is tests/Laminas/Validator/HostnameTestForm.php which is designed to be run via HTML to allow users to test entering UTF-8 characters in a form.
| Name | Description | Defined By |
|---|---|---|
| __construct() | Sets validator options. | Hostname |
| __get() | Magic function returns the value of the requested property, if and only if it is the value or a message variable. | AbstractValidator |
| __invoke() | Invoke as command | AbstractValidator |
| getAllow() | Returns the allow option | Hostname |
| getDefaultTranslator() | Get default translation object for all validate objects | AbstractValidator |
| getDefaultTranslatorTextDomain() | Get default translation text domain for all validate objects | AbstractValidator |
| getIdnCheck() | Returns the set idn option | Hostname |
| getIpValidator() | Returns the set ip validator | Hostname |
| getMessageLength() | Returns the maximum allowed message length | AbstractValidator |
| getMessageTemplates() | Returns the message templates from the validator | AbstractValidator |
| getMessageVariables() | Returns an array of the names of variables that are used in constructing validation failure messages | AbstractValidator |
| getMessages() | Returns array of validation failure messages | AbstractValidator |
| getOption() | Returns an option | AbstractValidator |
| getOptions() | Returns all available options | AbstractValidator |
| getTldCheck() | Returns the set tld option | Hostname |
| getTranslator() | Return translation object | AbstractValidator |
| getTranslatorTextDomain() | Return the translation text domain | AbstractValidator |
| hasDefaultTranslator() | Is there a default translation object set? | AbstractValidator |
| hasTranslator() | Does this validator have its own specific translator? | AbstractValidator |
| isTranslatorEnabled() | Is translation enabled? | AbstractValidator |
| isValid() | Defined by Interface | Hostname |
| isValueObscured() | Retrieve flag indicating whether or not value should be obfuscated in messages | AbstractValidator |
| setAllow() | Sets the allow option | Hostname |
| setDefaultTranslator() | Set default translation object for all validate objects | AbstractValidator |
| setDefaultTranslatorTextDomain() | Set default translation text domain for all validate objects | AbstractValidator |
| setIpValidator() | Hostname | |
| setMessage() | Sets the validation failure message template for a particular key | AbstractValidator |
| setMessageLength() | Sets the maximum allowed message length | AbstractValidator |
| setMessages() | Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings. | AbstractValidator |
| setOptions() | Sets one or multiple options | AbstractValidator |
| setTranslator() | Set translation object | AbstractValidator |
| setTranslatorEnabled() | Indicate whether or not translation should be enabled | AbstractValidator |
| setTranslatorTextDomain() | Set translation text domain | AbstractValidator |
| setValueObscured() | Set flag indicating whether or not value should be obfuscated in messages | AbstractValidator |
| useIdnCheck() | Set whether IDN domains are validated | Hostname |
| useTldCheck() | Set whether the TLD element of a hostname is validated | Hostname |
Sets validator options.
| Parameter Name | Type | Description |
|---|---|---|
| $allow | int | OPTIONAL |
| $useIdnCheck | bool | OPTIONAL |
| $useTldCheck | bool | Set |
| $ipValidator | \Ip | OPTIONAL |
| $options |
Returns:
Magic function returns the value of the requested property, if and only if it is the value or a message variable.
| Parameter Name | Type | Description |
|---|---|---|
| $property | string |
Returns: mixed
Invoke as command
| Parameter Name | Type | Description |
|---|---|---|
| $value | mixed |
Returns: bool
Returns the allow option
Returns: int
Get default translation object for all validate objects
Returns: \Translator\TranslatorInterface|null
Get default translation text domain for all validate objects
Returns: string
Returns the set idn option
Returns: bool
Returns the set ip validator
Returns: \Ip
Returns the maximum allowed message length
Returns: int
Returns the message templates from the validator
Returns: array
Returns an array of the names of variables that are used in constructing validation failure messages
Returns: array
Returns array of validation failure messages
Returns: array
Returns an option
| Parameter Name | Type | Description |
|---|---|---|
| $option | string | Option |
Returns: mixed Returned option
Returns all available options
Returns: array Array with all available options
Returns the set tld option
Returns: bool
Return translation object
Returns: \Translator\TranslatorInterface|null
Return the translation text domain
Returns: string
Is there a default translation object set?
Returns: bool
Does this validator have its own specific translator?
Returns: bool
Is translation enabled?
Returns: bool
Defined by Interface
Returns true if and only if the $value is a valid hostname with respect to the current allow option
| Parameter Name | Type | Description |
|---|---|---|
| $value | string |
Returns: bool
Retrieve flag indicating whether or not value should be obfuscated in messages
Returns: bool
Sets the allow option
| Parameter Name | Type | Description |
|---|---|---|
| $allow | int |
Returns: $this Provides a fluent interface
Set default translation object for all validate objects
| Parameter Name | Type | Description |
|---|---|---|
| $translator | \Translator\TranslatorInterface|null | |
| $textDomain | string | (optional) |
Returns: void
Set default translation text domain for all validate objects
| Parameter Name | Type | Description |
|---|---|---|
| $textDomain | string |
Returns: void
| Parameter Name | Type | Description |
|---|---|---|
| $ipValidator |
Returns: void
Sets the validation failure message template for a particular key
| Parameter Name | Type | Description |
|---|---|---|
| $messageString | string | |
| $messageKey | string | OPTIONAL |
Returns: $this Provides a fluent interface
Sets the maximum allowed message length
| Parameter Name | Type | Description |
|---|---|---|
| $length | int |
Returns:
Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.
| Parameter Name | Type | Description |
|---|---|---|
| $messages | array |
Returns: $this
Sets one or multiple options
| Parameter Name | Type | Description |
|---|---|---|
| $options | array|\Traversable | Options |
Returns: $this Provides fluid interface
Set translation object
| Parameter Name | Type | Description |
|---|---|---|
| $translator | \Translator\TranslatorInterface|null | |
| $textDomain | string | (optional) |
Returns: $this
Indicate whether or not translation should be enabled
| Parameter Name | Type | Description |
|---|---|---|
| $flag | bool |
Returns: $this
Set translation text domain
| Parameter Name | Type | Description |
|---|---|---|
| $textDomain | string |
Returns: $this
Set flag indicating whether or not value should be obfuscated in messages
| Parameter Name | Type | Description |
|---|---|---|
| $flag | bool |
Returns: $this
Set whether IDN domains are validated
This only applies when DNS hostnames are validated
| Parameter Name | Type | Description |
|---|---|---|
| $useIdnCheck | bool | Set |
Returns: $this
Set whether the TLD element of a hostname is validated
This only applies when DNS hostnames are validated
| Parameter Name | Type | Description |
|---|---|---|
| $useTldCheck | bool | Set |
Returns: $this