Controller/Plugin/ActionStack.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Controller
subpackage: Plugins
Classes: Zend_Controller_Plugin_ActionStack

Description

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.

Zend_Controller_Plugin_ActionStack
jump to top

Extends from: Zend_Controller_Plugin_Abstract
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Controller
subpackage: Plugins
uses: Zend_Controller_Plugin_Abstract
version: $Id: ActionStack.php 20096 2010-01-06 02:05:09Z bkarwin $
Properties: $_registry; $_registryKey; $_validKeys; $_clearRequestParams
Methods: __construct; setRegistry; getRegistry; getRegistryKey; setRegistryKey; setClearRequestParams; getClearRequestParams; getStack; _saveStack; pushStack; popStack; postDispatch; forward

Description

Manage a stack of actions

Properties

$_clearRequestParams
jump to class

Bool $_clearRequestParams = 'false'

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

Details

$_clearRequestParams: Bool
visibility: protected
default: false
final: false
static: false

$_registry
jump to class

Zend_Registry $_registry = ''

Details

$_registry: Zend_Registry
visibility: protected
default
final: false
static: false

$_registryKey
jump to class

string $_registryKey = 'Zend_Controller_Plugin_ActionStack'

Registry key under which actions are stored

Details

$_registryKey: string
visibility: protected
default: Zend_Controller_Plugin_ActionStack
final: false
static: false

$_validKeys
jump to class

array $_validKeys = 'array'

Valid keys for stack items

Details

$_validKeys: array
visibility: protected
default: array
final: false
static: false

Methods

__construct
jump to class

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

Constructor

Arguments

$registry: Zend_Registry
$key: string

Details

visibility: public
final: false
static: false

_saveStack
jump to class

_saveStack(
          array $stack
          )
        
        :
        Zend_Controller_Plugin_ActionStack

Save stack to registry

Arguments

$stack: array

Output

Zend_Controller_Plugin_ActionStack

Details

visibility: protected
final: false
static: false

forward
jump to class

forward(
          array $next
          )
        
        :
        void

Forward request with next action

Arguments

$next: array

Details

visibility: public
final: false
static: false

getClearRequestParams
jump to class

getClearRequestParams(
          
          )
        
        :
        bool

Retrieve clearRequestParams flag

Output

bool

Details

visibility: public
final: false
static: false

getRegistry
jump to class

getRegistry(
          
          )
        
        :
        Zend_Registry

Retrieve registry object

Output

Zend_Registry

Details

visibility: public
final: false
static: false

getRegistryKey
jump to class

getRegistryKey(
          
          )
        
        :
        string

Retrieve registry key

Output

string

Details

visibility: public
final: false
static: false

getStack
jump to class

getStack(
          
          )
        
        :
        array

Retrieve action stack

Output

array

Details

visibility: public
final: false
static: false

popStack
jump to class

popStack(
          
          )
        
        :
        false|Zend_Controller_Request_Abstract

Pop an item off the action stack

Output

false|Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

postDispatch
jump to class

postDispatch(
          Zend_Controller_Request_Abstract $request
          )
        
        :
        void

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

Arguments

$request: Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

pushStack
jump to class

pushStack(
          Zend_Controller_Request_Abstract $next
          )
        
        :
        Zend_Controller_Plugin_ActionStack

Push an item onto the stack

Arguments

$next: Zend_Controller_Request_Abstract

Output

Zend_Controller_Plugin_ActionStack

Details

visibility: public
final: false
static: false

setClearRequestParams
jump to class

setClearRequestParams(
           $clearRequestParams
          )
        
        :
        Zend_Controller_Plugin_ActionStack

Set clearRequestParams flag

@param bool $clearRequestParams

Arguments

$clearRequestParams

Output

Zend_Controller_Plugin_ActionStack

Details

visibility: public
final: false
static: false

setRegistry
jump to class

setRegistry(
          Zend_Registry $registry
          )
        
        :
        Zend_Controller_Plugin_ActionStack

Set registry object

Arguments

$registry: Zend_Registry

Output

Zend_Controller_Plugin_ActionStack

Details

visibility: public
final: false
static: false

setRegistryKey
jump to class

setRegistryKey(
          string $key
          )
        
        :
        Zend_Controller_Plugin_ActionStack

Set registry key

Arguments

$key: string

Output

Zend_Controller_Plugin_ActionStack

Details

visibility: public
final: false
static: false

API Documentation

Controller/Plugin/ActionStack.php

Description

Zend_Controller_Plugin_ActionStackjump to top

Description

Properties

$_clearRequestParamsjump to class

Details

$_registryjump to class

Details

$_registryKeyjump to class

Details

$_validKeysjump to class

Details

Methods

__constructjump to class

Arguments

Details

_saveStackjump to class

Arguments

Output

Details

forwardjump to class

Arguments

Details

getClearRequestParamsjump to class

Output

Details

getRegistryjump to class

Output

Details

getRegistryKeyjump to class

Output

Details

getStackjump to class

Output

Details

popStackjump to class

Output

Details

postDispatchjump to class

Arguments

Details

pushStackjump to class

Arguments

Output

Details

setClearRequestParamsjump to class

Arguments

Output

Details

setRegistryjump to class

Arguments

Output

Details

setRegistryKeyjump to class

Arguments

Output

Details

Zend_Controller_Plugin_ActionStack
jump to top

$_clearRequestParams
jump to class

$_registry
jump to class

$_registryKey
jump to class

$_validKeys
jump to class

__construct
jump to class

_saveStack
jump to class

forward
jump to class

getClearRequestParams
jump to class

getRegistry
jump to class

getRegistryKey
jump to class

getStack
jump to class

popStack
jump to class

postDispatch
jump to class

pushStack
jump to class

setClearRequestParams
jump to class

setRegistry
jump to class

setRegistryKey
jump to class