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

Public Member Functions

 __construct ($options)
 Sets validator options Accepts the following option keys: 'min' => scalar, minimum border 'max' => scalar, maximum border 'inclusive' => boolean, inclusive border values.
 
 getMin ()
 Returns the min option.
 
 setMin ($min)
 Sets the min option.
 
 getMax ()
 Returns the max option.
 
 setMax ($max)
 Sets the max option.
 
 getInclusive ()
 Returns the inclusive option.
 
 setInclusive ($inclusive)
 Sets the inclusive 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 NOT_BETWEEN = 'notBetween'
 Validation failure message key for when the value is not between the min and max, inclusively.
 
const NOT_BETWEEN_STRICT = 'notBetweenStrict'
 Validation failure message key for when the value is not strictly between the min and max.
 

Protected Attributes

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

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.
 
- Static Protected Attributes inherited from Zend_Validate_Abstract
static $_defaultTranslator
 
static $_messageLength = -1
 

Constructor & Destructor Documentation

__construct (   $options)

Sets validator options Accepts the following option keys: 'min' => scalar, minimum border 'max' => scalar, maximum border 'inclusive' => boolean, inclusive border values.

Parameters
array | Zend_Config$options
Returns
void

Member Function Documentation

getInclusive ( )

Returns the inclusive option.

Returns
boolean
getMax ( )

Returns the max option.

Returns
mixed
getMin ( )

Returns the min option.

Returns
mixed
isValid (   $value)

Defined by Zend_Validate_Interface.

Returns true if and only if $value is between min and max options, inclusively if inclusive option is true.

Parameters
mixed$value
Returns
boolean

Implements Zend_Validate_Interface.

setInclusive (   $inclusive)

Sets the inclusive option.

Parameters
boolean$inclusive
Returns
Zend_Validate_Between Provides a fluent interface
setMax (   $max)

Sets the max option.

Parameters
mixed$max
Returns
Zend_Validate_Between Provides a fluent interface
setMin (   $min)

Sets the min option.

Parameters
mixed$min
Returns
Zend_Validate_Between Provides a fluent interface

Member Data Documentation

$_inclusive
protected
$_max
protected
$_messageTemplates
protected
Initial value:
= array(
self::NOT_BETWEEN => "'%value%' is not between '%min%' and '%max%', inclusively",
self::NOT_BETWEEN_STRICT => "'%value%' is not strictly between '%min%' and '%max%'"
)
$_messageVariables
protected
Initial value:
= array(
'min' => '_min',
'max' => '_max'
)
$_min
protected
const NOT_BETWEEN = 'notBetween'

Validation failure message key for when the value is not between the min and max, inclusively.

const NOT_BETWEEN_STRICT = 'notBetweenStrict'

Validation failure message key for when the value is not strictly between the min and max.