Filter.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: Filter.php 21097 2010-02-19 20:11:34Z thomas $
Classes: Zend_Filter

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

Implements: Zend_Filter_Interface
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: CHAIN_APPEND; CHAIN_PREPEND
Properties: $_filters; $_defaultNamespaces
Methods: addFilter; appendFilter; prependFilter; getFilters; filter; getDefaultNamespaces; setDefaultNamespaces; addDefaultNamespaces; hasDefaultNamespaces; get; filterStatic

Description

Constants

CHAIN_APPEND
jump to class

 CHAIN_APPEND = 'append'

Details

value: append

CHAIN_PREPEND
jump to class

 CHAIN_PREPEND = 'prepend'

Details

value: prepend

Properties

$_defaultNamespaces
jump to class

array $_defaultNamespaces = 'array'

Default Namespaces

Details

$_defaultNamespaces: array
visibility: protected
default: array
final: false
static: true

$_filters
jump to class

array $_filters = 'array'

Filter chain

Details

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

Methods

addDefaultNamespaces
jump to class

addDefaultNamespaces(
          array|string $namespace
          )
        
        :
        null

Adds a new default namespace

Arguments

$namespace: arraystring

Output

null

Details

visibility: public
final: false
static: true

addFilter
jump to class

addFilter(
          Zend_Filter_Interface $filter, string $placement
              =
              self
          )
        
        :
        Zend_Filter

Adds a filter to the chain

Arguments

$filter: Zend_Filter_Interface
$placement: string

Output

Zend_Filter: Provides a fluent interface

Details

visibility: public
final: false
static: false

appendFilter
jump to class

appendFilter(
          Zend_Filter_Interface $filter
          )
        
        :
        Zend_Filter

Add a filter to the end of the chain

Arguments

$filter: Zend_Filter_Interface

Output

Zend_Filter: Provides a fluent interface

Details

visibility: public
final: false
static: false

filter
jump to class

filter(
          mixed $value
          )
        
        :
        mixed

Returns $value filtered through each filter in the chain

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

Arguments

$value: mixed

Output

mixed

Details

visibility: public
final: false
static: false

filterStatic
jump to class

filterStatic(
          mixed $value, string $classBaseName, array $args
              =
              array, array|string $namespaces
              =
              array
          )
        
        :
        mixed

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.

Arguments

$value: mixed
$classBaseName: string
$args: array
OPTIONAL
$namespaces: arraystring
OPTIONAL

Output

mixed

Details

visibility: public
final: false
static: true
throws

get
jump to class

get(
          mixed $value, string $classBaseName, array $args
              =
              array, array|string $namespaces
              =
              array
          )
        
        :
        mixed

Arguments

$value: mixed
$classBaseName: string
$args: array
OPTIONAL
$namespaces: arraystring
OPTIONAL

Output

mixed

Details

visibility: public
final: false
static: true
deprecated
see: Zend_Filter::filterStatic()
throws

getDefaultNamespaces
jump to class

getDefaultNamespaces(
          
          )
        
        :
        array

Returns the set default namespaces

Output

array

Details

visibility: public
final: false
static: true

getFilters
jump to class

getFilters(
          
          )
        
        :
        array

Get all the filters

Output

array

Details

visibility: public
final: false
static: false

hasDefaultNamespaces
jump to class

hasDefaultNamespaces(
          
          )
        
        :
        boolean

Returns true when defaultNamespaces are set

Output

boolean

Details

visibility: public
final: false
static: true

prependFilter
jump to class

prependFilter(
          Zend_Filter_Interface $filter
          )
        
        :
        Zend_Filter

Add a filter to the start of the chain

Arguments

$filter: Zend_Filter_Interface

Output

Zend_Filter: Provides a fluent interface

Details

visibility: public
final: false
static: false

setDefaultNamespaces
jump to class

setDefaultNamespaces(
          array|string $namespace
          )
        
        :
        null

Sets new default namespaces

Arguments

$namespace: arraystring

Output

null

Details

visibility: public
final: false
static: true

API Documentation

Filter.php

Description

Zend_Filterjump to top

Description

Constants

CHAIN_APPENDjump to class

Details

CHAIN_PREPENDjump to class

Details

Properties

$_defaultNamespacesjump to class

Details

$_filtersjump to class

Details

Methods

addDefaultNamespacesjump to class

Arguments

Output

Details

addFilterjump to class

Arguments

Output

Details

appendFilterjump to class

Arguments

Output

Details

filterjump to class

Arguments

Output

Details

filterStaticjump to class

Arguments

Output

Details

getjump to class

Arguments

Output

Details

getDefaultNamespacesjump to class

Output

Details

getFiltersjump to class

Output

Details

hasDefaultNamespacesjump to class

Output

Details

prependFilterjump to class

Arguments

Output

Details

setDefaultNamespacesjump to class

Arguments

Output

Details

Zend_Filter
jump to top

CHAIN_APPEND
jump to class

CHAIN_PREPEND
jump to class

$_defaultNamespaces
jump to class

$_filters
jump to class

addDefaultNamespaces
jump to class

addFilter
jump to class

appendFilter
jump to class

filter
jump to class

filterStatic
jump to class

get
jump to class

getDefaultNamespaces
jump to class

getFilters
jump to class

hasDefaultNamespaces
jump to class

prependFilter
jump to class

setDefaultNamespaces
jump to class