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.
Manage a stack of actions

Bool
$_clearRequestParams= 'false'
Flag to determine whether request parameters are cleared between actions, or whether new parameters are added to existing request parameters.
false
Details
string
$_registryKey= 'Zend_Controller_Plugin_ActionStack'
Registry key under which actions are stored
Zend_Controller_Plugin_ActionStack
Details
__construct(
\Zend_Registry $registry
=
null, string $key
=
null
)
:
void
Constructor
Name | Type | Description |
---|---|---|
$registry | \Zend_Registry | |
$key | string |

_saveStack(
array $stack
)
:
\Zend_Controller_Plugin_ActionStack
Save stack to registry
Name | Type | Description |
---|---|---|
$stack | array |
Type | Description |
---|---|
\Zend_Controller_Plugin_ActionStack |

dispatchLoopShutdown(
)
:
void
Called before Zend_Controller_Front exits its dispatch loop.
Inherited from: \Zend_Controller_Plugin_Abstract::dispatchLoopShutdown()
dispatchLoopStartup(
\Zend_Controller_Request_Abstract $request
)
:
void
Called before Zend_Controller_Front enters its dispatch loop.
Inherited from: \Zend_Controller_Plugin_Abstract::dispatchLoopStartup()Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |

forward(
array $next
)
:
void
Forward request with next action
Name | Type | Description |
---|---|---|
$next | array |

getRequest(
)
:
\Zend_Controller_Request_Abstract
Get request object
Inherited from: \Zend_Controller_Plugin_Abstract::getRequest()Type | Description |
---|---|
\Zend_Controller_Request_Abstract | $request |

getResponse(
)
:
\Zend_Controller_Response_Abstract
Get response object
Inherited from: \Zend_Controller_Plugin_Abstract::getResponse()Type | Description |
---|---|
\Zend_Controller_Response_Abstract | $response |

popStack(
)
:
false|\Zend_Controller_Request_Abstract
Pop an item off the action stack
Type | Description |
---|---|
false\Zend_Controller_Request_Abstract |

postDispatch(
\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.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |

preDispatch(
\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.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |

pushStack(
\Zend_Controller_Request_Abstract $next
)
:
\Zend_Controller_Plugin_ActionStack
Push an item onto the stack
Name | Type | Description |
---|---|---|
$next | \Zend_Controller_Request_Abstract |
Type | Description |
---|---|
\Zend_Controller_Plugin_ActionStack |

routeShutdown(
\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.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |

routeStartup(
\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()Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |

setClearRequestParams(
$clearRequestParams
)
:
\Zend_Controller_Plugin_ActionStack
Set clearRequestParams flag
@param bool $clearRequestParams
Name | Type | Description |
---|---|---|
$clearRequestParams |
Type | Description |
---|---|
\Zend_Controller_Plugin_ActionStack |

setRegistry(
\Zend_Registry $registry
)
:
\Zend_Controller_Plugin_ActionStack
Set registry object
Name | Type | Description |
---|---|---|
$registry | \Zend_Registry |
Type | Description |
---|---|
\Zend_Controller_Plugin_ActionStack |

setRegistryKey(
string $key
)
:
\Zend_Controller_Plugin_ActionStack
Set registry key
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
\Zend_Controller_Plugin_ActionStack |

setRequest(
\Zend_Controller_Request_Abstract $request
)
:
\Zend_Controller_Plugin_Abstract
Set request object
Inherited from: \Zend_Controller_Plugin_Abstract::setRequest()Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |
Type | Description |
---|---|
\Zend_Controller_Plugin_Abstract |

setResponse(
\Zend_Controller_Response_Abstract $response
)
:
\Zend_Controller_Plugin_Abstract
Set response object
Inherited from: \Zend_Controller_Plugin_Abstract::setResponse()Name | Type | Description |
---|---|---|
$response | \Zend_Controller_Response_Abstract |
Type | Description |
---|---|
\Zend_Controller_Plugin_Abstract |