Controller/Plugin/ActionStack.php

Show:

inherited

Classes
- \Zend_Controller_Plugin_ActionStack

Table of Contents

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.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Controller
Subpackage: Plugins

\Zend_Controller_Plugin_ActionStack
jump to top

Package: Zend\Controller\Plugins

Manage a stack of actions

Parent(s): \Zend_Controller_Plugin_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Uses: \global\Zend_Controller_Plugin_Abstract
Version: $Id: ActionStack.php 24593 2012-01-05 20:35:02Z matthew $

Properties

Bool $_clearRequestParams = false

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

Default valuefalseDetails

Type: Bool

\Zend_Registry $_registry

Details

Type: \Zend_Registry

string $_registryKey = 'Zend_Controller_Plugin_ActionStack'

Registry key under which actions are stored

Default value'Zend_Controller_Plugin_ActionStack'Details

Type: string

\Zend_Controller_Request_Abstract $_request

inherited

Inherited from: \Zend_Controller_Plugin_Abstract::$$_request

Details

Type: \Zend_Controller_Request_Abstract
Inherited_from: \Zend_Controller_Plugin_Abstract::$$_request

\Zend_Controller_Response_Abstract $_response

inherited

Inherited from: \Zend_Controller_Plugin_Abstract::$$_response

Details

Type: \Zend_Controller_Response_Abstract
Inherited_from: \Zend_Controller_Plugin_Abstract::$$_response

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

Valid keys for stack items

Default valuearray('module', 'controller', 'action', 'params')Details

Type: array

Methods

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

Constructor

Parameters

Name	Type	Description
$registry	\Zend_Registry
$key	string

_saveStack(array $stack) : \Zend_Controller_Plugin_ActionStack

Save stack to registry

Parameters

Name	Type	Description
$stack	array

Returns

Type	Description
\Zend_Controller_Plugin_ActionStack

dispatchLoopShutdown() : void

inherited

Called before Zend_Controller_Front exits its dispatch loop.

Inherited from: \Zend_Controller_Plugin_Abstract::dispatchLoopShutdown()

dispatchLoopStartup(\Zend_Controller_Request_Abstract $request) : void

inherited

Called before Zend_Controller_Front enters its dispatch loop.

Inherited from: \Zend_Controller_Plugin_Abstract::dispatchLoopStartup()

Parameters

Name	Type	Description
$request	\Zend_Controller_Request_Abstract

forward(array $next) : void

Forward request with next action

Parameters

Name	Type	Description
$next	array

getClearRequestParams() : bool

Retrieve clearRequestParams flag

Returns

Type	Description
bool

getRegistry() : \Zend_Registry

Retrieve registry object

Returns

Type	Description
\Zend_Registry

getRegistryKey() : string

Retrieve registry key

Returns

Type	Description
string

getRequest() : \Zend_Controller_Request_Abstract

inherited

Get request object

Inherited from: \Zend_Controller_Plugin_Abstract::getRequest()

Returns

Type	Description
\Zend_Controller_Request_Abstract	$request

getResponse() : \Zend_Controller_Response_Abstract

inherited

Get response object

Inherited from: \Zend_Controller_Plugin_Abstract::getResponse()

Returns

Type	Description
\Zend_Controller_Response_Abstract	$response

getStack() : array

Retrieve action stack

Returns

Type	Description
array

popStack() : false | \Zend_Controller_Request_Abstract

Pop an item off the action stack

Returns

Type	Description
false \| \Zend_Controller_Request_Abstract

postDispatch(\Zend_Controller_Request_Abstract $request) : void

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

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

Name	Type	Description
$request	\Zend_Controller_Request_Abstract

preDispatch(\Zend_Controller_Request_Abstract $request) : void

inherited

Called before an action is dispatched by Zend_Controller_Dispatcher.

Inherited from: \Zend_Controller_Plugin_Abstract::preDispatch()

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

Name	Type	Description
$request	\Zend_Controller_Request_Abstract

pushStack(\Zend_Controller_Request_Abstract $next) : \Zend_Controller_Plugin_ActionStack

Push an item onto the stack

Parameters

Name	Type	Description
$next	\Zend_Controller_Request_Abstract

Returns

Type	Description
\Zend_Controller_Plugin_ActionStack

routeShutdown(\Zend_Controller_Request_Abstract $request) : void

inherited

Called after Zend_Controller_Router exits.

Inherited from: \Zend_Controller_Plugin_Abstract::routeShutdown()

Called after Zend_Controller_Front exits from the router.

Parameters

Name	Type	Description
$request	\Zend_Controller_Request_Abstract

routeStartup(\Zend_Controller_Request_Abstract $request) : void

inherited

Called before Zend_Controller_Front begins evaluating the request against its routes.

Inherited from: \Zend_Controller_Plugin_Abstract::routeStartup()

Parameters

Name	Type	Description
$request	\Zend_Controller_Request_Abstract

setClearRequestParams( $clearRequestParams) : \Zend_Controller_Plugin_ActionStack

Set clearRequestParams flag

@param bool $clearRequestParams

Parameters

Name	Type	Description
$clearRequestParams

Returns

Type	Description
\Zend_Controller_Plugin_ActionStack

setRegistry(\Zend_Registry $registry) : \Zend_Controller_Plugin_ActionStack

Set registry object

Parameters

Name	Type	Description
$registry	\Zend_Registry

Returns

Type	Description
\Zend_Controller_Plugin_ActionStack

setRegistryKey(string $key) : \Zend_Controller_Plugin_ActionStack

Set registry key

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
\Zend_Controller_Plugin_ActionStack

setRequest(\Zend_Controller_Request_Abstract $request) : \Zend_Controller_Plugin_Abstract

inherited

Set request object

Inherited from: \Zend_Controller_Plugin_Abstract::setRequest()

Parameters

Name	Type	Description
$request	\Zend_Controller_Request_Abstract

Returns

Type	Description
\Zend_Controller_Plugin_Abstract

setResponse(\Zend_Controller_Response_Abstract $response) : \Zend_Controller_Plugin_Abstract

inherited

Set response object

Inherited from: \Zend_Controller_Plugin_Abstract::setResponse()

Parameters

Name	Type	Description
$response	\Zend_Controller_Response_Abstract

Returns

Type	Description
\Zend_Controller_Plugin_Abstract

Controller/Plugin/ActionStack.php

\Zend_Controller_Plugin_ActionStackjump to top

Properties

Methods

\Zend_Controller_Plugin_ActionStack
jump to top