Class Zend_Filter_Input

Description
  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Filter/Input.php (line 44)


	
			
Class Constant Summary
 ALLOW_EMPTY = 'allowEmpty'
 BREAK_CHAIN = 'breakChainOnFailure'
 ESCAPE_FILTER = 'escapeFilter'
 FIELDS = 'fields'
 FILTER_CHAIN = 'filterChain'
 MESSAGES = 'messages'
 MISSING_MESSAGE = 'missingMessage'
 NAMESPACE = 'namespace'
 NOT_EMPTY_MESSAGE = 'notEmptyMessage'
 PRESENCE = 'presence'
 PRESENCE_OPTIONAL = 'optional'
 PRESENCE_REQUIRED = 'required'
 RULE = 'rule'
 VALIDATOR = 'validator'
 VALIDATOR_CHAIN = 'validatorChain'
 VALIDATOR_CHAIN_COUNT = 'validatorChainCount'
Variable Summary
Method Summary
 void addNamespace (mixed $namespaces)
 Zend_Filter_Input __construct ( $filterRules,  $validatorRules, [ $data = null], [ $options = null], array $filters, array $validators)
 array getErrors ()
 mixed getEscaped ([string $fieldName = null])
 array getMessages ()
 array getMissing ()
 mixed getUnescaped ([string $fieldName = null])
 array getUnknown ()
 boolean hasInvalid ()
 boolean hasMissing ()
 boolean hasUnknown ()
 boolean hasValid ()
 void process ()
 void setData ( $data)
 void setDefaultEscapeFilter (mixed $escapeFilter)
 void setOptions ( $options)
 mixed _escapeRecursive ( $data, mixed $value)
 void _filter ()
 void _filterRule ( $filterRule)
 Zend_Filter_Interface _getFilter (mixed $classBaseName)
 mixed _getFilterOrValidator (string $interface, mixed $classBaseName)
 string _getMissingMessage (string $rule, string $field)
 string _getNotEmptyMessage ( $rule,  $field)
 Zend_Validate_Interface _getValidator (mixed $classBaseName)
 void _process ()
 void _validate ()
 void _validateRule ( $validatorRule)
 mixed __get (string $fieldName)
 boolean __isset (string $fieldName)
Variables
array $_data = array() (line 68)
  • var: Input data, before processing.
  • access: protected
Zend_Filter_Interface $_defaultEscapeFilter = null (line 127)
  • var: The filter object that is run on values returned by the getEscaped() method.
  • access: protected
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
)
(line 132)
  • var: Default values to use when processing filters and validators.
  • access: protected
array $_filterRules = array() (line 73)
  • var: Association of rules to filters.
  • access: protected
array $_invalidErrors = array() (line 98)
  • var: 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.
  • access: protected
array $_invalidMessages = array() (line 91)
  • var: After processing data, this contains mapping of validation rules that did not pass validation to the array of messages returned by the validator chain.
  • access: protected
array $_missingFields = array() (line 105)
  • var: 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.
  • access: protected
array $_namespaces = array('Zend_Filter', 'Zend_Validate') (line 116)
  • var: Default namespaces, to search after user-defined namespaces.
  • access: protected
boolean $_processed = false (line 145)
  • var: Set to False initially, this is set to True after the input data have been processed. Reset to False in setData() method.
  • access: protected
array $_unknownFields = array() (line 111)
  • var: After processing, this contains a copy of $_data elements that were not mentioned in any validation rule.
  • access: protected
array $_userNamespaces = array() (line 121)
  • var: User-defined namespaces, to search before $_namespaces.
  • access: protected
array $_validatorRules = array() (line 78)
  • var: Association of rules to validators.
  • access: protected
array $_validFields = array() (line 84)
  • var: After processing data, this contains mapping of valid fields to field values.
  • access: protected
Methods
addNamespace (line 171)
  • access: public
void addNamespace (mixed $namespaces)
  • mixed $namespaces
Constructor __construct (line 153)
  • access: public
Zend_Filter_Input __construct ( $filterRules,  $validatorRules, [ $data = null], [ $options = null], array $filters, array $validators)
  • array $filters
  • array $validators
  • array $data: OPTIONAL
  • array $options: OPTIONAL
  • $filterRules
  • $validatorRules
getErrors (line 194)
  • access: public
array getErrors ()
getEscaped (line 222)
  • access: public
mixed getEscaped ([string $fieldName = null])
  • string $fieldName: OPTIONAL
getMessages (line 185)
  • access: public
array getMessages ()
getMissing (line 203)
  • access: public
array getMissing ()
getUnescaped (line 255)
  • access: public
mixed getUnescaped ([string $fieldName = null])
  • string $fieldName: OPTIONAL
getUnknown (line 212)
  • access: public
array getUnknown ()
hasInvalid (line 279)
  • access: public
boolean hasInvalid ()
hasMissing (line 288)
  • access: public
boolean hasMissing ()
hasUnknown (line 297)
  • access: public
boolean hasUnknown ()
hasValid (line 306)
  • access: public
boolean hasValid ()
process (line 326)
  • access: public
void process ()
setData (line 343)
  • access: public
void setData ( $data)
  • array $data
setDefaultEscapeFilter (line 363)
  • access: public
void setDefaultEscapeFilter (mixed $escapeFilter)
  • mixed $escapeFilter
setOptions (line 381)
  • throws: Zend_Filter_Exception if an unknown option is given
  • access: public
void setOptions ( $options)
  • array $options
_escapeRecursive (line 240)
  • access: protected
mixed _escapeRecursive ( $data, mixed $value)
  • mixed $value
  • $data
_filter (line 413)
  • access: protected
void _filter ()
_filterRule (line 475)
  • access: protected
void _filterRule ( $filterRule)
  • array $filterRule
_getDefaultEscapeFilter (line 494)
  • access: protected
Zend_Filter_Interface _getDefaultEscapeFilter ()
_getFilter (line 740)
  • access: protected
Zend_Filter_Interface _getFilter (mixed $classBaseName)
  • mixed $classBaseName
_getFilterOrValidator (line 760)
  • return: object implementing Zend_Filter_Interface or Zend_Validate_Interface
  • throws: Zend_Filter_Exception
  • access: protected
mixed _getFilterOrValidator (string $interface, mixed $classBaseName)
  • string $interface
  • mixed $classBaseName
_getMissingMessage (line 507)
  • access: protected
string _getMissingMessage (string $rule, string $field)
  • string $rule
  • string $field
_getNotEmptyMessage (line 518)
  • access: protected
string _getNotEmptyMessage ( $rule,  $field)
  • $rule
  • $field
_getValidator (line 749)
  • access: protected
Zend_Validate_Interface _getValidator (mixed $classBaseName)
  • mixed $classBaseName
_process (line 529)
  • access: protected
void _process ()
_validate (line 541)
  • access: protected
void _validate ()
_validateRule (line 660)
  • access: protected
void _validateRule ( $validatorRule)
  • array $validatorRule
__get (line 271)
  • access: public
mixed __get (string $fieldName)
  • string $fieldName
__isset (line 316)
  • access: public
boolean __isset (string $fieldName)
  • string $fieldName
Class Constants
ALLOW_EMPTY = 'allowEmpty' (line 47)
BREAK_CHAIN = 'breakChainOnFailure' (line 48)
ESCAPE_FILTER = 'escapeFilter' (line 50)
FIELDS = 'fields' (line 51)
FILTER_CHAIN = 'filterChain' (line 52)
MESSAGES = 'messages' (line 49)
MISSING_MESSAGE = 'missingMessage' (line 53)
NAMESPACE = 'namespace' (line 54)
NOT_EMPTY_MESSAGE = 'notEmptyMessage' (line 55)
PRESENCE = 'presence' (line 56)
PRESENCE_OPTIONAL = 'optional' (line 57)
PRESENCE_REQUIRED = 'required' (line 58)
RULE = 'rule' (line 59)
RULE_WILDCARD = '*' (line 60)
VALIDATOR = 'validator' (line 61)
VALIDATOR_CHAIN = 'validatorChain' (line 62)
VALIDATOR_CHAIN_COUNT = 'validatorChainCount' (line 63)

Documentation generated on Sun, 27 May 2007 23:24:58 -0700 by phpDocumentor 1.3.2