API Documentation

Controller/Action/Helper/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
Zend_Controller_Action_Helper  
version
$Id: ActionStack.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Controller_Action_Helper_ActionStack

Add to action stack

Extends from
\Zend_Controller_Action_Helper_Abstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Controller  
subpackage
Zend_Controller_Action_Helper  
uses
\Zend_Controller_Action_Helper_Abstract  

Properties

Propertyprotected\Zend_Controller_Plugin_ActionStack  $_actionStack= ''

Methods

methodpublic__construct( ) : void

Constructor

Register action stack plugin

methodpublicactionToStack( string $action, string $controller = null, string $module = null, array $params = array ) : \Zend_Controller_Action_Helper_ActionStack

Push a new action onto the stack

Parameters
Name Type Description
$action string
$controller string
$module string
$params array
Returns
Type Description
\Zend_Controller_Action_Helper_ActionStack
Throws
Exception Description
\Zend_Controller_Action_Exception
methodpublicdirect( string $action, string $controller = null, string $module = null, array $params = array ) : boolean

Perform helper when called as $this->_helper->actionStack() from an action controller

Proxies to {@link simple()}

Parameters
Name Type Description
$action string
$controller string
$module string
$params array
Returns
Type Description
boolean
methodpublicgetActionController( ) : \Zend_Controller_Action

Retrieve current action controller

Inherited from: \Zend_Controller_Action_Helper_Abstract::getActionController()
Returns
Type Description
\Zend_Controller_Action
methodpublicgetFrontController( ) : \Zend_Controller_Front

Retrieve front controller instance

Inherited from: \Zend_Controller_Action_Helper_Abstract::getFrontController()
Returns
Type Description
\Zend_Controller_Front
methodpublicgetName( ) : string
Returns
Type Description
string
methodpublicgetRequest( ) : \Zend_Controller_Request_Abstract
Returns
Type Description
\Zend_Controller_Request_Abstract $request
methodpublicgetResponse( ) : \Zend_Controller_Response_Abstract
Returns
Type Description
\Zend_Controller_Response_Abstract $response
methodpublicinit( ) : void

Hook into action controller initialization

Inherited from: \Zend_Controller_Action_Helper_Abstract::init()
methodpublicpostDispatch( ) : void

Hook into action controller postDispatch() workflow

Inherited from: \Zend_Controller_Action_Helper_Abstract::postDispatch()
methodpublicpreDispatch( ) : void

Hook into action controller preDispatch() workflow

Inherited from: \Zend_Controller_Action_Helper_Abstract::preDispatch()
methodpublicpushStack( \Zend_Controller_Request_Abstract $next ) : \Zend_Controller_Action_Helper_ActionStack

Push onto the stack

Parameters
Name Type Description
$next \Zend_Controller_Request_Abstract
Returns
Type Description
\Zend_Controller_Action_Helper_ActionStack Provides a fluent interface
methodpublicsetActionController( \Zend_Controller_Action $actionController = null ) : \Zend_Controller_ActionHelper_Abstract
Parameters
Name Type Description
$actionController \Zend_Controller_Action
Returns
Type Description
\Zend_Controller_ActionHelper_Abstract Provides a fluent interface
Documentation was generated by DocBlox 0.13.3.