Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Controller_Plugin_ActionStack Class Reference

Public Member Functions

 __construct (Zend_Registry $registry=null, $key=null)
 Constructor.
 
 setRegistry (Zend_Registry $registry)
 Set registry object.
 
 getRegistry ()
 Retrieve registry object.
 
 getRegistryKey ()
 Retrieve registry key.
 
 setRegistryKey ($key)
 Set registry key.
 
 setClearRequestParams ($clearRequestParams)
 Set clearRequestParams flag.
 
 getClearRequestParams ()
 Retrieve clearRequestParams flag.
 
 getStack ()
 Retrieve action stack.
 
 pushStack (Zend_Controller_Request_Abstract $next)
 Push an item onto the stack.
 
 popStack ()
 Pop an item off the action stack.
 
 postDispatch (Zend_Controller_Request_Abstract $request)
 postDispatch() plugin hook – check for actions in stack, and dispatch if any found
 
 forward (Zend_Controller_Request_Abstract $next)
 Forward request with next action.
 
- Public Member Functions inherited from Zend_Controller_Plugin_Abstract
 setRequest (Zend_Controller_Request_Abstract $request)
 Set request object.
 
 getRequest ()
 Get request object.
 
 setResponse (Zend_Controller_Response_Abstract $response)
 Set response object.
 
 getResponse ()
 Get response object.
 
 routeStartup (Zend_Controller_Request_Abstract $request)
 Called before Zend_Controller_Front begins evaluating the request against its routes.
 
 routeShutdown (Zend_Controller_Request_Abstract $request)
 Called after Zend_Controller_Router exits.
 
 dispatchLoopStartup (Zend_Controller_Request_Abstract $request)
 Called before Zend_Controller_Front enters its dispatch loop.
 
 preDispatch (Zend_Controller_Request_Abstract $request)
 Called before an action is dispatched by Zend_Controller_Dispatcher.
 
 postDispatch (Zend_Controller_Request_Abstract $request)
 Called after an action is dispatched by Zend_Controller_Dispatcher.
 
 dispatchLoopShutdown ()
 Called before Zend_Controller_Front exits its dispatch loop.
 

Protected Member Functions

 _saveStack (array $stack)
 Save stack to registry.
 

Protected Attributes

 $_registry
 
 $_registryKey = 'Zend_Controller_Plugin_ActionStack'
 
 $_validKeys
 
 $_clearRequestParams = false
 
- Protected Attributes inherited from Zend_Controller_Plugin_Abstract
 $_request
 
 $_response
 

Constructor & Destructor Documentation

__construct ( Zend_Registry  $registry = null,
  $key = null 
)

Constructor.

Parameters
Zend_Registry$registry
string$key
Returns
void

Member Function Documentation

_saveStack ( array  $stack)
protected

Save stack to registry.

Parameters
array$stack
Returns
Zend_Controller_Plugin_ActionStack

Forward request with next action.

Parameters
array$next
Returns
void
getClearRequestParams ( )

Retrieve clearRequestParams flag.

Returns
bool
getRegistry ( )

Retrieve registry object.

Returns
Zend_Registry
getRegistryKey ( )

Retrieve registry key.

Returns
string
getStack ( )

Retrieve action stack.

Returns
array
popStack ( )

Pop an item off the action stack.

Returns
false|Zend_Controller_Request_Abstract
postDispatch ( Zend_Controller_Request_Abstract  $request)

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

Parameters
Zend_Controller_Request_Abstract$request
Returns
void
pushStack ( Zend_Controller_Request_Abstract  $next)

Push an item onto the stack.

Parameters
Zend_Controller_Request_Abstract$next
Returns
Zend_Controller_Plugin_ActionStack
setClearRequestParams (   $clearRequestParams)

Set clearRequestParams flag.

Parameters
bool$clearRequestParams
Returns
Zend_Controller_Plugin_ActionStack
setRegistry ( Zend_Registry  $registry)

Set registry object.

Parameters
Zend_Registry$registry
Returns
Zend_Controller_Plugin_ActionStack
setRegistryKey (   $key)

Set registry key.

Parameters
string$key
Returns
Zend_Controller_Plugin_ActionStack

Member Data Documentation

$_clearRequestParams = false
protected
$_registry
protected
$_registryKey = 'Zend_Controller_Plugin_ActionStack'
protected
$_validKeys
protected
Initial value:
= array(
'module',
'controller',
'action',
'params'
)