Controller/Plugin/Broker.php
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-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Controller
- Subpackage
- Plugins
- Version
- $Id: Broker.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Controller_Plugin_Broker
- Parent(s)
- \Zend_Controller_Plugin_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties


array $_plugins = array()
array()
Details- Type
- array


\Zend_Controller_Request_Abstract $_request


\Zend_Controller_Response_Abstract $_response
Methods


dispatchLoopStartup(\Zend_Controller_Request_Abstract $request) : void
Called before Zend_Controller_Front enters its dispatch loop.
During the dispatch loop, Zend_Controller_Front keeps a Zend_Controller_Request_Abstract object, and uses Zend_Controller_Dispatcher to dispatch the Zend_Controller_Request_Abstract object to controllers/actions.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |


getPlugin(string $class) : false | \Zend_Controller_Plugin_Abstract | array
Retrieve a plugin or plugins by class
Name | Type | Description |
---|---|---|
$class | string | Class name of plugin(s) desired |
Type | Description |
---|---|
false | \Zend_Controller_Plugin_Abstract | array | Returns false if none found, plugin if only one found, and array of plugins if multiple plugins of same class found |


getRequest() : \Zend_Controller_Request_Abstract
Get request object
Type | Description |
---|---|
\Zend_Controller_Request_Abstract | $request |


getResponse() : \Zend_Controller_Response_Abstract
Get response object
Type | Description |
---|---|
\Zend_Controller_Response_Abstract | $response |


hasPlugin(string $class) : bool
Is a plugin of a particular class registered?
Name | Type | Description |
---|---|---|
$class | string |
Type | Description |
---|---|
bool |


postDispatch(\Zend_Controller_Request_Abstract $request) : void
Called after an action is dispatched by Zend_Controller_Dispatcher.
This callback allows for proxy or filter behavior. By altering the request and resetting its dispatched flag (via setDispatched(false)), a new action may be specified for dispatching.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |


preDispatch(\Zend_Controller_Request_Abstract $request) : void
Called before an action is dispatched by Zend_Controller_Dispatcher.
This callback allows for proxy or filter behavior. By altering the request and resetting its dispatched flag (via setDispatched(false)), the current action may be skipped.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |


registerPlugin(\Zend_Controller_Plugin_Abstract $plugin, int $stackIndex = null) : \Zend_Controller_Plugin_Broker
Register a plugin.
Name | Type | Description |
---|---|---|
$plugin | \Zend_Controller_Plugin_Abstract | |
$stackIndex | int |
Type | Description |
---|---|
\Zend_Controller_Plugin_Broker |


routeShutdown(\Zend_Controller_Request_Abstract $request) : void
Called before Zend_Controller_Front exits its iterations over the route set.
Called after Zend_Controller_Front exits from the router.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |


routeStartup(\Zend_Controller_Request_Abstract $request) : void
Called before Zend_Controller_Front begins evaluating the request against its routes.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |


setRequest(\Zend_Controller_Request_Abstract $request) : \Zend_Controller_Plugin_Broker
Set request object, and register with each plugin
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |
Type | Description |
---|---|
\Zend_Controller_Plugin_Broker |


setResponse(\Zend_Controller_Response_Abstract $response) : \Zend_Controller_Plugin_Broker
Set response object
Name | Type | Description |
---|---|---|
$response | \Zend_Controller_Response_Abstract |
Type | Description |
---|---|
\Zend_Controller_Plugin_Broker |


unregisterPlugin(string | \Zend_Controller_Plugin_Abstract $plugin) : \Zend_Controller_Plugin_Broker
Unregister a plugin.
Name | Type | Description |
---|---|---|
$plugin | string | \Zend_Controller_Plugin_Abstract | Plugin object or class name |
Type | Description |
---|---|
\Zend_Controller_Plugin_Broker |