Controller/Plugin/Broker.php
Show:
inherited
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 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_Controller
- Subpackage
- Plugins
- Version
- $Id$
\Zend_Controller_Plugin_Broker
Package: Zend_Controller\Plugins
- Parent(s)
- \Zend_Controller_Plugin_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array $_plugins = array()Array of instance of objects extending Zend_Controller_Plugin_Abstract
Default value
array()Details- Type
- array
Methods
dispatchLoopShutdown() : voidCalled before Zend_Controller_Front exits its dispatch loop.
dispatchLoopStartup(\Zend_Controller_Request_Abstract $request) : voidCalled 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.
Parameters| Name | Type | Description |
|---|---|---|
| $request | \Zend_Controller_Request_Abstract |
getPlugin(string $class) : false | \Zend_Controller_Plugin_Abstract | arrayRetrieve a plugin or plugins by class
Parameters
Returns
| 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 |
getPlugins() : arrayRetrieve all plugins
Returns
| Type | Description |
|---|---|
| array |
getRequest() : \Zend_Controller_Request_AbstractGet request object
Returns
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract | $request |
getResponse() : \Zend_Controller_Response_AbstractGet response object
Returns
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract | $response |
hasPlugin(string $class) : boolIs a plugin of a particular class registered?
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $class | string |
| Type | Description |
|---|---|
| bool |
postDispatch(\Zend_Controller_Request_Abstract $request) : voidCalled after an action is dispatched by Zend_Controller_Dispatcher.
Parameters
| Name | Type | Description |
|---|---|---|
| $request | \Zend_Controller_Request_Abstract |
preDispatch(\Zend_Controller_Request_Abstract $request) : voidCalled before an action is dispatched by Zend_Controller_Dispatcher.
Parameters
| Name | Type | Description |
|---|---|---|
| $request | \Zend_Controller_Request_Abstract |
registerPlugin(\Zend_Controller_Plugin_Abstract $plugin, int $stackIndex = null) : \Zend_Controller_Plugin_BrokerRegister a plugin.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $plugin | \Zend_Controller_Plugin_Abstract | |
| $stackIndex | int |
| Type | Description |
|---|---|
| \Zend_Controller_Plugin_Broker |
routeShutdown(\Zend_Controller_Request_Abstract $request) : voidCalled before Zend_Controller_Front exits its iterations over the route set.
Parameters
| Name | Type | Description |
|---|---|---|
| $request | \Zend_Controller_Request_Abstract |
routeStartup(\Zend_Controller_Request_Abstract $request) : voidCalled before Zend_Controller_Front begins evaluating the request against its routes.
Parameters
| Name | Type | Description |
|---|---|---|
| $request | \Zend_Controller_Request_Abstract |
setRequest(\Zend_Controller_Request_Abstract $request) : \Zend_Controller_Plugin_BrokerSet request object, and register with each plugin
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $request | \Zend_Controller_Request_Abstract |
| Type | Description |
|---|---|
| \Zend_Controller_Plugin_Broker |
setResponse(\Zend_Controller_Response_Abstract $response) : \Zend_Controller_Plugin_BrokerSet response object
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $response | \Zend_Controller_Response_Abstract |
| Type | Description |
|---|---|
| \Zend_Controller_Plugin_Broker |
unregisterPlugin(string | \Zend_Controller_Plugin_Abstract $plugin) : \Zend_Controller_Plugin_BrokerUnregister a plugin.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $plugin | string | \Zend_Controller_Plugin_Abstract | Plugin object or class name |
| Type | Description |
|---|---|
| \Zend_Controller_Plugin_Broker |