Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes

Zend_Filter Class Reference

Public Member Functions

 addFilter (Zend_Filter_Interface $filter)
 filter ($value)

Static Public Member Functions

static getDefaultNamespaces ()
static setDefaultNamespaces ($namespace)
static addDefaultNamespaces ($namespace)
static hasDefaultNamespaces ()
static get ($value, $classBaseName, array $args=array(), $namespaces=array())
static filterStatic ($value, $classBaseName, array $args=array(), $namespaces=array())

Protected Attributes

 $_filters = array()

Static Protected Attributes

static $_defaultNamespaces = array()

Detailed Description

Definition at line 33 of file Filter.php.


Member Function Documentation

static addDefaultNamespaces ( namespace ) [static]

Adds a new default namespace

Parameters:
array | string$namespace
Returns:
null

Definition at line 109 of file Filter.php.

addFilter ( Zend_Filter_Interface $  filter )

Adds a filter to the end of the chain

Parameters:
Zend_Filter_Interface$filter
Returns:
Zend_Filter Provides a fluent interface

Definition at line 55 of file Filter.php.

filter ( value )

Returns $value filtered through each filter in the chain

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

Parameters:
mixed$value
Returns:
mixed

Definition at line 69 of file Filter.php.

static filterStatic ( value,
classBaseName,
array $  args = array(),
namespaces = array() 
) [static]

Returns a value filtered through a specified filter class, without requiring separate instantiation of the filter object.

The first argument of this method is a data input value, that you would have filtered. The second argument is a string, which corresponds to the basename of the filter class, relative to the Zend_Filter namespace. This method automatically loads the class, creates an instance, and applies the filter() method to the data input. You can also pass an array of constructor arguments, if they are needed for the filter class.

Parameters:
mixed$value
string$classBaseName
array$argsOPTIONAL
array | string$namespacesOPTIONAL
Returns:
mixed
Exceptions:
Zend_Filter_Exception

Definition at line 166 of file Filter.php.

static get ( value,
classBaseName,
array $  args = array(),
namespaces = array() 
) [static]
Deprecated:
See also:
Zend_Filter::filterStatic()
Parameters:
mixed$value
string$classBaseName
array$argsOPTIONAL
array | string$namespacesOPTIONAL
Returns:
mixed
Exceptions:
Zend_Filter_Exception

Definition at line 139 of file Filter.php.

static getDefaultNamespaces (  ) [static]

Returns the set default namespaces

Returns:
array

Definition at line 83 of file Filter.php.

static hasDefaultNamespaces (  ) [static]

Returns true when defaultNamespaces are set

Returns:
boolean

Definition at line 123 of file Filter.php.

static setDefaultNamespaces ( namespace ) [static]

Sets new default namespaces

Parameters:
array | string$namespace
Returns:
null

Definition at line 94 of file Filter.php.


The documentation for this class was generated from the following file: