Controller/Plugin/ActionStack.php

Show: PublicProtectedPrivateinherited
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 [email protected] so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
 
Version
$Id$  

Properties

>VPropertyprotectedBool $_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
>VPropertyprotected\Zend_Registry $_registry
Details
Type
\Zend_Registry
>VPropertyprotectedstring $_registryKey = 'Zend_Controller_Plugin_ActionStack'
Registry key under which actions are stored
Default value'Zend_Controller_Plugin_ActionStack'Details
Type
string
>VPropertyprotectedarray $_validKeys = array('module', 'controller', 'action', 'params')
Valid keys for stack items
Default valuearray('module', 'controller', 'action', 'params')Details
Type
array

Methods

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

Constructor

Parameters
NameTypeDescription
$registry\Zend_Registry
$keystring
methodprotected_saveStack(array $stack) : \Zend_Controller_Plugin_ActionStack

Save stack to registry

Parameters
NameTypeDescription
$stackarray
Returns
TypeDescription
\Zend_Controller_Plugin_ActionStack
methodpublicforward(array $next) : void

Forward request with next action

Parameters
NameTypeDescription
$nextarray
methodpublicgetClearRequestParams() : bool

Retrieve clearRequestParams flag

Returns
TypeDescription
bool
methodpublicgetRegistry() : \Zend_Registry

Retrieve registry object

Returns
TypeDescription
\Zend_Registry
methodpublicgetRegistryKey() : string

Retrieve registry key

Returns
TypeDescription
string
methodpublicgetStack() : array

Retrieve action stack

Returns
TypeDescription
array
methodpublicpopStack() : false | \Zend_Controller_Request_Abstract

Pop an item off the action stack

Returns
TypeDescription
false | \Zend_Controller_Request_Abstract
methodpublicpostDispatch(\Zend_Controller_Request_Abstract $request) : void

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

Parameters
NameTypeDescription
$request\Zend_Controller_Request_Abstract
methodpublicpushStack(\Zend_Controller_Request_Abstract $next) : \Zend_Controller_Plugin_ActionStack

Push an item onto the stack

Parameters
NameTypeDescription
$next\Zend_Controller_Request_Abstract
Returns
TypeDescription
\Zend_Controller_Plugin_ActionStack
methodpublicsetClearRequestParams( $clearRequestParams) : \Zend_Controller_Plugin_ActionStack

Set clearRequestParams flag

@param bool $clearRequestParams
Parameters
NameTypeDescription
$clearRequestParams
Returns
TypeDescription
\Zend_Controller_Plugin_ActionStack
methodpublicsetRegistry(\Zend_Registry $registry) : \Zend_Controller_Plugin_ActionStack

Set registry object

Parameters
NameTypeDescription
$registry\Zend_Registry
Returns
TypeDescription
\Zend_Controller_Plugin_ActionStack
methodpublicsetRegistryKey(string $key) : \Zend_Controller_Plugin_ActionStack

Set registry key

Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
\Zend_Controller_Plugin_ActionStack
Documentation was generated by phpDocumentor 2.2.0 .