Filter/Input.php

Show:

inherited

Classes
- \Zend_Filter_Input

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_Filter
Version: $Id: Input.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Filter_Input
jump to top

Package: Zend\Filter

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

Constants

 
                ALLOW_EMPTY
                = 'allowEmpty'

 
                BREAK_CHAIN
                = 'breakChainOnFailure'

 
                DEFAULT_VALUE
                = 'default'

 
                MESSAGES
                = 'messages'

 
                ESCAPE_FILTER
                = 'escapeFilter'

 
                FIELDS
                = 'fields'

 
                FILTER
                = 'filter'

 
                FILTER_CHAIN
                = 'filterChain'

 
                MISSING_MESSAGE
                = 'missingMessage'

 
                INPUT_NAMESPACE
                = 'inputNamespace'

 
                VALIDATOR_NAMESPACE
                = 'validatorNamespace'

 
                FILTER_NAMESPACE
                = 'filterNamespace'

 
                NOT_EMPTY_MESSAGE
                = 'notEmptyMessage'

 
                PRESENCE
                = 'presence'

 
                PRESENCE_OPTIONAL
                = 'optional'

 
                PRESENCE_REQUIRED
                = 'required'

 
                RULE
                = 'rule'

 
                RULE_WILDCARD
                = '*'

 
                VALIDATE
                = 'validate'

 
                VALIDATOR
                = 'validator'

 
                VALIDATOR_CHAIN
                = 'validatorChain'

 
                VALIDATOR_CHAIN_COUNT
                = 'validatorChainCount'

Properties

array $_data = array()

Input data, before processing.

Default valuearray()Details

Type: array

\Zend_Filter_Interface $_defaultEscapeFilter = null

The filter object that is run on values returned by the getEscaped() method.

Default valuenullDetails

Type: \Zend_Filter_Interface

array $_defaults = array(self::ALLOW_EMPTY => false, self::BREAK_CHAIN => false, self::ESCAPE_FILTER => 'HtmlEntities', self::MISSING_MESSAGE => "Field '%field%' is required by rule '%rule%', but the field is missing", self::NOT_EMPTY_MESSAGE => "You must give a non-empty value for field '%field%'", self::PRESENCE => self::PRESENCE_OPTIONAL)

Default values to use when processing filters and validators.

Default value

array(self::ALLOW_EMPTY => false, self::BREAK_CHAIN => false, self::ESCAPE_FILTER => 'HtmlEntities', self::MISSING_MESSAGE => "Field '%field%' is required by rule '%rule%', but the field is missing", self::NOT_EMPTY_MESSAGE => "You must give a non-empty value for field '%field%'", self::PRESENCE => self::PRESENCE_OPTIONAL)

Details

Type: array

array $_filterRules = array()

Association of rules to filters.

Default valuearray()Details

Type: array

array $_invalidErrors = array()

After processing data, this contains mapping of validation rules that did not pass validation to the array of error identifiers returned by the validator chain.

Default valuearray()Details

Type: array

array $_invalidMessages = array()

After processing data, this contains mapping of validation rules that did not pass validation to the array of messages returned by the validator chain.

Default valuearray()Details

Type: array

array $_loaders = array()

Plugin loaders

Default valuearray()Details

Type: array

array $_missingFields = array()

After processing data, this contains mapping of validation rules in which some fields were missing to the array of messages indicating which fields were missing.

Default valuearray()Details

Type: array

boolean $_processed = false

Set to False initially, this is set to True after the input data have been processed. Reset to False in setData() method.

Default valuefalseDetails

Type: boolean

\Zend_Translate $_translator

Translation object

Details

Type: \Zend_Translate

Boolean $_translatorDisabled = false

Is translation disabled?

Default valuefalseDetails

Type: Boolean

array $_unknownFields = array()

After processing, this contains a copy of $_data elements that were not mentioned in any validation rule.

Default valuearray()Details

Type: array

array $_validFields = array()

After processing data, this contains mapping of valid fields to field values.

Default valuearray()Details

Type: array

array $_validatorRules = array()

Association of rules to validators.

Default valuearray()Details

Type: array

Methods

__construct(array $filterRules, array $validatorRules, array $data = null, array $options = null) : void

Parameters

Name	Type	Description
$filterRules	array
$validatorRules	array
$data	array	OPTIONAL
$options	array	OPTIONAL

__get(string $fieldName) : mixed

Parameters

Name	Type	Description
$fieldName	string

Returns

Type	Description
mixed

__isset(string $fieldName) : boolean

Parameters

Name	Type	Description
$fieldName	string

Returns

Type	Description
boolean

_escapeRecursive( $data) : mixed

Parameters

Name	Type	Description
$data

Returns

Type	Description
mixed

_filter() : void

_filterRule(array $filterRule) : void

Parameters

Name	Type	Description
$filterRule	array

_getDefaultEscapeFilter() : \Zend_Filter_Interface

Returns

Type	Description
\Zend_Filter_Interface

_getFilter(mixed $classBaseName) : \Zend_Filter_Interface

Parameters

Name	Type	Description
$classBaseName	mixed

Returns

Type	Description
\Zend_Filter_Interface

_getFilterOrValidator(string $type, mixed $classBaseName) : \Zend_Filter_Interface | \Zend_Validate_Interface

Parameters

Name	Type	Description
$type	string
$classBaseName	mixed

Returns

Type	Description
\Zend_Filter_Interface \| \Zend_Validate_Interface

Throws

Exception	Description
\Zend_Filter_Exception

_getMissingMessage(string $rule, string $field) : string

Parameters

Name	Type	Description
$rule	string
$field	string

Returns

Type	Description
string

_getNotEmptyMessage( $rule, $field) : string

Parameters

Name	Type	Description
$rule
$field

Returns

Type	Description
string

_getNotEmptyValidatorInstance(array $validatorRule) : mixed

Check a validatorRule for the presence of a NotEmpty validator instance.

The purpose is to preserve things like a custom message, that may have been set on the validator outside Zend_Filter_Input.

Parameters

Name	Type	Description
$validatorRule	array

Returns

Type	Description
mixed	false if none is found, Zend_Validate_NotEmpty instance if found

_getValidator(mixed $classBaseName) : \Zend_Validate_Interface

Parameters

Name	Type	Description
$classBaseName	mixed

Returns

Type	Description
\Zend_Validate_Interface

_process() : void

_validate() : void

_validateRule(array $validatorRule) : void

Parameters

Name	Type	Description
$validatorRule	array

addFilterPrefixPath(string $prefix, string $path) : \Zend_Filter_Input

Add prefix path for all elements

Parameters

Name	Type	Description
$prefix	string
$path	string

Returns

Type	Description
\Zend_Filter_Input

addNamespace(mixed $namespaces) : \Zend_Filter_Input

Parameters

Name	Type	Description
$namespaces	mixed

Returns

Type	Description
\Zend_Filter_Input

Details

Deprecated: since 1.5.0RC1 - use addFilterPrefixPath() or addValidatorPrefixPath instead.

addValidatorPrefixPath(string $prefix, string $path) : \Zend_Filter_Input

Add prefix path for all elements

Parameters

Name	Type	Description
$prefix	string
$path	string

Returns

Type	Description
\Zend_Filter_Input

getErrors() : array

Returns

Type	Description
array

getEscaped(string $fieldName = null) : mixed

Parameters

Name	Type	Description
$fieldName	string	OPTIONAL

Returns

Type	Description
mixed

getInvalid() : array

Returns

Type	Description
array

getMessages() : array

Returns

Type	Description
array

getMissing() : array

Returns

Type	Description
array

getPluginLoader(string $type) : \Zend_Loader_PluginLoader_Interface

Retrieve plugin loader for given type

$type may be one of: - filter - validator

If a plugin loader does not exist for the given type, defaults are created.

Parameters

Name	Type	Description
$type	string	'filter' or 'validate'

Returns

Type	Description
\Zend_Loader_PluginLoader_Interface

Throws

Exception	Description
\Zend_Filter_Exception	on invalid type

getTranslator() : \Zend_Translate_Adapter | null

Return translation object

Returns

Type	Description
\Zend_Translate_Adapter \| null

getUnescaped(string $fieldName = null) : mixed

Parameters

Name	Type	Description
$fieldName	string	OPTIONAL

Returns

Type	Description
mixed

getUnknown() : array

Returns

Type	Description
array

hasInvalid() : boolean

Returns

Type	Description
boolean

hasMissing() : boolean

Returns

Type	Description
boolean

hasUnknown() : boolean

Returns

Type	Description
boolean

hasValid() : boolean

Returns

Type	Description
boolean

isValid(string $fieldName = null) : boolean

Parameters

Name	Type	Description
$fieldName	string

Returns

Type	Description
boolean

process() : \Zend_Filter_Input

Returns

Type	Description
\Zend_Filter_Input

Throws

Exception	Description
\Zend_Filter_Exception

setData(array $data) : \Zend_Filter_Input

Parameters

Name	Type	Description
$data	array

Returns

Type	Description
\Zend_Filter_Input

setDefaultEscapeFilter(mixed $escapeFilter) : \Zend_Filter_Interface

Parameters

Name	Type	Description
$escapeFilter	mixed

Returns

Type	Description
\Zend_Filter_Interface

setDisableTranslator(bool $flag) : \Zend_Filter_Input

Indicate whether or not translation should be disabled

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Filter_Input

setOptions(array $options) : \Zend_Filter_Input

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Filter_Input

Throws

Exception	Description
\Zend_Filter_Exception	if an unknown option is given

setPluginLoader(\Zend_Loader_PluginLoader_Interface $loader, string $type) : \Zend_Filter_Input

Set plugin loaders for use with decorators and elements

Parameters

Name	Type	Description
$loader	\Zend_Loader_PluginLoader_Interface
$type	string	'filter' or 'validate'

Returns

Type	Description
\Zend_Filter_Input

Throws

Exception	Description
\Zend_Filter_Exception	on invalid type

setTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : \Zend_Filter_Input

Set translation object

Parameters

Name	Type	Description
$translator	\Zend_Translate \| \Zend_Translate_Adapter \| null

Returns

Type	Description
\Zend_Filter_Input

translatorIsDisabled() : bool

Is translation disabled?

Returns

Type	Description
bool

Filter/Input.php

\Zend_Filter_Inputjump to top

Constants

Properties

Methods

\Zend_Filter_Input
jump to top