| category |
Zend |
| package |
Zend_Controller |
| subpackage |
Plugins |
| copyright |
Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
| license |
New BSD License |
| inherited_from |
\Zend_Controller_Plugin_Abstract |
Methods
Called before Zend_Controller_Front exits its dispatch loop.
dispatchLoopShutdown() : void
| inherited_from |
\Zend_Controller_Plugin_Abstract::dispatchLoopShutdown() |
Called before Zend_Controller_Front exits its dispatch loop.
dispatchLoopShutdown() : void
Inherited
Called before Zend_Controller_Front enters its dispatch loop.
dispatchLoopStartup(\Zend_Controller_Request_Abstract $request) : void
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.
| inherited_from |
\Zend_Controller_Plugin_Abstract::dispatchLoopStartup() |
Parameters
$request
\Zend_Controller_Request_Abstract
Called before Zend_Controller_Front enters its dispatch loop.
dispatchLoopStartup(\Zend_Controller_Request_Abstract $request) : void
Inherited
Parameters
$request
\Zend_Controller_Request_Abstract
Retrieve a plugin or plugins by class
getPlugin(string $class) : false | \Zend_Controller_Plugin_Abstract | array
Parameters
$class
stringClass name of plugin(s) desired
Returns
false\Zend_Controller_Plugin_AbstractarrayReturns false if none found, plugin if only one found, and array of plugins if multiple plugins of same class found
Retrieve all plugins
getPlugins() : array
Get request object
getRequest() : \Zend_Controller_Request_Abstract
| inherited_from |
\Zend_Controller_Plugin_Abstract::getRequest() |
Returns
\Zend_Controller_Request_Abstract$request
Get request object
getRequest() : \Zend_Controller_Request_Abstract
Inherited
Returns
\Zend_Controller_Request_Abstract$request
Get response object
getResponse() : \Zend_Controller_Response_Abstract
| inherited_from |
\Zend_Controller_Plugin_Abstract::getResponse() |
Returns
\Zend_Controller_Response_Abstract$response
Get response object
getResponse() : \Zend_Controller_Response_Abstract
Inherited
Returns
\Zend_Controller_Response_Abstract$response
Is a plugin of a particular class registered?
hasPlugin(string $class) : boolean
Parameters
$class
string
Returns
boolean
Called after an action is dispatched by Zend_Controller_Dispatcher.
postDispatch(\Zend_Controller_Request_Abstract $request) : void
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.
| inherited_from |
\Zend_Controller_Plugin_Abstract::postDispatch() |
Parameters
$request
\Zend_Controller_Request_Abstract
Called after an action is dispatched by Zend_Controller_Dispatcher.
postDispatch(\Zend_Controller_Request_Abstract $request) : void
Inherited
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.
Parameters
$request
\Zend_Controller_Request_Abstract
Called before an action is dispatched by Zend_Controller_Dispatcher.
preDispatch(\Zend_Controller_Request_Abstract $request) : void
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.
| inherited_from |
\Zend_Controller_Plugin_Abstract::preDispatch() |
Parameters
$request
\Zend_Controller_Request_Abstract
Called before an action is dispatched by Zend_Controller_Dispatcher.
preDispatch(\Zend_Controller_Request_Abstract $request) : void
Inherited
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.
Parameters
$request
\Zend_Controller_Request_Abstract
Register a plugin.
registerPlugin(\Zend_Controller_Plugin_Abstract $plugin, integer $stackIndex = null) : \Zend_Controller_Plugin_Broker
Parameters
$plugin
\Zend_Controller_Plugin_Abstract
$stackIndex
integer
Returns
\Zend_Controller_Plugin_Broker
Called before Zend_Controller_Front exits its iterations over
the route set.
routeShutdown(\Zend_Controller_Request_Abstract $request) : void
Called after Zend_Controller_Front exits from the router.
| inherited_from |
\Zend_Controller_Plugin_Abstract::routeShutdown() |
Parameters
$request
\Zend_Controller_Request_Abstract
Called after Zend_Controller_Router exits.
routeShutdown(\Zend_Controller_Request_Abstract $request) : void
Inherited
Called after Zend_Controller_Front exits from the router.
Parameters
$request
\Zend_Controller_Request_Abstract
Called before Zend_Controller_Front begins evaluating the
request against its routes.
routeStartup(\Zend_Controller_Request_Abstract $request) : void
| inherited_from |
\Zend_Controller_Plugin_Abstract::routeStartup() |
Parameters
$request
\Zend_Controller_Request_Abstract
Called before Zend_Controller_Front begins evaluating the
request against its routes.
routeStartup(\Zend_Controller_Request_Abstract $request) : void
Inherited
Parameters
$request
\Zend_Controller_Request_Abstract
Set request object, and register with each plugin
setRequest(\Zend_Controller_Request_Abstract $request) : \Zend_Controller_Plugin_Broker
| inherited_from |
\Zend_Controller_Plugin_Abstract::setRequest() |
Parameters
$request
\Zend_Controller_Request_Abstract
Returns
\Zend_Controller_Plugin_Broker
Set request object
setRequest(\Zend_Controller_Request_Abstract $request) : \Zend_Controller_Plugin_Abstract
Inherited
Parameters
$request
\Zend_Controller_Request_Abstract
Returns
\Zend_Controller_Plugin_Abstract
Set response object
setResponse(\Zend_Controller_Response_Abstract $response) : \Zend_Controller_Plugin_Broker
| inherited_from |
\Zend_Controller_Plugin_Abstract::setResponse() |
Parameters
$response
\Zend_Controller_Response_Abstract
Returns
\Zend_Controller_Plugin_Broker
Set response object
setResponse(\Zend_Controller_Response_Abstract $response) : \Zend_Controller_Plugin_Abstract
Inherited
Parameters
$response
\Zend_Controller_Response_Abstract
Returns
\Zend_Controller_Plugin_Abstract
Unregister a plugin.
unregisterPlugin(string|\Zend_Controller_Plugin_Abstract $plugin) : \Zend_Controller_Plugin_Broker
Parameters
$plugin
string\Zend_Controller_Plugin_AbstractPlugin object or class name
Returns
\Zend_Controller_Plugin_Broker
Properties
Array of instance of objects extending Zend_Controller_Plugin_Abstract
$_plugins : array
$_request
$_request : \Zend_Controller_Request_Abstract
$_response
$_response : \Zend_Controller_Response_Abstract