FilterChain: intercepting filter manager

category Zend
package Zend_EventManager
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Constructor

__construct() : void

Initializes Zend_EventManager_Filter_FilterIterator in which filters will be aggregated

Connect a filter to the chain

attach(callback $callback, integer $priority = 1) : \Zend_Stdlib_CallbackHandler
inherited_from \Zend_EventManager_Filter::attach()

Parameters

$callback

callback

PHP Callback

$priority

integer

Priority in the queue at which to execute; defaults to 1 (higher numbers == higher priority)

Exceptions

\Zend_Stdlib_Exception_InvalidCallbackException

Returns

\Zend_Stdlib_CallbackHandler(to allow later unsubscribe)

Clear all filters

clearFilters() : void
inherited_from \Zend_EventManager_Filter::clearFilters()

Detach a filter from the chain

detach(\Zend_Stdlib_CallbackHandler $filter) : boolean
inherited_from \Zend_EventManager_Filter::detach()

Parameters

$filter

\Zend_Stdlib_CallbackHandler

Returns

booleanReturns true if filter found and unsubscribed; returns false otherwise

Retrieve all filters

getFilters() : \Zend_EventManager_Filter_FilterIterator
inherited_from \Zend_EventManager_Filter::getFilters()

Returns

\Zend_EventManager_Filter_FilterIterator

Return current responses

getResponses() : null | \Zend_EventManager_ResponseCollection

Only available while the chain is still being iterated. Returns the current ResponseCollection.

inherited_from \Zend_EventManager_Filter::getResponses()

Returns

null\Zend_EventManager_ResponseCollection

Apply the filters

run(mixed $context, mixed $argv = array()) : mixed

Begins iteration of the filters.

inherited_from \Zend_EventManager_Filter::run()

Parameters

$context

mixed

Object under observation

$argv

mixed

Associative array of arguments

Returns

mixed

 Properties

 

All filters

$filters : \Zend_EventManager_Filter_FilterIterator

Default