Filter/Input.php

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_Filter
version: $Id: Input.php 22473 2010-06-20 08:30:04Z thomas $
Classes: Zend_Filter_Input

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_Filter_Input
jump to top

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_Filter
Constants: ALLOW_EMPTY; BREAK_CHAIN; DEFAULT_VALUE; MESSAGES; ESCAPE_FILTER; FIELDS; FILTER; FILTER_CHAIN; MISSING_MESSAGE; INPUT_NAMESPACE; VALIDATOR_NAMESPACE; FILTER_NAMESPACE; NOT_EMPTY_MESSAGE; PRESENCE; PRESENCE_OPTIONAL; PRESENCE_REQUIRED; RULE; RULE_WILDCARD; VALIDATE; VALIDATOR; VALIDATOR_CHAIN; VALIDATOR_CHAIN_COUNT
Properties: $_data; $_filterRules; $_validatorRules; $_validFields; $_invalidMessages; $_invalidErrors; $_missingFields; $_unknownFields; $_defaultEscapeFilter; $_loaders; $_defaults; $_processed; $_translator; $_translatorDisabled
Methods: __construct; addNamespace; addFilterPrefixPath; addValidatorPrefixPath; setPluginLoader; getPluginLoader; getMessages; getErrors; getInvalid; getMissing; getUnknown; getEscaped; _escapeRecursive; getUnescaped; __get; hasInvalid; hasMissing; hasUnknown; hasValid; isValid; __isset; process; setData; setDefaultEscapeFilter; setOptions; setTranslator; getTranslator; setDisableTranslator; translatorIsDisabled; _filter; _filterRule; _getDefaultEscapeFilter; _getMissingMessage; _getNotEmptyMessage; _process; _validate; _validateRule; _getFilter; _getValidator; _getFilterOrValidator

Description

Constants

ALLOW_EMPTY
jump to class

 ALLOW_EMPTY = 'allowEmpty'

Details

value: allowEmpty

BREAK_CHAIN
jump to class

 BREAK_CHAIN = 'breakChainOnFailure'

Details

value: breakChainOnFailure

DEFAULT_VALUE
jump to class

 DEFAULT_VALUE = 'default'

Details

value: default

MESSAGES
jump to class

 MESSAGES = 'messages'

Details

value: messages

ESCAPE_FILTER
jump to class

 ESCAPE_FILTER = 'escapeFilter'

Details

value: escapeFilter

FIELDS
jump to class

 FIELDS = 'fields'

Details

value: fields

FILTER
jump to class

 FILTER = 'filter'

Details

value: filter

FILTER_CHAIN
jump to class

 FILTER_CHAIN = 'filterChain'

Details

value: filterChain

MISSING_MESSAGE
jump to class

 MISSING_MESSAGE = 'missingMessage'

Details

value: missingMessage

INPUT_NAMESPACE
jump to class

 INPUT_NAMESPACE = 'inputNamespace'

Details

value: inputNamespace

VALIDATOR_NAMESPACE
jump to class

 VALIDATOR_NAMESPACE = 'validatorNamespace'

Details

value: validatorNamespace

FILTER_NAMESPACE
jump to class

 FILTER_NAMESPACE = 'filterNamespace'

Details

value: filterNamespace

NOT_EMPTY_MESSAGE
jump to class

 NOT_EMPTY_MESSAGE = 'notEmptyMessage'

Details

value: notEmptyMessage

PRESENCE
jump to class

 PRESENCE = 'presence'

Details

value: presence

PRESENCE_OPTIONAL
jump to class

 PRESENCE_OPTIONAL = 'optional'

Details

value: optional

PRESENCE_REQUIRED
jump to class

 PRESENCE_REQUIRED = 'required'

Details

value: required

RULE
jump to class

 RULE = 'rule'

Details

value: rule

RULE_WILDCARD
jump to class

 RULE_WILDCARD = '*'

Details

value: *

VALIDATE
jump to class

 VALIDATE = 'validate'

Details

value: validate

VALIDATOR
jump to class

 VALIDATOR = 'validator'

Details

value: validator

VALIDATOR_CHAIN
jump to class

 VALIDATOR_CHAIN = 'validatorChain'

Details

value: validatorChain

VALIDATOR_CHAIN_COUNT
jump to class

 VALIDATOR_CHAIN_COUNT = 'validatorChainCount'

Details

value: validatorChainCount

Properties

$_data
jump to class

array $_data = 'array'

Details

$_data: array
Input data, before processing.
visibility: protected
default: array
final: false
static: false

$_defaultEscapeFilter
jump to class

Zend_Filter_Interface $_defaultEscapeFilter = 'null'

Details

$_defaultEscapeFilter: Zend_Filter_Interface
The filter object that is run on values returned by the getEscaped() method.
visibility: protected
default: null
final: false
static: false

$_defaults
jump to class

array $_defaults = 'array'

Details

$_defaults: array
Default values to use when processing filters and validators.
visibility: protected
default: array
final: false
static: false

$_filterRules
jump to class

array $_filterRules = 'array'

Details

$_filterRules: array
Association of rules to filters.
visibility: protected
default: array
final: false
static: false

$_invalidErrors
jump to class

array $_invalidErrors = 'array'

Details

$_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.
visibility: protected
default: array
final: false
static: false

$_invalidMessages
jump to class

array $_invalidMessages = 'array'

Details

$_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.
visibility: protected
default: array
final: false
static: false

$_loaders
jump to class

array $_loaders = 'array'

Plugin loaders

Details

$_loaders: array
visibility: protected
default: array
final: false
static: false

$_missingFields
jump to class

array $_missingFields = 'array'

Details

$_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.
visibility: protected
default: array
final: false
static: false

$_processed
jump to class

boolean $_processed = 'false'

Details

$_processed: boolean
Set to False initially, this is set to True after the input data have been processed. Reset to False in setData() method.
visibility: protected
default: false
final: false
static: false

$_translator
jump to class

Zend_Translate $_translator = ''

Translation object

Details

$_translator: Zend_Translate
visibility: protected
default
final: false
static: false

$_translatorDisabled
jump to class

Boolean $_translatorDisabled = 'false'

Is translation disabled?

Details

$_translatorDisabled: Boolean
visibility: protected
default: false
final: false
static: false

$_unknownFields
jump to class

array $_unknownFields = 'array'

Details

$_unknownFields: array
After processing, this contains a copy of $_data elements that were not mentioned in any validation rule.
visibility: protected
default: array
final: false
static: false

$_validFields
jump to class

array $_validFields = 'array'

Details

$_validFields: array
After processing data, this contains mapping of valid fields to field values.
visibility: protected
default: array
final: false
static: false

$_validatorRules
jump to class

array $_validatorRules = 'array'

Details

$_validatorRules: array
Association of rules to validators.
visibility: protected
default: array
final: false
static: false

Methods

__construct
jump to class

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

Arguments

$filterRules: array
$validatorRules: array
$data: array
OPTIONAL
$options: array
OPTIONAL

Details

visibility: public
final: false
static: false

__get
jump to class

__get(
          string $fieldName
          )
        
        :
        mixed

Arguments

$fieldName: string

Output

mixed

Details

visibility: public
final: false
static: false

__isset
jump to class

__isset(
          string $fieldName
          )
        
        :
        boolean

Arguments

$fieldName: string

Output

boolean

Details

visibility: public
final: false
static: false

_escapeRecursive
jump to class

_escapeRecursive(
           $data
          )
        
        :
        mixed

Arguments

$data

Output

mixed

Details

visibility: protected
final: false
static: false

_filter
jump to class

_filter(
          
          )
        
        :
        void

Details

visibility: protected
final: false
static: false

_filterRule
jump to class

_filterRule(
          array $filterRule
          )
        
        :
        void

Arguments

$filterRule: array

Details

visibility: protected
final: false
static: false

_getDefaultEscapeFilter
jump to class

_getDefaultEscapeFilter(
          
          )
        
        :
        Zend_Filter_Interface

Output

Zend_Filter_Interface

Details

visibility: protected
final: false
static: false

_getFilter
jump to class

_getFilter(
          mixed $classBaseName
          )
        
        :
        Zend_Filter_Interface

Arguments

$classBaseName: mixed

Output

Zend_Filter_Interface

Details

visibility: protected
final: false
static: false

_getFilterOrValidator
jump to class

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

Arguments

$type: string
$classBaseName: mixed

Output

Zend_Filter_Interface|Zend_Validate_Interface

Details

visibility: protected
final: false
static: false
throws

_getMissingMessage
jump to class

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

Arguments

$rule: string
$field: string

Output

string

Details

visibility: protected
final: false
static: false

_getNotEmptyMessage
jump to class

_getNotEmptyMessage(
           $rule,  $field
          )
        
        :
        string

Arguments

$rule
$field

Output

string

Details

visibility: protected
final: false
static: false

_getValidator
jump to class

_getValidator(
          mixed $classBaseName
          )
        
        :
        Zend_Validate_Interface

Arguments

$classBaseName: mixed

Output

Zend_Validate_Interface

Details

visibility: protected
final: false
static: false

_process
jump to class

_process(
          
          )
        
        :
        void

Details

visibility: protected
final: false
static: false

_validate
jump to class

_validate(
          
          )
        
        :
        void

Details

visibility: protected
final: false
static: false

_validateRule
jump to class

_validateRule(
          array $validatorRule
          )
        
        :
        void

Arguments

$validatorRule: array

Details

visibility: protected
final: false
static: false

addFilterPrefixPath
jump to class

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

Add prefix path for all elements

Arguments

$prefix: string
$path: string

Output

Zend_Filter_Input

Details

visibility: public
final: false
static: false

addNamespace
jump to class

addNamespace(
          mixed $namespaces
          )
        
        :
        Zend_Filter_Input

Arguments

$namespaces: mixed

Output

Zend_Filter_Input

Details

visibility: public
final: false
static: false
deprecated: since 1.5.0RC1 - use addFilterPrefixPath() or addValidatorPrefixPath instead.

addValidatorPrefixPath
jump to class

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

Add prefix path for all elements

Arguments

$prefix: string
$path: string

Output

Zend_Filter_Input

Details

visibility: public
final: false
static: false

getErrors
jump to class

getErrors(
          
          )
        
        :
        array

Output

array

Details

visibility: public
final: false
static: false

getEscaped
jump to class

getEscaped(
          string $fieldName
              =
              null
          )
        
        :
        mixed

Arguments

$fieldName: string
OPTIONAL

Output

mixed

Details

visibility: public
final: false
static: false

getInvalid
jump to class

getInvalid(
          
          )
        
        :
        array

Output

array

Details

visibility: public
final: false
static: false

getMessages
jump to class

getMessages(
          
          )
        
        :
        array

Output

array

Details

visibility: public
final: false
static: false

getMissing
jump to class

getMissing(
          
          )
        
        :
        array

Output

array

Details

visibility: public
final: false
static: false

getPluginLoader
jump to class

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.

Arguments

$type: string
'filter' or 'validate'

Output

Zend_Loader_PluginLoader_Interface

Details

visibility: public
final: false
static: false
throws: on invalid type

getTranslator
jump to class

getTranslator(
          
          )
        
        :
        Zend_Translate_Adapter|null

Return translation object

Output

Zend_Translate_Adapter|null

Details

visibility: public
final: false
static: false

getUnescaped
jump to class

getUnescaped(
          string $fieldName
              =
              null
          )
        
        :
        mixed

Arguments

$fieldName: string
OPTIONAL

Output

mixed

Details

visibility: public
final: false
static: false

getUnknown
jump to class

getUnknown(
          
          )
        
        :
        array

Output

array

Details

visibility: public
final: false
static: false

hasInvalid
jump to class

hasInvalid(
          
          )
        
        :
        boolean

Output

boolean

Details

visibility: public
final: false
static: false

hasMissing
jump to class

hasMissing(
          
          )
        
        :
        boolean

Output

boolean

Details

visibility: public
final: false
static: false

hasUnknown
jump to class

hasUnknown(
          
          )
        
        :
        boolean

Output

boolean

Details

visibility: public
final: false
static: false

hasValid
jump to class

hasValid(
          
          )
        
        :
        boolean

Output

boolean

Details

visibility: public
final: false
static: false

isValid
jump to class

isValid(
          string $fieldName
              =
              null
          )
        
        :
        boolean

Arguments

$fieldName: string

Output

boolean

Details

visibility: public
final: false
static: false

process
jump to class

process(
          
          )
        
        :
        Zend_Filter_Input

Output

Zend_Filter_Input

Details

visibility: public
final: false
static: false
throws

setData
jump to class

setData(
          array $data
          )
        
        :
        Zend_Filter_Input

Arguments

$data: array

Output

Zend_Filter_Input

Details

visibility: public
final: false
static: false

setDefaultEscapeFilter
jump to class

setDefaultEscapeFilter(
          mixed $escapeFilter
          )
        
        :
        Zend_Filter_Interface

Arguments

$escapeFilter: mixed

Output

Zend_Filter_Interface

Details

visibility: public
final: false
static: false

setDisableTranslator
jump to class

setDisableTranslator(
          bool $flag
          )
        
        :
        Zend_Filter_Input

Indicate whether or not translation should be disabled

Arguments

$flag: bool

Output

Zend_Filter_Input

Details

visibility: public
final: false
static: false

setOptions
jump to class

setOptions(
          array $options
          )
        
        :
        Zend_Filter_Input

Arguments

$options: array

Output

Zend_Filter_Input

Details

visibility: public
final: false
static: false
throws: if an unknown option is given

setPluginLoader
jump to class

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

Set plugin loaders for use with decorators and elements

Arguments

$loader: Zend_Loader_PluginLoader_Interface
$type: string
'filter' or 'validate'

Output

Zend_Filter_Input

Details

visibility: public
final: false
static: false
throws: on invalid type

setTranslator
jump to class

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

Set translation object

Arguments

$translator: Zend_TranslateZend_Translate_Adapternull

Output

Zend_Filter_Input

Details

visibility: public
final: false
static: false

translatorIsDisabled
jump to class

translatorIsDisabled(
          
          )
        
        :
        bool

Is translation disabled?

Output

bool

Details

visibility: public
final: false
static: false

API Documentation

Filter/Input.php

Description

Zend_Filter_Inputjump to top

Description

Constants

ALLOW_EMPTYjump to class

Details

BREAK_CHAINjump to class

Details

DEFAULT_VALUEjump to class

Details

MESSAGESjump to class

Details

ESCAPE_FILTERjump to class

Details

FIELDSjump to class

Details

FILTERjump to class

Details

FILTER_CHAINjump to class

Details

MISSING_MESSAGEjump to class

Details

INPUT_NAMESPACEjump to class

Details

VALIDATOR_NAMESPACEjump to class

Details

FILTER_NAMESPACEjump to class

Details

NOT_EMPTY_MESSAGEjump to class

Details

PRESENCEjump to class

Details

PRESENCE_OPTIONALjump to class

Details

PRESENCE_REQUIREDjump to class

Details

RULEjump to class

Details

RULE_WILDCARDjump to class

Details

VALIDATEjump to class

Details

VALIDATORjump to class

Details

VALIDATOR_CHAINjump to class

Details

VALIDATOR_CHAIN_COUNTjump to class

Details

Properties

$_datajump to class

Details

$_defaultEscapeFilterjump to class

Details

$_defaultsjump to class

Details

$_filterRulesjump to class

Details

$_invalidErrorsjump to class

Details

$_invalidMessagesjump to class

Details

$_loadersjump to class

Details

$_missingFieldsjump to class

Details

$_processedjump to class

Details

$_translatorjump to class

Details

$_translatorDisabledjump to class

Details

$_unknownFieldsjump to class

Details

$_validFieldsjump to class

Details

$_validatorRulesjump to class

Details

Methods

Zend_Filter_Input
jump to top

ALLOW_EMPTY
jump to class

BREAK_CHAIN
jump to class

DEFAULT_VALUE
jump to class

MESSAGES
jump to class

ESCAPE_FILTER
jump to class

FIELDS
jump to class

FILTER
jump to class

FILTER_CHAIN
jump to class

MISSING_MESSAGE
jump to class

INPUT_NAMESPACE
jump to class

VALIDATOR_NAMESPACE
jump to class

FILTER_NAMESPACE
jump to class

NOT_EMPTY_MESSAGE
jump to class

PRESENCE
jump to class

PRESENCE_OPTIONAL
jump to class

PRESENCE_REQUIRED
jump to class

RULE
jump to class

RULE_WILDCARD
jump to class

VALIDATE
jump to class

VALIDATOR
jump to class

VALIDATOR_CHAIN
jump to class

VALIDATOR_CHAIN_COUNT
jump to class

$_data
jump to class

$_defaultEscapeFilter
jump to class

$_defaults
jump to class

$_filterRules
jump to class

$_invalidErrors
jump to class

$_invalidMessages
jump to class

$_loaders
jump to class

$_missingFields
jump to class

$_processed
jump to class

$_translator
jump to class

$_translatorDisabled
jump to class

$_unknownFields
jump to class

$_validFields
jump to class

$_validatorRules
jump to class

__construct
jump to class

__get
jump to class

__isset
jump to class

_escapeRecursive
jump to class

_filter
jump to class

_filterRule
jump to class

_getDefaultEscapeFilter
jump to class

_getFilter
jump to class

_getFilterOrValidator
jump to class

_getMissingMessage
jump to class

_getNotEmptyMessage
jump to class

_getValidator
jump to class

_process
jump to class

_validate
jump to class

_validateRule
jump to class

addFilterPrefixPath
jump to class

addNamespace
jump to class

addValidatorPrefixPath
jump to class

getErrors
jump to class

getEscaped
jump to class

getInvalid
jump to class