Controller/Plugin/Broker.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Controller
subpackage: Plugins
version: $Id: Broker.php 20255 2010-01-13 13:23:36Z matthew $
Classes: Zend_Controller_Plugin_Broker

Description

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.

Zend_Controller_Plugin_Broker
jump to top

Extends from: Zend_Controller_Plugin_Abstract
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Controller
subpackage: Plugins
Properties: $_plugins
Methods: registerPlugin; unregisterPlugin; hasPlugin; getPlugin; getPlugins; setRequest; getRequest; setResponse; getResponse; routeStartup; routeShutdown; dispatchLoopStartup; preDispatch; postDispatch; dispatchLoopShutdown

Description

Properties

$_plugins
jump to class

array $_plugins = 'array'

Array of instance of objects extending Zend_Controller_Plugin_Abstract

Details

$_plugins: array
visibility: protected
default: array
final: false
static: false

Methods

dispatchLoopShutdown
jump to class

dispatchLoopShutdown(
          
          )
        
        :
        void

Called before Zend_Controller_Front exits its dispatch loop.

Details

visibility: public
final: false
static: false

dispatchLoopStartup
jump to class

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.

Arguments

$request: Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

getPlugin
jump to class

getPlugin(
          string $class
          )
        
        :
        false|Zend_Controller_Plugin_Abstract|array

Retrieve a plugin or plugins by class

Arguments

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

Output

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

Details

visibility: public
final: false
static: false

getPlugins
jump to class

getPlugins(
          
          )
        
        :
        array

Retrieve all plugins

Output

array

Details

visibility: public
final: false
static: false

getRequest
jump to class

getRequest(
          
          )
        
        :
        Zend_Controller_Request_Abstract

Get request object

Output

Zend_Controller_Request_Abstract: $request

Details

visibility: public
final: false
static: false

getResponse
jump to class

getResponse(
          
          )
        
        :
        Zend_Controller_Response_Abstract

Get response object

Output

Zend_Controller_Response_Abstract: $response

Details

visibility: public
final: false
static: false

hasPlugin
jump to class

hasPlugin(
          string $class
          )
        
        :
        bool

Is a plugin of a particular class registered?

Arguments

$class: string

Output

bool

Details

visibility: public
final: false
static: false

postDispatch
jump to class

postDispatch(
          Zend_Controller_Request_Abstract $request
          )
        
        :
        void

Called after an action is dispatched by Zend_Controller_Dispatcher.

Arguments

$request: Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

preDispatch
jump to class

preDispatch(
          Zend_Controller_Request_Abstract $request
          )
        
        :
        void

Called before an action is dispatched by Zend_Controller_Dispatcher.

Arguments

$request: Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

registerPlugin
jump to class

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

Arguments

$plugin: Zend_Controller_Plugin_Abstract
$stackIndex: int

Output

Zend_Controller_Plugin_Broker

Details

visibility: public
final: false
static: false

routeShutdown
jump to class

routeShutdown(
          Zend_Controller_Request_Abstract $request
          )
        
        :
        void

Called before Zend_Controller_Front exits its iterations over the route set.

Arguments

$request: Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

routeStartup
jump to class

routeStartup(
          Zend_Controller_Request_Abstract $request
          )
        
        :
        void

Called before Zend_Controller_Front begins evaluating the request against its routes.

Arguments

$request: Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

setRequest
jump to class

setRequest(
          Zend_Controller_Request_Abstract $request
          )
        
        :
        Zend_Controller_Plugin_Broker

Set request object, and register with each plugin

Arguments

$request: Zend_Controller_Request_Abstract

Output

Zend_Controller_Plugin_Broker

Details

visibility: public
final: false
static: false

setResponse
jump to class

setResponse(
          Zend_Controller_Response_Abstract $response
          )
        
        :
        Zend_Controller_Plugin_Broker

Set response object

Arguments

$response: Zend_Controller_Response_Abstract

Output

Zend_Controller_Plugin_Broker

Details

visibility: public
final: false
static: false

unregisterPlugin
jump to class

unregisterPlugin(
          string|Zend_Controller_Plugin_Abstract $plugin
          )
        
        :
        Zend_Controller_Plugin_Broker

Unregister a plugin.

Arguments

$plugin: stringZend_Controller_Plugin_Abstract
Plugin object or class name

Output

Zend_Controller_Plugin_Broker

Details

visibility: public
final: false
static: false

API Documentation

Controller/Plugin/Broker.php

Description

Zend_Controller_Plugin_Brokerjump to top

Description

Properties

$_pluginsjump to class

Details

Methods

dispatchLoopShutdownjump to class

Details

dispatchLoopStartupjump to class

Arguments

Details

getPluginjump to class

Arguments

Output

Details

getPluginsjump to class

Output

Details

getRequestjump to class

Output

Details

getResponsejump to class

Output

Details

hasPluginjump to class

Arguments

Output

Details

postDispatchjump to class

Arguments

Details

preDispatchjump to class

Arguments

Details

registerPluginjump to class

Arguments

Output

Details

routeShutdownjump to class

Arguments

Details

routeStartupjump to class

Arguments

Details

setRequestjump to class

Arguments

Output

Details

setResponsejump to class

Arguments

Output

Details

unregisterPluginjump to class

Arguments

Output

Details

Zend_Controller_Plugin_Broker
jump to top

$_plugins
jump to class

dispatchLoopShutdown
jump to class

dispatchLoopStartup
jump to class

getPlugin
jump to class

getPlugins
jump to class

getRequest
jump to class

getResponse
jump to class

hasPlugin
jump to class

postDispatch
jump to class

preDispatch
jump to class

registerPlugin
jump to class

routeShutdown
jump to class

routeStartup
jump to class

setRequest
jump to class

setResponse
jump to class

unregisterPlugin
jump to class