Docs For Class Zend_Controller_Plugin

Description

Manage a stack of actions

version: $Id: ActionStack.php 20096 2010-01-06 02:05:09Z bkarwin $
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
uses: Zend_Controller_Plugin_Abstract
license: New BSD License

Located in /Controller/Plugin/ActionStack.php (line 39)

Zend_Controller_Plugin_Abstract
   |
   --Zend_Controller_Plugin_ActionStack

Variable Summary

Bool $_clearRequestParams

Zend_Registry $_registry

string $_registryKey

array $_validKeys

Method Summary

void __construct ([ $registry = null], [string $key = null])

void forward (Zend_Controller_Request_Abstract $next)

bool getClearRequestParams ()

Zend_Registry getRegistry ()

string getRegistryKey ()

array getStack ()

false|Zend_Controller_Request_Abstract popStack ()

void postDispatch (Zend_Controller_Request_Abstract $request)

Zend_Controller_Plugin_ActionStack pushStack (Zend_Controller_Request_Abstract $next)

Zend_Controller_Plugin_ActionStack setClearRequestParams (bool $clearRequestParams)

Zend_Controller_Plugin_ActionStack setRegistry ( $registry)

Zend_Controller_Plugin_ActionStack setRegistryKey (string $key)

Zend_Controller_Plugin_ActionStack _saveStack ( $stack)

Variables

Bool $_clearRequestParams = false (line 67)

Flag to determine whether request parameters are cleared between actions, or whether new parameters are added to existing request parameters.

access: protected

Zend_Registry $_registry (line 42)

access: protected

string $_registryKey = 'Zend_Controller_Plugin_ActionStack' (line 48)

Registry key under which actions are stored

access: protected

array $_validKeys = array(
'module',
'controller',
'action',
'params'
) (line 54)

Valid keys for stack items

access: protected

Inherited Variables

Inherited from Zend_Controller_Plugin_Abstract

Zend_Controller_Plugin_Abstract::$_request
Zend_Controller_Plugin_Abstract::$_response

Methods

Constructor __construct (line 76)

Constructor

access: public

void __construct ([ $registry = null], [string $key = null])

Zend_Registry $registry
string $key

forward (line 267)

Forward request with next action

access: public

void forward (Zend_Controller_Request_Abstract $next)

array $next

getClearRequestParams (line 153)

Retrieve clearRequestParams flag

access: public

bool getClearRequestParams ()

getRegistry (line 109)

Retrieve registry object

access: public

Zend_Registry getRegistry ()

getRegistryKey (line 119)

Retrieve registry key

access: public

string getRegistryKey ()

getStack (line 163)

Retrieve action stack

access: public

array getStack ()

popStack (line 201)

Pop an item off the action stack

access: public

false|Zend_Controller_Request_Abstract popStack ()

postDispatch (line 240)

postDispatch() plugin hook -- check for actions in stack, and dispatch if any found

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.

pushStack (line 189)

Push an item onto the stack

access: public

Zend_Controller_Plugin_ActionStack pushStack (Zend_Controller_Request_Abstract $next)

Zend_Controller_Request_Abstract $next

setClearRequestParams (line 142)

Set clearRequestParams flag

access: public

Zend_Controller_Plugin_ActionStack setClearRequestParams (bool $clearRequestParams)

bool $clearRequestParams

setRegistry (line 98)

Set registry object

access: public

Zend_Controller_Plugin_ActionStack setRegistry ( $registry)

Zend_Registry $registry

setRegistryKey (line 130)

Set registry key

access: public

Zend_Controller_Plugin_ActionStack setRegistryKey (string $key)

string $key

_saveStack (line 176)

Save stack to registry

access: protected

Zend_Controller_Plugin_ActionStack _saveStack ( $stack)

array $stack

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()