API Documentation

Zend/Validate/InArray.php

Show: inherited
Table of Contents

Zend Framework

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: InArray.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Validate_InArray

Package: Zend\Validate

Parent(s)
\Zend_Validate_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  NOT_IN_ARRAY = 'notInArray'

Properties

Propertyprotectedarray  $_haystack= ''

Haystack of possible values

Details
Type
array
Propertyprotectedarray  $_messageTemplates= 'array( self::NOT_IN_ARRAY => "'%value%' was not found in the haystack"'

Default valuearray( self::NOT_IN_ARRAY => "'%value%' was not found in the haystack"Details
Type
array
Propertyprotectedboolean  $_recursive= 'false'

Whether a recursive search should be done

Default valuefalseDetails
Type
boolean
Propertyprotectedboolean  $_strict= 'false'

Whether a strict in_array() invocation is used

Default valuefalseDetails
Type
boolean

Methods

methodpublic__construct(  $options ) : void

Sets validator options

Parameters
Name Type Description
$options
methodpublicgetHaystack( ) : mixed

Returns the haystack option

Returns
Type Description
mixed
methodpublicgetRecursive( ) : boolean

Returns the recursive option

Returns
Type Description
boolean
methodpublicgetStrict( ) : boolean

Returns the strict option

Returns
Type Description
boolean
methodpublicisValid( mixed $value ) : boolean

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
Name Type Description
$value mixed
Returns
Type Description
boolean
methodpublicsetHaystack( mixed $haystack ) : \Zend_Validate_InArray

Sets the haystack option

Parameters
Name Type Description
$haystack mixed
Returns
Type Description
\Zend_Validate_InArray Provides a fluent interface
methodpublicsetRecursive( boolean $recursive ) : \Zend_Validate_InArray

Sets the recursive option

Parameters
Name Type Description
$recursive boolean
Returns
Type Description
\Zend_Validate_InArray Provides a fluent interface
methodpublicsetStrict( boolean $strict ) : \Zend_Validate_InArray

Sets the strict option

Parameters
Name Type Description
$strict boolean
Returns
Type Description
\Zend_Validate_InArray Provides a fluent interface
Documentation was generated by DocBlox 0.15.1.