API Documentation

Layout/Controller/Plugin/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
Plugins  

\Zend_Layout_Controller_Plugin_Layout

Render layouts

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: Layout.php 23775 2011-03-01 17:25:24Z ralph $  

Properties

Propertyprotected\Zend_Layout  $_layout= ''

Details
Type
\Zend_Layout
Propertyprotected  $_layoutActionHelper= 'null'
Default valuenullDetails
Type

Methods

methodpublic__construct( \Zend_Layout $layout = null ) : void

Constructor

Parameters
Name Type Description
$layout \Zend_Layout
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
methodpublicgetLayout( ) : \Zend_Layout

Retrieve layout object

Returns
Type Description
\Zend_Layout
methodpublicgetLayoutActionHelper( ) : \Zend_Layout_Controller_Action_Helper_Layout

Retrieve layout action helper

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

postDispatch() plugin hook -- render layout

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
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
methodpublicsetLayout( \Zend_Layout $layout ) : \Zend_Layout_Controller_Plugin_Layout

Set layout object

Parameters
Name Type Description
$layout \Zend_Layout
Returns
Type Description
\Zend_Layout_Controller_Plugin_Layout
methodpublicsetLayoutActionHelper( \Zend_Layout_Controller_Action_Helper_Layout $layoutActionHelper ) : \Zend_Layout_Controller_Plugin_Layout

Set layout action helper

Parameters
Name Type Description
$layoutActionHelper \Zend_Layout_Controller_Action_Helper_Layout
Returns
Type Description
\Zend_Layout_Controller_Plugin_Layout
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.