Docs For Class Zend_Controller_Plugin

Description

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /Controller/Plugin/Broker.php (line 33)

Zend_Controller_Plugin_Abstract
   |
   --Zend_Controller_Plugin_Broker

Variable Summary

array $_plugins

Method Summary

void dispatchLoopShutdown (Zend_Controller_Request_Abstract $request)

void dispatchLoopStartup (Zend_Controller_Request_Abstract $request)

false|Zend_Controller_Plugin_Abstract|array getPlugin (string $class)

array getPlugins ()

Zend_Controller_Request_Abstract getRequest ()

Zend_Controller_Response_Abstract getResponse ()

bool hasPlugin (string $class)

void postDispatch (Zend_Controller_Request_Abstract $request)

void preDispatch (Zend_Controller_Request_Abstract $request)

Zend_Controller_Plugin_Broker registerPlugin (Zend_Controller_Plugin_Abstract $plugin, [int $stackIndex = null])

void routeShutdown (Zend_Controller_Request_Abstract $request)

void routeStartup (Zend_Controller_Request_Abstract $request)

Zend_Controller_Plugin_Broker setRequest (Zend_Controller_Request_Abstract $request)

Zend_Controller_Plugin_Broker setResponse (Zend_Controller_Response_Abstract $response)

Zend_Controller_Plugin_Broker unregisterPlugin (string|Zend_Controller_Plugin_Abstract $plugin)

Variables

array $_plugins = array() (line 41)

Array of instance of objects extending Zend_Controller_Plugin_Abstract

access: protected

Inherited Variables

Inherited from Zend_Controller_Plugin_Abstract

Zend_Controller_Plugin_Abstract::$_request
Zend_Controller_Plugin_Abstract::$_response

Methods

dispatchLoopShutdown (line 349)

Called before Zend_Controller_Front exits its dispatch loop.

access: public

void dispatchLoopShutdown (Zend_Controller_Request_Abstract $request)

Zend_Controller_Request_Abstract $request

Redefinition of:

Zend_Controller_Plugin_Abstract::dispatchLoopShutdown(): Called before Zend_Controller_Front exits its dispatch loop.

dispatchLoopStartup (line 283)

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.

access: public

void dispatchLoopStartup (Zend_Controller_Request_Abstract $request)

Zend_Controller_Request_Abstract $request

Redefinition of:

Zend_Controller_Plugin_Abstract::dispatchLoopStartup(): Called before Zend_Controller_Front enters its dispatch loop.

getPlugin (line 140)

Retrieve a plugin or plugins by class

return: Returns false if none found, plugin if only one found, and array of plugins if multiple plugins of same class found
access: public

false|Zend_Controller_Plugin_Abstract|array getPlugin (string $class)

string $class: Class name of plugin(s) desired

getPlugins (line 165)

Retrieve all plugins

access: public

array getPlugins ()

getRequest (line 192)

Get request object

access: public

Zend_Controller_Request_Abstract getRequest ()

Redefinition of:

Zend_Controller_Plugin_Abstract::getRequest(): Get request object

getResponse (line 220)

Get response object

access: public

Zend_Controller_Response_Abstract getResponse ()

Redefinition of:

Zend_Controller_Plugin_Abstract::getResponse(): Get response object

hasPlugin (line 122)

Is a plugin of a particular class registered?

access: public

bool hasPlugin (string $class)

string $class

postDispatch (line 327)

Called after an action is dispatched by Zend_Controller_Dispatcher.

access: public

void postDispatch (Zend_Controller_Request_Abstract $request)

Zend_Controller_Request_Abstract $request

Redefinition of:

Zend_Controller_Plugin_Abstract::postDispatch(): Called after an action is dispatched by Zend_Controller_Dispatcher.

preDispatch (line 305)

Called before an action is dispatched by Zend_Controller_Dispatcher.

access: public

void preDispatch (Zend_Controller_Request_Abstract $request)

Zend_Controller_Request_Abstract $request

Redefinition of:

Zend_Controller_Plugin_Abstract::preDispatch(): Called before an action is dispatched by Zend_Controller_Dispatcher.

registerPlugin (line 51)

Register a plugin.

access: public

Zend_Controller_Plugin_Broker registerPlugin (Zend_Controller_Plugin_Abstract $plugin, [int $stackIndex = null])

Zend_Controller_Plugin_Abstract $plugin
int $stackIndex

routeShutdown (line 256)

Called before Zend_Controller_Front exits its iterations over the route set.

access: public

void routeShutdown (Zend_Controller_Request_Abstract $request)

Zend_Controller_Request_Abstract $request

Redefinition of:

Zend_Controller_Plugin_Abstract::routeShutdown(): Called after Zend_Controller_Router exits.

routeStartup (line 233)

Called before Zend_Controller_Front begins evaluating the request against its routes.

access: public

void routeStartup (Zend_Controller_Request_Abstract $request)

Zend_Controller_Request_Abstract $request

Redefinition of:

Zend_Controller_Plugin_Abstract::routeStartup(): Called before Zend_Controller_Front begins evaluating the request against its routes.

setRequest (line 176)

Set request object, and register with each plugin

access: public

Zend_Controller_Plugin_Broker setRequest (Zend_Controller_Request_Abstract $request)

Zend_Controller_Request_Abstract $request

Redefinition of:

Zend_Controller_Plugin_Abstract::setRequest(): Set request object

setResponse (line 203)

Set response object

access: public

Zend_Controller_Plugin_Broker setResponse (Zend_Controller_Response_Abstract $response)

Zend_Controller_Response_Abstract $response

Redefinition of:

Zend_Controller_Plugin_Abstract::setResponse(): Set response object

unregisterPlugin (line 94)

Unregister a plugin.

access: public

Zend_Controller_Plugin_Broker unregisterPlugin (string|Zend_Controller_Plugin_Abstract $plugin)

string|Zend_Controller_Plugin_Abstract $plugin: Plugin object or class name

Inherited Methods

Inherited From Zend_Controller_Plugin_Abstract

Zend_Controller_Plugin_Abstract::dispatchLoopShutdown()
Zend_Controller_Plugin_Abstract::dispatchLoopStartup()
Zend_Controller_Plugin_Abstract::getRequest()
Zend_Controller_Plugin_Abstract::getResponse()
Zend_Controller_Plugin_Abstract::postDispatch()
Zend_Controller_Plugin_Abstract::preDispatch()
Zend_Controller_Plugin_Abstract::routeShutdown()
Zend_Controller_Plugin_Abstract::routeStartup()
Zend_Controller_Plugin_Abstract::setRequest()
Zend_Controller_Plugin_Abstract::setResponse()