API Documentation

Zend/Controller/Plugin/ActionStack.php

Show: inherited
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

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
\Zend_Controller_Plugin_Abstract  
Version
$Id: ActionStack.php 24594 2012-01-05 21:27:01Z matthew $  

Properties

PropertyprotectedBool  $_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
Propertyprotected\Zend_Registry  $_registry= ''

Details
Type
\Zend_Registry
Propertyprotectedstring  $_registryKey= ''Zend_Controller_Plugin_ActionStack''

Registry key under which actions are stored

Default value'Zend_Controller_Plugin_ActionStack'Details
Type
string
Propertyprotectedarray  $_validKeys= 'array( 'module''

Valid keys for stack items

Default valuearray( 'module'Details
Type
array

Methods

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

Constructor

Parameters
Name Type Description
$registry \Zend_Registry
$key string
methodprotected_saveStack( array $stack ) : \Zend_Controller_Plugin_ActionStack

Save stack to registry

Parameters
Name Type Description
$stack array
Returns
Type Description
\Zend_Controller_Plugin_ActionStack
methodpublicforward( array $next ) : void

Forward request with next action

Parameters
Name Type Description
$next array
methodpublicgetClearRequestParams( ) : bool

Retrieve clearRequestParams flag

Returns
Type Description
bool
methodpublicgetRegistry( ) : \Zend_Registry

Retrieve registry object

Returns
Type Description
\Zend_Registry
methodpublicgetRegistryKey( ) : string

Retrieve registry key

Returns
Type Description
string
methodpublicgetStack( ) : array

Retrieve action stack

Returns
Type Description
array
methodpublicpopStack( ) : false|\Zend_Controller_Request_Abstract

Pop an item off the action stack

Returns
Type Description
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
Name Type Description
$request \Zend_Controller_Request_Abstract
methodpublicpushStack( \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
methodpublicsetClearRequestParams(  $clearRequestParams ) : \Zend_Controller_Plugin_ActionStack

Set clearRequestParams flag

@param bool $clearRequestParams

Parameters
Name Type Description
$clearRequestParams
Returns
Type Description
\Zend_Controller_Plugin_ActionStack
methodpublicsetRegistry( \Zend_Registry $registry ) : \Zend_Controller_Plugin_ActionStack

Set registry object

Parameters
Name Type Description
$registry \Zend_Registry
Returns
Type Description
\Zend_Controller_Plugin_ActionStack
methodpublicsetRegistryKey( string $key ) : \Zend_Controller_Plugin_ActionStack

Set registry key

Parameters
Name Type Description
$key string
Returns
Type Description
\Zend_Controller_Plugin_ActionStack
Documentation was generated by DocBlox 0.15.1.