Zend_Validate_InArray Class Reference

Public Member Functions
	__construct ($options)
	Sets validator options.
	getHaystack ()
	Returns the haystack option.
	setHaystack (array $haystack)
	Sets the haystack option.
	getStrict ()
	Returns the strict option.
	setStrict ($strict)
	Sets the strict option.
	getRecursive ()
	Returns the recursive option.
	setRecursive ($recursive)
	Sets the recursive 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_IN_ARRAY = 'notInArray'

Protected Attributes
	$_messageTemplates
	$_haystack
	$_strict = false
	$_recursive = false
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.

Parameters

array | Zend_Config

$haystack

Returns

void

Member Function Documentation

getHaystack

(

)

Returns the haystack option.

Returns

mixed

getRecursive

(

)

Returns the recursive option.

Returns

boolean

getStrict

(

)

Returns the strict option.

Returns

boolean

isValid

(

$value

)

Defined by Zend_Validate_Interface.

Returns true if and only if $value is contained in the haystack option. If the strict option is true, then the type of $value is also checked.

Parameters

mixed

$value

Returns

boolean

Implements Zend_Validate_Interface.

setHaystack

(

array

$haystack

)

Sets the haystack option.

Parameters

mixed

$haystack

Returns

Zend_Validate_InArray Provides a fluent interface

setRecursive

(

$recursive

)

Sets the recursive option.

Parameters

boolean

$recursive

Returns

Zend_Validate_InArray Provides a fluent interface

setStrict

(

$strict

)

Sets the strict option.

Parameters

boolean

$strict

Returns

Zend_Validate_InArray Provides a fluent interface

Member Data Documentation

$_haystack

protected

$_messageTemplates

protected

Initial value:

= array(
        self::NOT_IN_ARRAY => "'%value%' was not found in the haystack",
    )

$_recursive = false

protected

$_strict = false

protected

const NOT_IN_ARRAY = 'notInArray'