Zend Framework  1.12
Public Member Functions | Protected Attributes | List of all members
Zend_Controller_Plugin_Broker Class Reference

Public Member Functions

 registerPlugin (Zend_Controller_Plugin_Abstract $plugin, $stackIndex=null)
 Register a plugin.
 
 unregisterPlugin ($plugin)
 Unregister a plugin.
 
 hasPlugin ($class)
 Is a plugin of a particular class registered?
 
 getPlugin ($class)
 Retrieve a plugin or plugins by class.
 
 getPlugins ()
 Retrieve all plugins.
 
 setRequest (Zend_Controller_Request_Abstract $request)
 Set request object, and register with each plugin.
 
 getRequest ()
 Get request object.
 
 setResponse (Zend_Controller_Response_Abstract $response)
 Set response object.
 
 getResponse ()
 Get response object.
 
 routeStartup (Zend_Controller_Request_Abstract $request)
 Called before Zend_Controller_Front begins evaluating the request against its routes.
 
 routeShutdown (Zend_Controller_Request_Abstract $request)
 Called before Zend_Controller_Front exits its iterations over the route set.
 
 dispatchLoopStartup (Zend_Controller_Request_Abstract $request)
 Called before Zend_Controller_Front enters its dispatch loop.
 
 preDispatch (Zend_Controller_Request_Abstract $request)
 Called before an action is dispatched by Zend_Controller_Dispatcher.
 
 postDispatch (Zend_Controller_Request_Abstract $request)
 Called after an action is dispatched by Zend_Controller_Dispatcher.
 
 dispatchLoopShutdown ()
 Called before Zend_Controller_Front exits its dispatch loop.
 
- Public Member Functions inherited from Zend_Controller_Plugin_Abstract
 setRequest (Zend_Controller_Request_Abstract $request)
 Set request object.
 
 getRequest ()
 Get request object.
 
 setResponse (Zend_Controller_Response_Abstract $response)
 Set response object.
 
 getResponse ()
 Get response object.
 
 routeStartup (Zend_Controller_Request_Abstract $request)
 Called before Zend_Controller_Front begins evaluating the request against its routes.
 
 routeShutdown (Zend_Controller_Request_Abstract $request)
 Called after Zend_Controller_Router exits.
 
 dispatchLoopStartup (Zend_Controller_Request_Abstract $request)
 Called before Zend_Controller_Front enters its dispatch loop.
 
 preDispatch (Zend_Controller_Request_Abstract $request)
 Called before an action is dispatched by Zend_Controller_Dispatcher.
 
 postDispatch (Zend_Controller_Request_Abstract $request)
 Called after an action is dispatched by Zend_Controller_Dispatcher.
 
 dispatchLoopShutdown ()
 Called before Zend_Controller_Front exits its dispatch loop.
 

Protected Attributes

 $_plugins = array()
 
- Protected Attributes inherited from Zend_Controller_Plugin_Abstract
 $_request
 
 $_response
 

Member Function Documentation

dispatchLoopShutdown ( )

Called before Zend_Controller_Front exits its dispatch loop.

Parameters
Zend_Controller_Request_Abstract$request
Returns
void
dispatchLoopStartup ( Zend_Controller_Request_Abstract  $request)

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.

Parameters
Zend_Controller_Request_Abstract$request
Returns
void
getPlugin (   $class)

Retrieve a plugin or plugins by class.

Parameters
string$classClass name of plugin(s) desired
Returns
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 ( )

Retrieve all plugins.

Returns
array
getRequest ( )

Get request object.

Returns
Zend_Controller_Request_Abstract $request
getResponse ( )

Get response object.

Returns
Zend_Controller_Response_Abstract $response
hasPlugin (   $class)

Is a plugin of a particular class registered?

Parameters
string$class
Returns
bool
postDispatch ( Zend_Controller_Request_Abstract  $request)

Called after an action is dispatched by Zend_Controller_Dispatcher.

Parameters
Zend_Controller_Request_Abstract$request
Returns
void
preDispatch ( Zend_Controller_Request_Abstract  $request)

Called before an action is dispatched by Zend_Controller_Dispatcher.

Parameters
Zend_Controller_Request_Abstract$request
Returns
void
registerPlugin ( Zend_Controller_Plugin_Abstract  $plugin,
  $stackIndex = null 
)

Register a plugin.

Parameters
Zend_Controller_Plugin_Abstract$plugin
int$stackIndex
Returns
Zend_Controller_Plugin_Broker
routeShutdown ( Zend_Controller_Request_Abstract  $request)

Called before Zend_Controller_Front exits its iterations over the route set.

Parameters
Zend_Controller_Request_Abstract$request
Returns
void
routeStartup ( Zend_Controller_Request_Abstract  $request)

Called before Zend_Controller_Front begins evaluating the request against its routes.

Parameters
Zend_Controller_Request_Abstract$request
Returns
void
setRequest ( Zend_Controller_Request_Abstract  $request)

Set request object, and register with each plugin.

Parameters
Zend_Controller_Request_Abstract$request
Returns
Zend_Controller_Plugin_Broker
setResponse ( Zend_Controller_Response_Abstract  $response)

Set response object.

Parameters
Zend_Controller_Response_Abstract$response
Returns
Zend_Controller_Plugin_Broker
unregisterPlugin (   $plugin)

Unregister a plugin.

Parameters
string | Zend_Controller_Plugin_Abstract$pluginPlugin object or class name
Returns
Zend_Controller_Plugin_Broker

Member Data Documentation

$_plugins = array()
protected