Class JLayoutBase

Base class for rendering a display layout

JLayoutBase implements JLayout

Direct known subclasses

JLayoutFile

Indirect known subclasses

FOFLayoutFile

Package: Joomla\Libraries\Layout
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 3.0
Link: https://docs.joomla.org/Special:MyLanguage/Sharing_layouts_across_views_or_extensions_with_JLayout
Located at cms/layout/base.php

Methods summary

`public JLayoutBase`	# `setOptions( array\|Joomla\Registry\Registry $options = null )` Set the options Set the options Parameters `$options` `array\|Joomla\Registry\Registry` - $options Array / Registry object with the options to load Returns `JLayoutBase` - Instance of $this to allow chaining. Since 3.2
`public Joomla\Registry\Registry`	# `getOptions( )` Get the options Get the options Returns `Joomla\Registry\Registry` - Object with the options Since 3.2
`public JLayoutBase`	# `resetOptions( )` Function to empty all the options Function to empty all the options Returns `JLayoutBase` - Instance of $this to allow chaining. Since 3.2
`public string`	# `escape( string $output )` Method to escape output. Method to escape output. Parameters `$output` `string` - $output The output to escape. Returns `string` - The escaped output. Since 3.0 Implementation of `JLayout::escape()`
`public array`	# `getDebugMessages( )` Get the debug messages array Get the debug messages array Returns `array` Since 3.2
`public string`	# `render( array $displayData )` Method to render the layout. Method to render the layout. Parameters `$displayData` `array` - $displayData Array of properties available for use inside the layout file to build the displayed output Returns `string` - The necessary HTML to display the layout Since 3.0 Implementation of `JLayout::render()`
`public string`	# `renderDebugMessages( )` Render the list of debug messages Render the list of debug messages Returns `string` - Output text/HTML code Since 3.2
`public JLayoutBase`	# `addDebugMessage( string $message )` Add a debug message to the debug messages array Add a debug message to the debug messages array Parameters `$message` `string` - $message Message to save Returns `JLayoutBase` Since 3.2
`public JLayoutBase`	# `clearDebugMessages( )` Clear the debug messages array Clear the debug messages array Returns `JLayoutBase` Since 3.5
`public string`	# `debug( mixed $data = array() )` Render a layout with debug info Render a layout with debug info Parameters `$data` `mixed` - $data Data passed to the layout Returns `string` Since 3.5
`public mixed`	# `get( string $key, mixed $defaultValue = null )` Method to get the value from the data array Method to get the value from the data array Parameters `$key` `string` - $key Key to search for in the data array `$defaultValue` `mixed` - $defaultValue Default value to return if the key is not set Returns `mixed` - Value from the data array \| defaultValue if doesn't exist Since 3.5
`public array`	# `getData( )` Get the data being rendered Get the data being rendered Returns `array` Since 3.5
`public boolean`	# `isDebugEnabled( )` Check if debug mode is enabled Check if debug mode is enabled Returns `boolean` Since 3.5
`public JLayoutBase`	# `set( string $key, mixed $value )` Method to set a value in the data array. Example: $layout->set('items', $items); Method to set a value in the data array. Example: $layout->set('items', $items); Parameters `$key` `string` - $key Key for the data array `$value` `mixed` - $value Value to assign to the key Returns `JLayoutBase` Since 3.5
`public JLayoutBase`	# `setData( array $data )` Set the the data passed the layout Set the the data passed the layout Parameters `$data` `array` - $data Array with the data for the layout Returns `JLayoutBase` Since 3.5
`public JLayoutBase`	# `setDebug( boolean $debug )` Change the debug mode Change the debug mode Parameters `$debug` `boolean` - $debug Enable / Disable debug Returns `JLayoutBase` Since 3.5

Magic methods summary

Properties summary

`protected Joomla\Registry\Registry`	`$options`	# Options object Options object Since 3.2
`protected array`	`$data`	# Data for the layout Data for the layout Since 3.5
`protected array`	`$debugMessages`	# Debug information messages Debug information messages Since 3.2

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JLayoutBase

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

Since

Implementation of

Returns

Since

Parameters

Returns

Since

Implementation of

Returns

Since

Parameters

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Magic methods summary

Properties summary

Since

Since

Since