Layout.php

Show:

inherited

Classes
- \Zend_Layout

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Layout
Version: $Id$

\Zend_Layout
jump to top

Package: Zend_Layout

Provide Layout support for MVC applications

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

\Zend_View_Helper_Placeholder_Container $_container

Placeholder container for layout variables

Details

Type: \Zend_View_Helper_Placeholder_Container

string $_contentKey = 'content'

Key used to store content from 'default' named response segment

Default value'content'Details

Type: string

bool $_enabled = true

Are layouts enabled?

Default valuetrueDetails

Type: bool

string $_helperClass = 'Zend_Layout_Controller_Action_Helper_Layout'

Helper class

Default value'Zend_Layout_Controller_Action_Helper_Layout'Details

Type: string

\Zend_Filter_Inflector $_inflector

Inflector used to resolve layout script

Details

Type: \Zend_Filter_Inflector

bool $_inflectorEnabled = true

Flag: is inflector enabled?

Default valuetrueDetails

Type: bool

string $_inflectorTarget = ':script.:suffix'

Inflector target

Default value':script.:suffix'Details

Type: string

string $_layout = 'layout'

Layout view

Default value'layout'Details

Type: string

bool $_mvcEnabled = true

Flag: is MVC integration enabled?

Default valuetrueDetails

Type: bool

\Zend_Layout $_mvcInstance

static

Instance registered with MVC, if any

Details

Type: \Zend_Layout

bool $_mvcSuccessfulActionOnly = true

Flag: is MVC successful action only flag set?

Default valuetrueDetails

Type: bool

string $_pluginClass = 'Zend_Layout_Controller_Plugin_Layout'

Plugin class

Default value'Zend_Layout_Controller_Plugin_Layout'Details

Type: string

\Zend_View_Interface $_view

Details

Type: \Zend_View_Interface

$_viewBasePath = null

Default valuenullDetails

Type: n/a

$_viewBasePrefix = 'Layout_View'

Default value'Layout_View'Details

Type: n/a

string $_viewScriptPath = null

Layout view script path

Default valuenullDetails

Type: string

string $_viewSuffix = 'phtml'

View script suffix for layout script

Default value'phtml'Details

Type: string

Methods

__construct(string | array | \Zend_Config $options = null, $initMvc = false) : void

Constructor

Accepts either: - A string path to layouts - An array of options - A Zend_Config object with options Layout script path, either as argument or as key in options, is required. If mvcEnabled flag is false from options, simply sets layout script path. Otherwise, also instantiates and registers action helper and controller plugin.

Parameters

Name	Type	Description
$options	string \| array \| \Zend_Config
$initMvc

__get(string $key) : mixed

Get layout variable

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

__isset(string $key) : bool

Is a layout variable set?

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
bool

__set(string $key, mixed $value) : void

Set layout variable

Parameters

Name	Type	Description
$key	string
$value	mixed

__unset(string $key) : void

Unset a layout variable?

Parameters

Name	Type	Description
$key	string

_initHelper() : void

Initialize action helper

_initMvc() : void

Initialize MVC integration

_initPlugin() : void

Initialize front controller plugin

_initVarContainer() : \Zend_View_Helper_Placeholder_Container

Initialize placeholder container for layout vars

Returns

Type	Description
\Zend_View_Helper_Placeholder_Container

_setMvcEnabled(bool $mvcEnabled) : \Zend_Layout

Set MVC enabled flag

Parameters

Name	Type	Description
$mvcEnabled	bool

Returns

Type	Description
\Zend_Layout

assign(mixed $spec, mixed $value = null) : \Zend_Layout

Assign one or more layout variables

Parameters

Name	Type	Description
$spec	mixed	Assoc array or string key; if assoc array, sets each key as a layout variable
$value	mixed	Value if $spec is a key

Returns

Type	Description
\Zend_Layout

Throws

Exception	Description
\Zend_Layout_Exception	if non-array/string value passed to $spec

disableInflector() : \Zend_Layout

Disable inflector

Returns

Type	Description
\Zend_Layout

disableLayout() : \Zend_Layout

Disable layout

Returns

Type	Description
\Zend_Layout

enableInflector() : \Zend_Layout

Enable inflector

Returns

Type	Description
\Zend_Layout

enableLayout() : \Zend_Layout

Enable layout

Returns

Type	Description
\Zend_Layout

getContentKey() : string

Retrieve content key

Returns

Type	Description
string

getHelperClass() : string

Retrieve helper class

Returns

Type	Description
string

getInflector() : \Zend_Filter_Inflector

Retrieve inflector

Returns

Type	Description
\Zend_Filter_Inflector

getInflectorTarget() : string

Retrieve inflector target

Returns

Type	Description
string

getLayout() : string

Get current layout script

Returns

Type	Description
string

getLayoutPath() : string

Get current layout script path

Returns

Type	Description
string

getMvcEnabled() : bool

Retrieve MVC enabled flag

Returns

Type	Description
bool

getMvcInstance() : \Zend_Layout | null

static

Retrieve MVC instance of Zend_Layout object

Returns

Type	Description
\Zend_Layout \| null

getMvcSuccessfulActionOnly() : bool

Get MVC Successful Action Only Flag

Returns

Type	Description
bool

getPluginClass() : string

Retrieve plugin class

Returns

Type	Description
string

getView() : \Zend_View_Interface

Get current view object

If no view object currently set, retrieves it from the ViewRenderer.

Returns

Type	Description
\Zend_View_Interface

Details

Todo: Set inflector from view renderer at same time

getViewBasePath() : void

getViewScriptPath() : void

getViewSuffix() : string

Retrieve layout view script suffix

Returns

Type	Description
string

inflectorEnabled() : bool

Return status of inflector enabled flag

Returns

Type	Description
bool

isEnabled() : bool

Is layout enabled?

Returns

Type	Description
bool

render(mixed $name = null) : mixed

Render layout

Sets internal script path as last path on script path stack, assigns layout variables to view, determines layout name using inflector, and renders layout view script. $name will be passed to the inflector as the key 'script'.

Parameters

Name	Type	Description
$name	mixed

Returns

Type	Description
mixed

resetMvcInstance() : void

static

Reset MVC instance

Unregisters plugins and helpers, and destroys MVC layout instance.

setConfig(\Zend_Config $config) : \Zend_Layout

Set options from a config object

Parameters

Name	Type	Description
$config	\Zend_Config

Returns

Type	Description
\Zend_Layout

setContentKey(string $contentKey) : \Zend_Layout

Set content key

Key in namespace container denoting default content

Parameters

Name	Type	Description
$contentKey	string

Returns

Type	Description
\Zend_Layout

setHelperClass(string $helperClass) : \Zend_Layout

Set helper class

Parameters

Name	Type	Description
$helperClass	string

Returns

Type	Description
\Zend_Layout

setInflector(\Zend_Filter_Inflector $inflector) : \Zend_Layout

Set inflector to use when resolving layout names

Parameters

Name	Type	Description
$inflector	\Zend_Filter_Inflector

Returns

Type	Description
\Zend_Layout

setInflectorTarget(string $inflectorTarget) : \Zend_Layout

Set inflector target

Parameters

Name	Type	Description
$inflectorTarget	string

Returns

Type	Description
\Zend_Layout

setLayout(string $name, boolean $enabled = true) : \Zend_Layout

Set layout script to use

Note: enables layout by default, can be disabled

Parameters

Name	Type	Description
$name	string
$enabled	boolean

Returns

Type	Description
\Zend_Layout

setLayoutPath(string $path) : \Zend_Layout

Set layout script path

Parameters

Name	Type	Description
$path	string

Returns

Type	Description
\Zend_Layout

setMvcSuccessfulActionOnly(bool $successfulActionOnly) : \Zend_Layout

Set MVC Successful Action Only flag

Parameters

Name	Type	Description
$successfulActionOnly	bool

Returns

Type	Description
\Zend_Layout

setOptions(array | \Zend_Config $options) : void

Set options en masse

Parameters

Name	Type	Description
$options	array \| \Zend_Config

setPluginClass(string $pluginClass) : \Zend_Layout

Set plugin class

Parameters

Name	Type	Description
$pluginClass	string

Returns

Type	Description
\Zend_Layout

setView(\Zend_View_Interface $view) : \Zend_Layout

Set view object

Parameters

Name	Type	Description
$view	\Zend_View_Interface

Returns

Type	Description
\Zend_Layout

setViewBasePath( $path, $prefix = 'Layout_View') : void

Parameters

Name	Type	Description
$path
$prefix

setViewScriptPath( $path) : void

Parameters

Name	Type	Description
$path

setViewSuffix(string $viewSuffix) : \Zend_Layout

Set layout view script suffix

Parameters

Name	Type	Description
$viewSuffix	string

Returns

Type	Description
\Zend_Layout

startMvc(string | array | \Zend_Config $options = null) : \Zend_Layout

static

Static method for initialization with MVC support

Parameters

Name	Type	Description
$options	string \| array \| \Zend_Config

Returns

Type	Description
\Zend_Layout

Layout.php

\Zend_Layoutjump to top

Properties

Methods

\Zend_Layout
jump to top