EventManager/FilterChain.php
inherited
Classes
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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_EventManager
\Zend_EventManager_FilterChain
FilterChain: intercepting filter manager
- Implements
- \Zend_EventManager_Filter
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
__construct() : voidConstructor
Initializes Zend_EventManager_Filter_FilterIterator in which filters will be aggregated
attach(callback $callback, int $priority = 1) : \Zend_Stdlib_CallbackHandlerConnect a filter to the chain
| Name | Type | Description |
|---|---|---|
| $callback | callback | PHP Callback |
| $priority | int | Priority in the queue at which to execute; defaults to 1 (higher numbers == higher priority) |
| Type | Description |
|---|---|
| \Zend_Stdlib_CallbackHandler | (to allow later unsubscribe) |
clearFilters() : voidClear all filters
detach(\Zend_Stdlib_CallbackHandler $filter) : boolDetach a filter from the chain
| Name | Type | Description |
|---|---|---|
| $filter | \Zend_Stdlib_CallbackHandler |
| Type | Description |
|---|---|
| bool | Returns true if filter found and unsubscribed; returns false otherwise |
getFilters() : \Zend_EventManager_Filter_FilterIteratorRetrieve all filters
| Type | Description |
|---|---|
| \Zend_EventManager_Filter_FilterIterator |
getResponses() : null | \Zend_EventManager_ResponseCollectionReturn current responses
Only available while the chain is still being iterated. Returns the current ResponseCollection.
| Type | Description |
|---|---|
| null | \Zend_EventManager_ResponseCollection |
run(mixed $context, mixed $argv = array()) : mixedApply the filters
Begins iteration of the filters.
| Name | Type | Description |
|---|---|---|
| $context | mixed | Object under observation |
| $argv | mixed | Associative array of arguments |
| Type | Description |
|---|---|
| mixed |