API Documentation

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

\Zend_Validate_Between

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_BETWEEN = 'notBetween'

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

Constant  NOT_BETWEEN_STRICT = 'notBetweenStrict'

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

Properties

Propertyprotectedboolean  $_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
Propertyprotectedmixed  $_max= ''

Maximum value

Details
Type
mixed
Propertyprotectedarray  $_messageTemplates= 'array( self::NOT_BETWEEN => "'%value%' is not between '%min%' and '%max%', inclusively"'

Validation failure message template definitions

Default valuearray( self::NOT_BETWEEN => "'%value%' is not between '%min%' and '%max%', inclusively"Details
Type
array
Propertyprotectedarray  $_messageVariables= 'array( 'min' => '_min''

Additional variables available for validation failure messages

Default valuearray( 'min' => '_min'Details
Type
array
Propertyprotectedmixed  $_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
Name Type Description
$options array|\Zend_Config
methodpublicgetInclusive( ) : boolean

Returns the inclusive option

Returns
Type Description
boolean
methodpublicgetMax( ) : mixed

Returns the max option

Returns
Type Description
mixed
methodpublicgetMin( ) : mixed

Returns the min option

Returns
Type Description
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
Name Type Description
$value mixed
Returns
Type Description
boolean
methodpublicsetInclusive( boolean $inclusive ) : \Zend_Validate_Between

Sets the inclusive option

Parameters
Name Type Description
$inclusive boolean
Returns
Type Description
\Zend_Validate_Between Provides a fluent interface
methodpublicsetMax( mixed $max ) : \Zend_Validate_Between

Sets the max option

Parameters
Name Type Description
$max mixed
Returns
Type Description
\Zend_Validate_Between Provides a fluent interface
methodpublicsetMin( mixed $min ) : \Zend_Validate_Between

Sets the min option

Parameters
Name Type Description
$min mixed
Returns
Type Description
\Zend_Validate_Between Provides a fluent interface
Documentation was generated by DocBlox 0.15.1.