Validate/Abstract.php
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Validate
- Version
- $Id: Abstract.php 25105 2012-11-07 20:33:22Z rob $
\Zend_Validate_Abstract
- Implements
- \Zend_Validate_Interface
- Children
- \Zend_Validate_Isbn
- \Zend_Validate_NotEmpty
- \Zend_Validate_Ip
- \Zend_Validate_InArray
- \Zend_Validate_Callback
- \Zend_Validate_Between
- \Zend_Validate_Sitemap_Priority
- \Zend_Validate_Sitemap_Changefreq
- \Zend_Validate_Sitemap_Loc
- \Zend_Validate_Sitemap_Lastmod
- \Zend_Validate_Alpha
- \Zend_Validate_Hostname
- \Zend_Validate_Date
- \Zend_Validate_Alnum
- \Zend_Validate_StringLength
- \Zend_Validate_Hex
- \Zend_Validate_Identical
- \Zend_Validate_Barcode
- \Zend_Validate_Regex
- \Zend_Validate_Iban
- \Zend_Validate_LessThan
- \Zend_Validate_File_Extension
- \Zend_Validate_File_Count
- \Zend_Validate_File_Upload
- \Zend_Validate_File_MimeType
- \Zend_Validate_File_Exists
- \Zend_Validate_File_ImageSize
- \Zend_Validate_File_Hash
- \Zend_Validate_File_Size
- \Zend_Validate_CreditCard
- \Zend_Validate_GreaterThan
- \Zend_Validate_PostCode
- \Zend_Validate_Db_Abstract
- \Zend_Validate_Ccnum
- \Zend_Validate_Int
- \Zend_Validate_Ldap_Dn
- \Zend_Validate_EmailAddress
- \Zend_Validate_Digits
- \Zend_Validate_Float
- \Zend_Captcha_Base
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties


\Zend_Translate $_defaultTranslator
- Type
- \Zend_Translate


array $_errors = array()
array()
Details- Type
- array
- Deprecated
- Since 1.5.0


Integer $_messageLength = -1
-1
Details- Type
- Integer


array $_messageTemplates = array()
array()
Details- Type
- array


array $_messageVariables = array()
array()
Details- Type
- array


bool $_obscureValue = false
false
Details- Type
- bool
Methods


__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.
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.
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
Name | Type | Description |
---|---|---|
$value | mixed |


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


getErrors() : array
Returns array of validation failure message codes
Type | Description |
---|---|
array |
- Deprecated
- Since 1.5.0


getMessageLength() : integer
Returns the maximum allowed message length
Type | Description |
---|---|
integer |


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


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


getMessages() : array
Returns array of validation failure messages
The array keys are validation failure message identifiers, and the array values are the corresponding human-readable message strings.
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
Type | Description |
---|---|
bool |


getTranslator() : \Zend_Translate_Adapter | null
Return translation object
Type | Description |
---|---|
\Zend_Translate_Adapter | null |


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


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


isValid(mixed $value) : boolean
Returns true if and only if $value meets the validation requirements
Inherited from: \Zend_Validate_Interface::isValid()If $value fails validation, then this method returns false, and getMessages() will return an array of messages that explain why the validation failed.
Name | Type | Description |
---|---|---|
$value | mixed |
Type | Description |
---|---|
boolean |
Exception | Description |
---|---|
\Zend_Validate_Exception | If validation of $value is impossible |


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


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


setMessage(string $messageString, string $messageKey = null) : \Zend_Validate_Abstract
Sets the validation failure message template for a particular key
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 = -1) : void
Sets the maximum allowed message length
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.
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
Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Validate_Abstract |


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