Zend_Filter Class Reference

Inheritance diagram for Zend_Filter:

Public Member Functions
	addFilter (Zend_Filter_Interface $filter, $placement=self::CHAIN_APPEND)
	appendFilter (Zend_Filter_Interface $filter)
	prependFilter (Zend_Filter_Interface $filter)
	getFilters ()
	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())

Data Fields
const	CHAIN_APPEND = 'append'
const	CHAIN_PREPEND = 'prepend'

Protected Attributes
	$_filters = array()

Static Protected Attributes
static	$_defaultNamespaces = array()

Detailed Description

Definition at line 33 of file Filter.php.

Member Function Documentation

addDefaultNamespaces()

static addDefaultNamespaces (   $namespace )

static

Adds a new default namespace

Parameters

array | string

$namespace

Returns

null

Definition at line 150 of file Filter.php.

    {
        if (!is_array($namespace)) {
            $namespace = array((string) $namespace);
        }

        self::$_defaultNamespaces = array_unique(array_merge(self::$_defaultNamespaces, $namespace));
    }

addFilter()

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

Adds a filter to the chain

Parameters

Zend_Filter_Interface	$filter
string	$placement

Returns

Zend_Filter Provides a fluent interface

Definition at line 60 of file Filter.php.

    {
        if ($placement == self::CHAIN_PREPEND) {
            array_unshift($this->_filters, $filter);
        } else {
            $this->_filters[] = $filter;
        }
        return $this;
    }

appendFilter()

appendFilter

(

Zend_Filter_Interface

$filter

)

Add a filter to the end of the chain

Parameters

Zend_Filter_Interface

$filter

Returns

Zend_Filter Provides a fluent interface

Definition at line 76 of file Filter.php.

    {
        return $this->addFilter($filter, self::CHAIN_APPEND);
    }

filter()

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

Implements Zend_Filter_Interface.

Definition at line 110 of file Filter.php.

    {
        $valueFiltered = $value;
        foreach ($this->_filters as $filter) {
            $valueFiltered = $filter->filter($valueFiltered);
        }
        return $valueFiltered;
    }

filterStatic()

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	$args	OPTIONAL
array | string	$namespaces	OPTIONAL

Returns

mixed

Exceptions

Zend_Filter_Exception

Definition at line 207 of file Filter.php.

    {
        #require_once 'Zend/Loader.php';
        $namespaces = array_merge((array) $namespaces, self::$_defaultNamespaces, array('Zend_Filter'));
        foreach ($namespaces as $namespace) {
            $className = $namespace . '_' . ucfirst($classBaseName);
            if (!class_exists($className, false)) {
                try {
                    $file = str_replace('_', DIRECTORY_SEPARATOR, $className) . '.php';
                    if (Zend_Loader::isReadable($file)) {
                        Zend_Loader::loadClass($className);
                    } else {
                        continue;
                    }
                } catch (Zend_Exception $ze) {
                    continue;
                }
            }

            $class = new ReflectionClass($className);
            if ($class->implementsInterface('Zend_Filter_Interface')) {
                if ($class->hasMethod('__construct')) {
                    $object = $class->newInstanceArgs($args);
                } else {
                    $object = $class->newInstance();
                }
                return $object->filter($value);
            }
        }
        #require_once 'Zend/Filter/Exception.php';
        throw new Zend_Filter_Exception("Filter class not found from basename '$classBaseName'");
    }

get()

static get (   $value,   $classBaseName, array  $args = array(),   $namespaces = array()  )

static

Deprecated:

See also

Zend_Filter::filterStatic()

Parameters

mixed	$value
string	$classBaseName
array	$args	OPTIONAL
array | string	$namespaces	OPTIONAL

Returns

mixed

Exceptions

Zend_Filter_Exception

Definition at line 180 of file Filter.php.

    {
        trigger_error(
            'Zend_Filter::get() is deprecated as of 1.9.0; please update your code to utilize Zend_Filter::filterStatic()',
            E_USER_NOTICE
        );

        return self::filterStatic($value, $classBaseName, $args, $namespaces);
    }

getDefaultNamespaces()

static getDefaultNamespaces ( )

static

Returns the set default namespaces

Returns

array

Definition at line 124 of file Filter.php.

    {
        return self::$_defaultNamespaces;
    }

getFilters()

getFilters

(

)

Get all the filters

Returns

array

Definition at line 97 of file Filter.php.

    {
        return $this->_filters;
    }

hasDefaultNamespaces()

static hasDefaultNamespaces ( )

static

Returns true when defaultNamespaces are set

Returns

boolean

Definition at line 164 of file Filter.php.

    {
        return (!empty(self::$_defaultNamespaces));
    }

prependFilter()

prependFilter

(

Zend_Filter_Interface

$filter

)

Add a filter to the start of the chain

Parameters

Zend_Filter_Interface

$filter

Returns

Zend_Filter Provides a fluent interface

Definition at line 87 of file Filter.php.

    {
        return $this->addFilter($filter, self::CHAIN_PREPEND);
    }

setDefaultNamespaces()

static setDefaultNamespaces (   $namespace )

static

Sets new default namespaces

Parameters

array | string

$namespace

Returns

null

Definition at line 135 of file Filter.php.

    {
        if (!is_array($namespace)) {
            $namespace = array((string) $namespace);
        }

        self::$_defaultNamespaces = $namespace;
    }

Field Documentation

$_defaultNamespaces

$_defaultNamespaces = array()

staticprotected

Definition at line 51 of file Filter.php.

$_filters

$_filters = array()

protected

Definition at line 44 of file Filter.php.

CHAIN_APPEND

const CHAIN_APPEND = 'append'

Definition at line 36 of file Filter.php.

CHAIN_PREPEND

const CHAIN_PREPEND = 'prepend'

Definition at line 37 of file Filter.php.

---

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

• vendor/magento/zendframework1/library/Zend/Filter.php