Manage a stack of actions

uses
category Zend
package Zend_Controller
subpackage Plugins
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
version $Id$
inherited_from \Zend_Controller_Plugin_Abstract

 Methods

Constructor

__construct(\Zend_Registry $registry = null, string $key = null) : void

Parameters

$registry

\Zend_Registry

$key

string

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
Inherited

Parameters

$request

\Zend_Controller_Request_Abstract

Forward request with next action

forward(array $next) : void

Parameters

$next

array

Retrieve clearRequestParams flag

getClearRequestParams() : boolean

Returns

boolean

Retrieve registry object

getRegistry() : \Zend_Registry

Returns

\Zend_Registry

Retrieve registry key

getRegistryKey() : string

Returns

string

Get request object

getRequest() : \Zend_Controller_Request_Abstract
Inherited

Returns

\Zend_Controller_Request_Abstract$request

Get response object

getResponse() : \Zend_Controller_Response_Abstract
Inherited

Returns

\Zend_Controller_Response_Abstract$response

Retrieve action stack

getStack() : array

Returns

array

Pop an item off the action stack

popStack() : false | \Zend_Controller_Request_Abstract

Returns

false\Zend_Controller_Request_Abstract

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

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

Push an item onto the stack

pushStack(\Zend_Controller_Request_Abstract $next) : \Zend_Controller_Plugin_ActionStack

Parameters

$next

\Zend_Controller_Request_Abstract

Returns

\Zend_Controller_Plugin_ActionStack

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

Parameters

$request

\Zend_Controller_Request_Abstract

Set clearRequestParams flag

setClearRequestParams($clearRequestParams) : \Zend_Controller_Plugin_ActionStack

@param bool $clearRequestParams

Parameters

$clearRequestParams

Returns

\Zend_Controller_Plugin_ActionStack

Set registry object

setRegistry(\Zend_Registry $registry) : \Zend_Controller_Plugin_ActionStack

Parameters

$registry

\Zend_Registry

Returns

\Zend_Controller_Plugin_ActionStack

Set registry key

setRegistryKey(string $key) : \Zend_Controller_Plugin_ActionStack

Parameters

$key

string

Returns

\Zend_Controller_Plugin_ActionStack

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_Abstract
Inherited

Parameters

$response

\Zend_Controller_Response_Abstract

Returns

\Zend_Controller_Plugin_Abstract

Save stack to registry

_saveStack(array $stack) : \Zend_Controller_Plugin_ActionStack

Parameters

$stack

array

Returns

\Zend_Controller_Plugin_ActionStack

 Properties

 

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

$_clearRequestParams : Bool

Default

false
 

$_registry

$_registry : \Zend_Registry

Default

 

Registry key under which actions are stored

$_registryKey : string

Default

'Zend_Controller_Plugin_ActionStack'
 

$_request

$_request : \Zend_Controller_Request_Abstract

Default

 

$_response

$_response : \Zend_Controller_Response_Abstract

Default

 

Valid keys for stack items

$_validKeys : array

Default

array('module', 'controller', 'action', 'params')