API Documentation

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

\Zend_Layout_Controller_Action_Helper_Layout

Helper for interacting with Zend_Layout objects

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  
uses
\Zend_Controller_Action_Helper_Abstract  

Properties

Propertyprotected\Zend_Controller_Front  $_frontController= ''

Details
Type
\Zend_Controller_Front
Propertyprotectedbool  $_isActionControllerSuccessful= 'false'

Default valuefalseDetails
Type
bool
Propertyprotected\Zend_Layout  $_layout= ''

Details
Type
\Zend_Layout

Methods

methodpublic__call( string $method, array $args ) : mixed

Proxy method calls to layout object

Parameters
Name Type Description
$method string
$args array
Returns
Type Description
mixed
methodpublic__construct( \Zend_Layout $layout = null ) : void

Constructor

Parameters
Name Type Description
$layout \Zend_Layout
methodpublicdirect( ) : \Zend_Layout

Strategy pattern; call object as method

Returns layout object

Returns
Type Description
\Zend_Layout
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

Get front controller instance

Returns
Type Description
\Zend_Controller_Front
methodpublicgetLayoutInstance( ) : \Zend_Layout

Get layout object

Returns
Type Description
\Zend_Layout
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

methodpublicisActionControllerSuccessful( ) : bool

Did the previous action successfully complete?

Returns
Type Description
bool
methodpublicpostDispatch( ) : \Zend_Layout_Controller_Action_Helper_Layout

Mark Action Controller (according to this plugin) as Running successfully

methodpublicpreDispatch( ) : void

Hook into action controller preDispatch() workflow

Inherited from: \Zend_Controller_Action_Helper_Abstract::preDispatch()
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
methodpublicsetLayoutInstance( \Zend_Layout $layout ) : \Zend_Layout_Controller_Action_Helper_Layout

Set layout object

Parameters
Name Type Description
$layout \Zend_Layout
Returns
Type Description
\Zend_Layout_Controller_Action_Helper_Layout
Documentation was generated by DocBlox 0.13.3.