Layout/Controller/Plugin/Layout.php

Show: PublicProtectedPrivateinherited
Table of Contents
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Controller  
Subpackage
Plugins  

\Zend_Layout_Controller_Plugin_Layout

Package: Zend\Controller\Plugins
Render layouts
Parent(s)
\Zend_Controller_Plugin_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
\global\Zend_Controller_Plugin_Abstract  
Version
$Id: Layout.php 24593 2012-01-05 20:35:02Z matthew $  

Properties

>VPropertyprotected\Zend_Layout $_layout
Details
Type
\Zend_Layout
>VPropertyprotected$_layoutActionHelper = null
Default valuenullDetails
Type
n/a
>VPropertyprotected\Zend_Controller_Request_Abstract $_request
>VPropertyprotected\Zend_Controller_Response_Abstract $_response

Methods

methodpublic__construct(\Zend_Layout $layout = null) : void

Constructor

Parameters
NameTypeDescription
$layout\Zend_Layout
methodpublicdispatchLoopShutdown() : void
inherited

Called before Zend_Controller_Front exits its dispatch loop.

Inherited from: \Zend_Controller_Plugin_Abstract::dispatchLoopShutdown()
methodpublicdispatchLoopStartup(\Zend_Controller_Request_Abstract $request) : void
inherited

Called before Zend_Controller_Front enters its dispatch loop.

Inherited from: \Zend_Controller_Plugin_Abstract::dispatchLoopStartup()
Parameters
NameTypeDescription
$request\Zend_Controller_Request_Abstract
methodpublicgetLayout() : \Zend_Layout

Retrieve layout object

Returns
TypeDescription
\Zend_Layout
methodpublicgetLayoutActionHelper() : \Zend_Layout_Controller_Action_Helper_Layout

Retrieve layout action helper

methodpublicgetRequest() : \Zend_Controller_Request_Abstract
inherited

Get request object

Inherited from: \Zend_Controller_Plugin_Abstract::getRequest()
Returns
TypeDescription
\Zend_Controller_Request_Abstract$request
methodpublicgetResponse() : \Zend_Controller_Response_Abstract
inherited

Get response object

Inherited from: \Zend_Controller_Plugin_Abstract::getResponse()
Returns
TypeDescription
\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 setDispatched(false)), a new action may be specified for dispatching.

Parameters
NameTypeDescription
$request\Zend_Controller_Request_Abstract
methodpublicpreDispatch(\Zend_Controller_Request_Abstract $request) : void
inherited

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 setDispatched(false)), the current action may be skipped.

Parameters
NameTypeDescription
$request\Zend_Controller_Request_Abstract
methodpublicrouteShutdown(\Zend_Controller_Request_Abstract $request) : void
inherited

Called after Zend_Controller_Router exits.

Inherited from: \Zend_Controller_Plugin_Abstract::routeShutdown()

Called after Zend_Controller_Front exits from the router.

Parameters
NameTypeDescription
$request\Zend_Controller_Request_Abstract
methodpublicrouteStartup(\Zend_Controller_Request_Abstract $request) : void
inherited

Called before Zend_Controller_Front begins evaluating the request against its routes.

Inherited from: \Zend_Controller_Plugin_Abstract::routeStartup()
Parameters
NameTypeDescription
$request\Zend_Controller_Request_Abstract
methodpublicsetLayout(\Zend_Layout $layout) : \Zend_Layout_Controller_Plugin_Layout

Set layout object

Parameters
NameTypeDescription
$layout\Zend_Layout
Returns
TypeDescription
\Zend_Layout_Controller_Plugin_Layout
methodpublicsetLayoutActionHelper(\Zend_Layout_Controller_Action_Helper_Layout $layoutActionHelper) : \Zend_Layout_Controller_Plugin_Layout

Set layout action helper

Parameters
NameTypeDescription
$layoutActionHelper\Zend_Layout_Controller_Action_Helper_Layout
Returns
TypeDescription
\Zend_Layout_Controller_Plugin_Layout
methodpublicsetRequest(\Zend_Controller_Request_Abstract $request) : \Zend_Controller_Plugin_Abstract
inherited

Set request object

Inherited from: \Zend_Controller_Plugin_Abstract::setRequest()
Parameters
NameTypeDescription
$request\Zend_Controller_Request_Abstract
Returns
TypeDescription
\Zend_Controller_Plugin_Abstract
methodpublicsetResponse(\Zend_Controller_Response_Abstract $response) : \Zend_Controller_Plugin_Abstract
inherited

Set response object

Inherited from: \Zend_Controller_Plugin_Abstract::setResponse()
Parameters
NameTypeDescription
$response\Zend_Controller_Response_Abstract
Returns
TypeDescription
\Zend_Controller_Plugin_Abstract
Documentation was generated by phpDocumentor 2.0.0a12.