Filter.php

Show:

inherited

Classes
- \Zend_Filter

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Filter
Version: $Id$

\Zend_Filter
jump to top

Package: Zend_Filter

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

Constants

 
                CHAIN_APPEND
                = 'append'

 
                CHAIN_PREPEND
                = 'prepend'

Properties

array $_defaultNamespaces = array()

static

Default Namespaces

Default valuearray()Details

Type: array

array $_filters = array()

Filter chain

Default valuearray()Details

Type: array

Methods

addDefaultNamespaces(array | string $namespace) : null

static

Adds a new default namespace

Parameters

Name	Type	Description
$namespace	array \| string

Returns

Type	Description
null

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

Adds a filter to the chain

Parameters

Name	Type	Description
$filter	\Zend_Filter_Interface
$placement	string

Returns

Type	Description
\Zend_Filter	Provides a fluent interface

appendFilter(\Zend_Filter_Interface $filter) : \Zend_Filter

Add a filter to the end of the chain

Parameters

Name	Type	Description
$filter	\Zend_Filter_Interface

Returns

Type	Description
\Zend_Filter	Provides a fluent interface

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)

Parameters

Name	Type	Description
$value	mixed

Returns

Type	Description
mixed

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

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

Name	Type	Description
$value	mixed
$classBaseName	string
$args	array	OPTIONAL
$namespaces	array \| string	OPTIONAL

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Filter_Exception

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

static

Parameters

Name	Type	Description
$value	mixed
$classBaseName	string
$args	array	OPTIONAL
$namespaces	array \| string	OPTIONAL

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Filter_Exception

Details

Deprecated
See

getDefaultNamespaces() : array

static

Returns the set default namespaces

Returns

Type	Description
array

getFilters() : array

Get all the filters

Returns

Type	Description
array

hasDefaultNamespaces() : boolean

static

Returns true when defaultNamespaces are set

Returns

Type	Description
boolean

prependFilter(\Zend_Filter_Interface $filter) : \Zend_Filter

Add a filter to the start of the chain

Parameters

Name	Type	Description
$filter	\Zend_Filter_Interface

Returns

Type	Description
\Zend_Filter	Provides a fluent interface

setDefaultNamespaces(array | string $namespace) : null

static

Sets new default namespaces

Parameters

Name	Type	Description
$namespace	array \| string

Returns

Type	Description
null

Filter.php

\Zend_Filterjump to top

Constants

Properties

Methods

\Zend_Filter
jump to top