API Documentation

Validate/Between.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Validate
version
$Id: Between.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Validate_Between

Description

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.

Zend_Validate_Between

Extends from
Zend_Validate_Abstract
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Validate
Constants
NOT_BETWEEN
NOT_BETWEEN_STRICT
Properties
$_messageTemplates
$_messageVariables
$_min
$_max
$_inclusive
Methods
__construct
getMin
setMin
getMax
setMax
getInclusive
setInclusive
isValid

Description

Constants

NOT_BETWEEN

 NOT_BETWEEN = 'notBetween'

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

Details

value
notBetween

NOT_BETWEEN_STRICT

 NOT_BETWEEN_STRICT = 'notBetweenStrict'

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

Details

value
notBetweenStrict

Properties

$_inclusive

boolean $_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

$_inclusive
boolean
visibility
protected
default
final
false
static
false

$_max

mixed $_max = ''

Maximum value

Details

$_max
mixed
visibility
protected
default
final
false
static
false

$_messageTemplates

array $_messageTemplates = 'array'

Validation failure message template definitions

Details

$_messageTemplates
array
visibility
protected
default
array
final
false
static
false

$_messageVariables

array $_messageVariables = 'array'

Additional variables available for validation failure messages

Details

$_messageVariables
array
visibility
protected
default
array
final
false
static
false

$_min

mixed $_min = ''

Minimum value

Details

$_min
mixed
visibility
protected
default
final
false
static
false

Methods

__construct

__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

Arguments
$options
arrayZend_Config
Details
visibility
public
final
false
static
false

getInclusive

getInclusive( ) : boolean

Returns the inclusive option

Output
boolean
Details
visibility
public
final
false
static
false

getMax

getMax( ) : mixed

Returns the max option

Output
mixed
Details
visibility
public
final
false
static
false

getMin

getMin( ) : mixed

Returns the min option

Output
mixed
Details
visibility
public
final
false
static
false

isValid

isValid( 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.

Arguments
$value
mixed
Output
boolean
Details
visibility
public
final
false
static
false

setInclusive

setInclusive( boolean $inclusive ) : Zend_Validate_Between

Sets the inclusive option

Arguments
$inclusive
boolean
Output
Zend_Validate_Between
Provides a fluent interface
Details
visibility
public
final
false
static
false

setMax

setMax( mixed $max ) : Zend_Validate_Between

Sets the max option

Arguments
$max
mixed
Output
Zend_Validate_Between
Provides a fluent interface
Details
visibility
public
final
false
static
false

setMin

setMin( mixed $min ) : Zend_Validate_Between

Sets the min option

Arguments
$min
mixed
Output
Zend_Validate_Between
Provides a fluent interface
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.