API Documentation

Controller/Plugin/ActionStack.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Controller  
subpackage
Plugins  

\Zend_Controller_Plugin_ActionStack

Manage a stack of actions

Extends from
\Zend_Controller_Plugin_Abstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Controller  
subpackage
Plugins  
uses
\Zend_Controller_Plugin_Abstract  
version
$Id: ActionStack.php 23775 2011-03-01 17:25:24Z ralph $  

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 valueZend_Controller_Plugin_ActionStackDetails
Type
string
Propertyprotectedarray  $_validKeys= 'array'

Valid keys for stack items

Default valuearrayDetails
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
methodpublicdispatchLoopShutdown( ) : void

Called before Zend_Controller_Front exits its dispatch loop.

Inherited from: \Zend_Controller_Plugin_Abstract::dispatchLoopShutdown()
methodpublicdispatchLoopStartup( \Zend_Controller_Request_Abstract $request ) : void

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
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
methodpublicgetRequest( ) : \Zend_Controller_Request_Abstract

Get request object

Inherited from: \Zend_Controller_Plugin_Abstract::getRequest()
Returns
Type Description
\Zend_Controller_Request_Abstract $request
methodpublicgetResponse( ) : \Zend_Controller_Response_Abstract

Get response object

Inherited from: \Zend_Controller_Plugin_Abstract::getResponse()
Returns
Type Description
\Zend_Controller_Response_Abstract $response
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

This callback allows for proxy or filter behavior. By altering the request and resetting its dispatched flag (via {@link Zend_Controller_Request_Abstract::setDispatched() setDispatched(false)}), a new action may be specified for dispatching.

Parameters
Name Type Description
$request \Zend_Controller_Request_Abstract
methodpublicpreDispatch( \Zend_Controller_Request_Abstract $request ) : void

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 {@link Zend_Controller_Request_Abstract::setDispatched() setDispatched(false)}), the current action may be skipped.

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
methodpublicrouteShutdown( \Zend_Controller_Request_Abstract $request ) : void

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
methodpublicrouteStartup( \Zend_Controller_Request_Abstract $request ) : void

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
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
methodpublicsetRequest( \Zend_Controller_Request_Abstract $request ) : \Zend_Controller_Plugin_Abstract

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
methodpublicsetResponse( \Zend_Controller_Response_Abstract $response ) : \Zend_Controller_Plugin_Abstract

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
Documentation was generated by DocBlox 0.13.3.