Docs For Class JLayoutBase

Description

Implements interfaces:

JLayout

Base class for rendering a display layout

see: http://docs.joomla.org/Sharing_layouts_across_views_or_extensions_with_JLayout
since: 3.0

Located in /libraries/cms/layout/base.php (line 20)

Direct descendents

Class	Description
JLayoutFile	Base class for rendering a display layout loaded from from a layout file

Variable Summary

array $debugMessages

JRegistry $options

Method Summary

void addDebugMessage (string $message)

string escape (string $output)

array getDebugMessages ()

JRegistry getOptions ()

string render (object $displayData)

string renderDebugMessages ()

JLayoutBase resetOptions ()

JLayoutBase setOptions ([mixed $options = null])

Variables

array $debugMessages = array() (line 36)

Debug information messages

since: 3.2
access: protected

JRegistry $options = null (line 28)

Options object

since: 3.2
access: protected

Methods

addDebugMessage (line 158)

Add a debug message to the debug messages array

since: 3.2
access: public

void addDebugMessage (string $message)

string $message: Message to save

escape (line 106)

Method to escape output.

return: The escaped output.
since: 3.0
access: public

string escape (string $output)

string $output: The output to escape.

Implementation of:

JLayout::escape(): Method to escape output.

getDebugMessages (line 118)

Get the debug messages array

since: 3.2
access: public

array getDebugMessages ()

getOptions (line 74)

Get the options

return: Object with the options
since: 3.2
access: public

JRegistry getOptions ()

render (line 132)

Method to render the layout.

return: The necessary HTML to display the layout
since: 3.0
access: public

string render (object $displayData)

object $displayData: Object which properties are used inside the layout file to build displayed output

Implementation of:

JLayout::render(): Method to render the layout.

Redefined in descendants as:

JLayoutFile::render() : Method to render the layout.

renderDebugMessages (line 144)

Render the list of debug messages

return: Output text/HTML code
since: 3.2
access: public

string renderDebugMessages ()

resetOptions (line 92)

Function to empty all the options

return: Instance of $this to allow chaining.
since: 3.2
access: public

JLayoutBase resetOptions ()

setOptions (line 47)

Set the options

return: Instance of $this to allow chaining.
since: 3.2
access: public

JLayoutBase setOptions ([mixed $options = null])

mixed $options: Array / JRegistry object with the options to load