Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Please note there are two standalone test scripts for testing IDN characters due to problems with file encoding.
The first is tests/Zend/Validate/HostnameTestStandalone.php which is designed to be run on the command line.
The second is tests/Zend/Validate/HostnameTestForm.php which is designed to be run via HTML to allow users to test entering UTF-8 characters in a form.

array $_messageTemplates=
'array'
Validation failure message template definitions
array
Details

array $_messageVariables=
'array'
Additional variables available for validation failure messages
array
Details

array $_validIdns=
'array'
Array for valid Idns
array
Details

__construct( $options = array ) : void
Sets validator options
Name | Type | Description |
---|---|---|
$options |

__get( string $property ) : mixed
Magic function returns the value of the requested property, if and only if it is the value or a message variable.
Inherited from: \Zend_Validate_Abstract::__get()Name | Type | Description |
---|---|---|
$property | string |
Type | Description |
---|---|
mixed |
Exception | Description |
---|---|
\Zend_Validate_Exception |

_createMessage( string $messageKey, string $value ) :
string
Constructs and returns a validation failure message with the given message key and value.
Inherited from: \Zend_Validate_Abstract::_createMessage()Returns null if and only if $messageKey does not correspond to an existing template.
If a translator is available and a translation exists for $messageKey, the translation will be used.
Name | Type | Description |
---|---|---|
$messageKey | string | |
$value | string |
Type | Description |
---|---|
string |

_error( string $messageKey, string $value = null
) : void
Name | Type | Description |
---|---|---|
$messageKey | string | |
$value | string | OPTIONAL |

_setValue( mixed $value ) : void
Sets the value to be validated and clears the messages and errors arrays
Inherited from: \Zend_Validate_Abstract::_setValue()Name | Type | Description |
---|---|---|
$value | mixed |

decodePunycode( string $encoded ) : string
Decodes a punycode encoded string to it's original utf8 string In case of a decoding failure the original string is returned
Name | Type | Description |
---|---|---|
$encoded | string | Punycode encoded string to decode |
Type | Description |
---|---|
string |

getDefaultTranslator( ) : \Zend_Translate_Adapter|null
Get default translation object for all validate objects
Inherited from: \Zend_Validate_Abstract::getDefaultTranslator()Type | Description |
---|---|
\Zend_Translate_Adapternull |

getErrors( ) : array
Returns array of validation failure message codes
Inherited from: \Zend_Validate_Abstract::getErrors()Type | Description |
---|---|
array |

getIpValidator( ) : \Zend_Validate_Ip
Returns the set ip validator
Type | Description |
---|---|
\Zend_Validate_Ip |

getMessageLength( ) : integer
Returns the maximum allowed message length
Inherited from: \Zend_Validate_Abstract::getMessageLength()Type | Description |
---|---|
integer |

getMessageTemplates( ) : array
Returns the message templates from the validator
Inherited from: \Zend_Validate_Abstract::getMessageTemplates()Type | Description |
---|---|
array |

getMessageVariables( ) : array
Returns an array of the names of variables that are used in constructing validation failure messages
Inherited from: \Zend_Validate_Abstract::getMessageVariables()Type | Description |
---|---|
array |

getMessages( ) : array
Returns array of validation failure messages
Inherited from: \Zend_Validate_Abstract::getMessages()If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.
Type | Description |
---|---|
array |

getObscureValue( ) : bool
Retrieve flag indicating whether or not value should be obfuscated in messages
Inherited from: \Zend_Validate_Abstract::getObscureValue()Type | Description |
---|---|
bool |

getTranslator( ) : \Zend_Translate_Adapter|null
Return translation object
Inherited from: \Zend_Validate_Abstract::getTranslator()Type | Description |
---|---|
\Zend_Translate_Adapternull |

hasDefaultTranslator( ) : boolean
Is there a default translation object set?
Inherited from: \Zend_Validate_Abstract::hasDefaultTranslator()Type | Description |
---|---|
boolean |

hasTranslator( ) : bool
Does this validator have its own specific translator?
Inherited from: \Zend_Validate_Abstract::hasTranslator()Type | Description |
---|---|
bool |

isValid( string $value ) : boolean
Defined by Zend_Validate_Interface
Returns true if and only if the $value is a valid hostname with respect to the current allow option
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
boolean |
Exception | Description |
---|---|
\Zend_Validate_Exception | if a fatal error occurs for validation process |

setAllow( integer $allow ) : \Zend_Validate_Hostname
Sets the allow option
Name | Type | Description |
---|---|---|
$allow | integer |
Type | Description |
---|---|
\Zend_Validate_Hostname | Provides a fluent interface |

setDefaultTranslator(
\Zend_Translate|\Zend_Translate_Adapter|null $translator = null ) :
void
Set default translation object for all validate objects
Inherited from: \Zend_Validate_Abstract::setDefaultTranslator()Name | Type | Description |
---|---|---|
$translator | \Zend_Translate|\Zend_Translate_Adapter|null |

setDisableTranslator( bool $flag ) : \Zend_Validate_Abstract
Indicate whether or not translation should be disabled
Inherited from: \Zend_Validate_Abstract::setDisableTranslator()Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Validate_Abstract |

setIpValidator( \Zend_Validate_Ip $ipValidator
= null ) : \void;
Name | Type | Description |
---|---|---|
$ipValidator | \Zend_Validate_Ip | OPTIONAL |
Type | Description |
---|---|
\void; |

setMessage( string $messageString,
string $messageKey = null ) : \Zend_Validate_Abstract
Sets the validation failure message template for a particular key
Inherited from: \Zend_Validate_Abstract::setMessage()Name | Type | Description |
---|---|---|
$messageString | string | |
$messageKey | string | OPTIONAL |
Type | Description |
---|---|
\Zend_Validate_Abstract | Provides a fluent interface |
Exception | Description |
---|---|
\Zend_Validate_Exception |

setMessageLength( integer $length ) : void
Sets the maximum allowed message length
Inherited from: \Zend_Validate_Abstract::setMessageLength()Name | Type | Description |
---|---|---|
$length | integer |

setMessages( array $messages ) : \Zend_Validate_Abstract
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.
Inherited from: \Zend_Validate_Abstract::setMessages()Name | Type | Description |
---|---|---|
$messages | array |
Type | Description |
---|---|
\Zend_Validate_Abstract |

setObscureValue( bool $flag ) : \Zend_Validate_Abstract
Set flag indicating whether or not value should be obfuscated in messages
Inherited from: \Zend_Validate_Abstract::setObscureValue()Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Validate_Abstract |

setOptions( array $options ) : \Zend_Validate_Hostname
Sets the options for this validator
Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_Validate_Hostname |

setTranslator(
\Zend_Translate|\Zend_Translate_Adapter|null $translator = null ) : \Zend_Validate_Abstract
Set translation object
Inherited from: \Zend_Validate_Abstract::setTranslator()Name | Type | Description |
---|---|---|
$translator | \Zend_Translate|\Zend_Translate_Adapter|null |
Type | Description |
---|---|
\Zend_Validate_Abstract |

setValidateIdn( boolean $allowed ) : void
Set whether IDN domains are validated
This only applies when DNS hostnames are validated
Name | Type | Description |
---|---|---|
$allowed | boolean | Set allowed to true to validate IDNs, and false to not validate them |

setValidateTld( boolean $allowed ) : void
Set whether the TLD element of a hostname is validated
This only applies when DNS hostnames are validated
Name | Type | Description |
---|---|---|
$allowed | boolean | Set allowed to true to validate TLDs, and false to not validate them |

translatorIsDisabled( ) : bool
Is translation disabled?
Inherited from: \Zend_Validate_Abstract::translatorIsDisabled()Type | Description |
---|---|
bool |