Provide Layout support for MVC applications

category Zend
package Zend_Layout
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Constructor

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

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

$options

stringarray\Zend_Config

$initMvc

Get layout variable

__get(string $key) : mixed

Parameters

$key

string

Returns

mixed

Is a layout variable set?

__isset(string $key) : boolean

Parameters

$key

string

Returns

boolean

Set layout variable

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

Parameters

$key

string

$value

mixed

Unset a layout variable?

__unset(string $key) : void

Parameters

$key

string

Assign one or more layout variables

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

Parameters

$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

Exceptions

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

Returns

\Zend_Layout

Disable inflector

disableInflector() : \Zend_Layout

Returns

\Zend_Layout

Disable layout

disableLayout() : \Zend_Layout

Returns

\Zend_Layout

Enable inflector

enableInflector() : \Zend_Layout

Returns

\Zend_Layout

Enable layout

enableLayout() : \Zend_Layout

Returns

\Zend_Layout

Retrieve content key

getContentKey() : string

Returns

string

Retrieve helper class

getHelperClass() : string

Returns

string

Retrieve inflector

getInflector() : \Zend_Filter_Inflector

Returns

\Zend_Filter_Inflector

Retrieve inflector target

getInflectorTarget() : string

Returns

string

Get current layout script

getLayout() : string

Returns

string

Get current layout script path

getLayoutPath() : string

Returns

string

Retrieve MVC enabled flag

getMvcEnabled() : boolean

Returns

boolean

Retrieve MVC instance of Zend_Layout object

getMvcInstance() : \Zend_Layout | null
Static

Returns

\Zend_Layoutnull

Get MVC Successful Action Only Flag

getMvcSuccessfulActionOnly() : boolean

Returns

boolean

Retrieve plugin class

getPluginClass() : string

Returns

string

Get current view object

getView() : \Zend_View_Interface

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

todo Set inflector from view renderer at same time

Returns

\Zend_View_Interface

getViewBasePath()

getViewBasePath() 

getViewScriptPath()

getViewScriptPath() 

Retrieve layout view script suffix

getViewSuffix() : string

Returns

string

Return status of inflector enabled flag

inflectorEnabled() : boolean

Returns

boolean

Is layout enabled?

isEnabled() : boolean

Returns

boolean

Render layout

render(mixed $name = null) : mixed

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

mixed

Returns

mixed

Reset MVC instance

resetMvcInstance() : void
Static

Unregisters plugins and helpers, and destroys MVC layout instance.

Set options from a config object

setConfig(\Zend_Config $config) : \Zend_Layout

Parameters

$config

\Zend_Config

Returns

\Zend_Layout

Set content key

setContentKey(string $contentKey) : \Zend_Layout

Key in namespace container denoting default content

Parameters

$contentKey

string

Returns

\Zend_Layout

Set helper class

setHelperClass(string $helperClass) : \Zend_Layout

Parameters

$helperClass

string

Returns

\Zend_Layout

Set inflector to use when resolving layout names

setInflector(\Zend_Filter_Inflector $inflector) : \Zend_Layout

Parameters

$inflector

\Zend_Filter_Inflector

Returns

\Zend_Layout

Set inflector target

setInflectorTarget(string $inflectorTarget) : \Zend_Layout

Parameters

$inflectorTarget

string

Returns

\Zend_Layout

Set layout script to use

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

Note: enables layout by default, can be disabled

Parameters

$name

string

$enabled

boolean

Returns

\Zend_Layout

Set layout script path

setLayoutPath(string $path) : \Zend_Layout

Parameters

$path

string

Returns

\Zend_Layout

Set MVC Successful Action Only flag

setMvcSuccessfulActionOnly(boolean $successfulActionOnly) : \Zend_Layout

Parameters

$successfulActionOnly

boolean

Returns

\Zend_Layout

Set options en masse

setOptions(array|\Zend_Config $options) : void

Parameters

$options

array\Zend_Config

Set plugin class

setPluginClass(string $pluginClass) : \Zend_Layout

Parameters

$pluginClass

string

Returns

\Zend_Layout

Set view object

setView(\Zend_View_Interface $view) : \Zend_Layout

Parameters

$view

\Zend_View_Interface

Returns

\Zend_Layout

setViewBasePath()

setViewBasePath($path, $prefix = 'Layout_View'

Parameters

$path

$prefix

setViewScriptPath()

setViewScriptPath($path) 

Parameters

$path

Set layout view script suffix

setViewSuffix(string $viewSuffix) : \Zend_Layout

Parameters

$viewSuffix

string

Returns

\Zend_Layout

Static method for initialization with MVC support

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

Parameters

$options

stringarray\Zend_Config

Returns

\Zend_Layout

Initialize action helper

_initHelper() : void

Initialize MVC integration

_initMvc() : void

Initialize front controller plugin

_initPlugin() : void

Initialize placeholder container for layout vars

_initVarContainer() : \Zend_View_Helper_Placeholder_Container

Returns

\Zend_View_Helper_Placeholder_Container

Set MVC enabled flag

_setMvcEnabled(boolean $mvcEnabled) : \Zend_Layout

Parameters

$mvcEnabled

boolean

Returns

\Zend_Layout

 Properties

 

Placeholder container for layout variables

$_container : \Zend_View_Helper_Placeholder_Container

Default

 

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

$_contentKey : string

Default

'content'
 

Are layouts enabled?

$_enabled : boolean

Default

true
 

Helper class

$_helperClass : string

Default

'Zend_Layout_Controller_Action_Helper_Layout'
 

Inflector used to resolve layout script

$_inflector : \Zend_Filter_Inflector

Default

 

Flag: is inflector enabled?

$_inflectorEnabled : boolean

Default

true
 

Inflector target

$_inflectorTarget : string

Default

':script.:suffix'
 

Layout view

$_layout : string

Default

'layout'
 

Flag: is MVC integration enabled?

$_mvcEnabled : boolean

Default

true
 

Instance registered with MVC, if any

$_mvcInstance : \Zend_Layout

Default

Static
 

Flag: is MVC successful action only flag set?

$_mvcSuccessfulActionOnly : boolean

Default

true
 

Plugin class

$_pluginClass : string

Default

'Zend_Layout_Controller_Plugin_Layout'
 

$_view

$_view : \Zend_View_Interface

Default

 

$_viewBasePath

$_viewBasePath 

Default

null
 

$_viewBasePrefix

$_viewBasePrefix 

Default

'Layout_View'
 

Layout view script path

$_viewScriptPath : string

Default

null
 

View script suffix for layout script

$_viewSuffix : string

Default

'phtml'