Validate/Between.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Validate  
Version
$Id$  

\Zend_Validate_Between

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

Constants

>VConstant  NOT_BETWEEN = 'notBetween'
Validation failure message key for when the value is not between the min and max, inclusively
>VConstant  NOT_BETWEEN_STRICT = 'notBetweenStrict'
Validation failure message key for when the value is not strictly between the min and max

Properties

>VPropertyprotectedboolean $_inclusive
Whether to do inclusive comparisons, allowing equivalence to min and/or max
If false, then strict comparisons are done, and the value may equal neither the min nor max options
Details
Type
boolean
>VPropertyprotectedmixed $_max
Maximum value
Details
Type
mixed
>VPropertyprotectedarray $_messageTemplates = array(self::NOT_BETWEEN => "'%value%' is not between '%min%' and '%max%', inclusively", self::NOT_BETWEEN_STRICT => "'%value%' is not strictly between '%min%' and '%max%'")
Validation failure message template definitions
Default valuearray(self::NOT_BETWEEN => "'%value%' is not between '%min%' and '%max%', inclusively", self::NOT_BETWEEN_STRICT => "'%value%' is not strictly between '%min%' and '%max%'")Details
Type
array
>VPropertyprotectedarray $_messageVariables = array('min' => '_min', 'max' => '_max')
Additional variables available for validation failure messages
Default valuearray('min' => '_min', 'max' => '_max')Details
Type
array
>VPropertyprotectedmixed $_min
Minimum value
Details
Type
mixed

Methods

methodpublic__construct(array | \Zend_Config $options) : void

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

Parameters
NameTypeDescription
$optionsarray | \Zend_Config
methodpublicgetInclusive() : boolean

Returns the inclusive option

Returns
TypeDescription
boolean
methodpublicgetMax() : mixed

Returns the max option

Returns
TypeDescription
mixed
methodpublicgetMin() : mixed

Returns the min option

Returns
TypeDescription
mixed
methodpublicisValid(mixed $value) : boolean

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
NameTypeDescription
$valuemixed
Returns
TypeDescription
boolean
methodpublicsetInclusive(boolean $inclusive) : \Zend_Validate_Between

Sets the inclusive option

Parameters
NameTypeDescription
$inclusiveboolean
Returns
TypeDescription
\Zend_Validate_BetweenProvides a fluent interface
methodpublicsetMax(mixed $max) : \Zend_Validate_Between

Sets the max option

Parameters
NameTypeDescription
$maxmixed
Returns
TypeDescription
\Zend_Validate_BetweenProvides a fluent interface
methodpublicsetMin(mixed $min) : \Zend_Validate_Between

Sets the min option

Parameters
NameTypeDescription
$minmixed
Returns
TypeDescription
\Zend_Validate_BetweenProvides a fluent interface
Documentation was generated by phpDocumentor 2.2.0 .