Zend Framework  1.12
Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | List of all members
Zend_Validate_Alpha Class Reference

Public Member Functions

 __construct ($allowWhiteSpace=false)
 Sets default option values for this instance.
 
 getAllowWhiteSpace ()
 Returns the allowWhiteSpace option.
 
 setAllowWhiteSpace ($allowWhiteSpace)
 Sets the allowWhiteSpace option.
 
 isValid ($value)
 Defined by Zend_Validate_Interface.
 
- Public Member Functions inherited from Zend_Validate_Abstract
 getMessages ()
 Returns array of validation failure messages.
 
 getMessageVariables ()
 Returns an array of the names of variables that are used in constructing validation failure messages.
 
 getMessageTemplates ()
 Returns the message templates from the validator.
 
 setMessage ($messageString, $messageKey=null)
 Sets the validation failure message template for a particular key.
 
 setMessages (array $messages)
 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.
 
 __get ($property)
 Magic function returns the value of the requested property, if and only if it is the value or a message variable.
 
 getErrors ()
 Returns array of validation failure message codes.
 
 setObscureValue ($flag)
 Set flag indicating whether or not value should be obfuscated in messages.
 
 getObscureValue ()
 Retrieve flag indicating whether or not value should be obfuscated in messages.
 
 setTranslator ($translator=null)
 Set translation object.
 
 getTranslator ()
 Return translation object.
 
 hasTranslator ()
 Does this validator have its own specific translator?
 
 setDisableTranslator ($flag)
 Indicate whether or not translation should be disabled.
 
 translatorIsDisabled ()
 Is translation disabled?
 

Public Attributes

const INVALID = 'alphaInvalid'
 
const NOT_ALPHA = 'notAlpha'
 
const STRING_EMPTY = 'alphaStringEmpty'
 
 $allowWhiteSpace
 

Protected Attributes

 $_messageTemplates
 
- Protected Attributes inherited from Zend_Validate_Abstract
 $_value
 
 $_messageVariables = array()
 
 $_messageTemplates = array()
 
 $_messages = array()
 
 $_obscureValue = false
 
 $_errors = array()
 
 $_translator
 
 $_translatorDisabled = false
 

Static Protected Attributes

static $_filter = null
 
- Static Protected Attributes inherited from Zend_Validate_Abstract
static $_defaultTranslator
 
static $_messageLength = -1
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Validate_Abstract
static setDefaultTranslator ($translator=null)
 Set default translation object for all validate objects.
 
static getDefaultTranslator ()
 Get default translation object for all validate objects.
 
static hasDefaultTranslator ()
 Is there a default translation object set?
 
static getMessageLength ()
 Returns the maximum allowed message length.
 
static setMessageLength ($length=-1)
 Sets the maximum allowed message length.
 
- Protected Member Functions inherited from Zend_Validate_Abstract
 _createMessage ($messageKey, $value)
 Constructs and returns a validation failure message with the given message key and value.
 
 _error ($messageKey, $value=null)
 
 _setValue ($value)
 Sets the value to be validated and clears the messages and errors arrays.
 

Constructor & Destructor Documentation

__construct (   $allowWhiteSpace = false)

Sets default option values for this instance.

Parameters
boolean | Zend_Config$allowWhiteSpace
Returns
void

Member Function Documentation

getAllowWhiteSpace ( )

Returns the allowWhiteSpace option.

Returns
boolean
isValid (   $value)

Defined by Zend_Validate_Interface.

Returns true if and only if $value contains only alphabetic characters

Parameters
string$value
Returns
boolean
See Also
Zend_Filter_Alpha

Implements Zend_Validate_Interface.

setAllowWhiteSpace (   $allowWhiteSpace)

Sets the allowWhiteSpace option.

Parameters
boolean$allowWhiteSpace
Returns
Zend_Filter_Alpha Provides a fluent interface

Member Data Documentation

$_filter = null
staticprotected
$_messageTemplates
protected
Initial value:
= array(
self::INVALID => "Invalid type given. String expected",
self::NOT_ALPHA => "'%value%' contains non alphabetic characters",
self::STRING_EMPTY => "'%value%' is an empty string"
)
$allowWhiteSpace
const INVALID = 'alphaInvalid'
const NOT_ALPHA = 'notAlpha'
const STRING_EMPTY = 'alphaStringEmpty'