API Documentation

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

\Zend_Validate

Package: Zend\Validate

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

Properties

Propertyprotectedarray  $_defaultNamespaces= 'array()'
static

Default Namespaces

Default valuearray()Details
Type
array
Propertyprotectedarray  $_errors= 'array()'

Array of validation failure message codes

Default valuearray()Details
Type
array
Deprecated
Since 1.5.0  
Propertyprotectedarray  $_messages= 'array()'

Array of validation failure messages

Default valuearray()Details
Type
array
Propertyprotectedarray  $_validators= 'array()'

Validator chain

Default valuearray()Details
Type
array

Methods

methodpublicaddDefaultNamespaces( array|string $namespace ) : null
static

Adds a new default namespace

Parameters
Name Type Description
$namespace array|string
Returns
Type Description
null
methodpublicaddValidator( \Zend_Validate_Interface $validator, boolean $breakChainOnFailure = false ) : \Zend_Validate

Adds a validator to the end of the chain

If $breakChainOnFailure is true, then if the validator fails, the next validator in the chain, if one exists, will not be executed.

Parameters
Name Type Description
$validator \Zend_Validate_Interface
$breakChainOnFailure boolean
Returns
Type Description
\Zend_Validate Provides a fluent interface
methodpublicgetDefaultNamespaces( ) : array
static

Returns the set default namespaces

Returns
Type Description
array
methodpublicgetDefaultTranslator(  $translator = null ) : \Zend_Translate_Adapter|null
static

Returns the default translation object

Parameters
Name Type Description
$translator
Returns
Type Description
\Zend_Translate_Adapter|null
methodpublicgetErrors( ) : array

Defined by Zend_Validate_Interface

Returns array of validation failure message codes

Returns
Type Description
array
Details
Deprecated
Since 1.5.0  
methodpublicgetMessageLength( ) : integer
static

Returns the maximum allowed message length

Returns
Type Description
integer
methodpublicgetMessages( ) : array

Defined by Zend_Validate_Interface

Returns array of validation failure messages

Returns
Type Description
array
methodpublichasDefaultNamespaces( ) : boolean
static

Returns true when defaultNamespaces are set

Returns
Type Description
boolean
methodpublicis( mixed $value, string $classBaseName, array $args = array(), mixed $namespaces = array() ) : boolean
static

Parameters
Name Type Description
$value mixed
$classBaseName string
$args array

OPTIONAL

$namespaces mixed

OPTIONAL

Returns
Type Description
boolean
Throws
Exception Description
\Zend_Validate_Exception
methodpublicisValid( mixed $value ) : boolean

Returns true if and only if $value passes all validations in the chain

Validators are run in the order in which they were added to the chain (FIFO).

Parameters
Name Type Description
$value mixed
Returns
Type Description
boolean
methodpublicsetDefaultNamespaces( array|string $namespace ) : null
static

Sets new default namespaces

Parameters
Name Type Description
$namespace array|string
Returns
Type Description
null
methodpublicsetDefaultTranslator( \Zend_Translate|\Zend_Translate_Adapter|null $translator = null ) : void
static

Sets a default translation object for all validation objects

Parameters
Name Type Description
$translator \Zend_Translate|\Zend_Translate_Adapter|null
methodpublicsetMessageLength( integer $length = -1 ) : void
static

Sets the maximum allowed message length

Parameters
Name Type Description
$length integer
Documentation was generated by DocBlox 0.15.1.