Zend_Validate_InArray Class Reference

Inheritance diagram for Zend_Validate_InArray:

Public Member Functions
	__construct ($options)
	getHaystack ()
	setHaystack (array $haystack)
	getStrict ()
	setStrict ($strict)
	getRecursive ()
	setRecursive ($recursive)
	isValid ($value)
Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()
	getMessageVariables ()
	getMessageTemplates ()
	setMessage ($messageString, $messageKey=null)
	setMessages (array $messages)
	__get ($property)
	getErrors ()
	setObscureValue ($flag)
	getObscureValue ()
	setTranslator ($translator=null)
	getTranslator ()
	hasTranslator ()
	setDisableTranslator ($flag)
	translatorIsDisabled ()

Data Fields
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)
static	getDefaultTranslator ()
static	hasDefaultTranslator ()
static	getMessageLength ()
static	setMessageLength ($length=-1)
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	_implodeRecursive (array $pieces)
	_error ($messageKey, $value=null)
	_setValue ($value)
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Detailed Description

Definition at line 33 of file InArray.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options

)

Sets validator options

Parameters

array | Zend_Config

$options

Validator options

Exceptions

Zend_Validate_Exception

Definition at line 71 of file InArray.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } else if (!is_array($options)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception('Array expected as parameter');
        } else {
            $count = func_num_args();
            $temp  = array();
            if ($count > 1) {
                $temp['haystack'] = func_get_arg(0);
                $temp['strict']   = func_get_arg(1);
                $options = $temp;
            } else {
                $temp = func_get_arg(0);
                if (!array_key_exists('haystack', $options)) {
                    $options = array();
                    $options['haystack'] = $temp;
                } else {
                    $options = $temp;
                }
            }
        }

        $this->setHaystack($options['haystack']);
        if (array_key_exists('strict', $options)) {
            $this->setStrict($options['strict']);
        }

        if (array_key_exists('recursive', $options)) {
            $this->setRecursive($options['recursive']);
        }
    }

Member Function Documentation

getHaystack()

getHaystack

(

)

Returns the haystack option

Returns

mixed

Definition at line 111 of file InArray.php.

    {
        return $this->_haystack;
    }

getRecursive()

getRecursive

(

)

Returns the recursive option

Returns

boolean

Definition at line 155 of file InArray.php.

    {
        return $this->_recursive;
    }

getStrict()

getStrict

(

)

Returns the strict option

Returns

boolean

Definition at line 133 of file InArray.php.

    {
        return $this->_strict;
    }

isValid()

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.

Definition at line 181 of file InArray.php.

    {
        $this->_setValue($value);
        if ($this->getRecursive()) {
            $iterator = new RecursiveIteratorIterator(new RecursiveArrayIterator($this->_haystack));
            foreach($iterator as $element) {
                if ($this->_strict) {
                    if ($element === $value) {
                        return true;
                    }
                } else if ($element == $value) {
                    return true;
                }
            }
        } else {
            if (in_array($value, $this->_haystack, $this->_strict)) {
                return true;
            }
        }

        $this->_error(self::NOT_IN_ARRAY);
        return false;
    }

setHaystack()

setHaystack

(

array

$haystack

)

Sets the haystack option

Parameters

mixed

$haystack

Returns

Zend_Validate_InArray Provides a fluent interface

Definition at line 122 of file InArray.php.

    {
        $this->_haystack = $haystack;
        return $this;
    }

setRecursive()

setRecursive

(

$recursive

)

Sets the recursive option

Parameters

boolean

$recursive

Returns

Zend_Validate_InArray Provides a fluent interface

Definition at line 166 of file InArray.php.

    {
        $this->_recursive = (boolean) $recursive;
        return $this;
    }

setStrict()

setStrict

(

$strict

)

Sets the strict option

Parameters

boolean

$strict

Returns

Zend_Validate_InArray Provides a fluent interface

Definition at line 144 of file InArray.php.

    {
        $this->_strict = (boolean) $strict;
        return $this;
    }

Field Documentation

$_haystack

$_haystack

protected

Definition at line 49 of file InArray.php.

$_messageTemplates

$_messageTemplates

protected

Initial value:

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

Definition at line 40 of file InArray.php.

$_recursive

$_recursive = false

protected

Definition at line 63 of file InArray.php.

$_strict

$_strict = false

protected

Definition at line 56 of file InArray.php.

NOT_IN_ARRAY

const NOT_IN_ARRAY = 'notInArray'

Definition at line 35 of file InArray.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Validate/InArray.php