Référence de la classe BaseLayout

Graphe d'héritage de BaseLayout:

Fonctions membres publiques
	setOptions ($options=null)
	getOptions ()
	resetOptions ()
	escape ($output)
	getDebugMessages ()
	render ($displayData)
	renderDebugMessages ()
	addDebugMessage ($message)
	clearDebugMessages ()
	debug ($data=array())
	get ($key, $defaultValue=null)
	getData ()
	isDebugEnabled ()
	set ($key, $value)
	setData (array $data)
	setDebug ($debug)

Attributs protégés
	$options = null
	$data = array()
	$debugMessages = array()

Description détaillée

Base class for rendering a display layout

3.0

Documentation des fonctions membres

addDebugMessage()

addDebugMessage

(

$message

)

Add a debug message to the debug messages array

Paramètres

string

$message

Message to save

Renvoie

self

Depuis

3.2

Références $message.

clearDebugMessages()

clearDebugMessages

(

)

Clear the debug messages array

Renvoie

self

Depuis

3.5

debug()

debug

(

$data = array()

)

Render a layout with debug info

Paramètres

mixed

$data

Data passed to the layout

Renvoie

string

Depuis

3.5

Références $data, et $output.

escape()

escape

(

$output

)

Method to escape output.

Paramètres

string

$output

The output to escape.

Renvoie

string The escaped output.

Note

the ENT_COMPAT flag will be replaced by ENT_QUOTES in Joomla 4.0 to also escape single quotes

Depuis

3.0

Implémente LayoutInterface.

Références $output, ENT_COMPAT, et htmlspecialchars.

get()

get	(		$key,
			$defaultValue = null
	)

Method to get the value from the data array

Paramètres

string	$key	Key to search for in the data array
mixed	$defaultValue	Default value to return if the key is not set

Renvoie

mixed Value from the data array | defaultValue if doesn't exist

Depuis

3.5

Références $key.

getData()

getData

(

)

Get the data being rendered

Renvoie

array

Depuis

3.5

Références $data.

getDebugMessages()

getDebugMessages

(

)

Get the debug messages array

Renvoie

array

Depuis

3.2

getOptions()

getOptions

(

)

Get the options

Renvoie

Registry Object with the options

Depuis

3.2

Références $options.

isDebugEnabled()

isDebugEnabled

(

)

Check if debug mode is enabled

Renvoie

boolean

Depuis

3.5

render()

render

(

$displayData

)

Method to render the layout.

Paramètres

array

$displayData

Array of properties available for use inside the layout file to build the displayed output

Renvoie

string The necessary HTML to display the layout

Depuis

3.0

Implémente LayoutInterface.

Références $displayData.

renderDebugMessages()

renderDebugMessages

(

)

Render the list of debug messages

Renvoie

string Output text/HTML code

Depuis

3.2

resetOptions()

resetOptions

(

)

Function to empty all the options

Renvoie

BaseLayout Instance of $this to allow chaining.

Depuis

3.2

Références null.

set()

set	(		$key,
			$value
	)

Method to set a value in the data array. Example: $layout->set('items', $items);

Paramètres

string	$key	Key for the data array
mixed	$value	Value to assign to the key

Renvoie

self

Depuis

3.5

Références $key, et $value.

setData()

setData

(

array

$data

)

Set the the data passed the layout

Paramètres

array

$data

Array with the data for the layout

Renvoie

self

Depuis

3.5

Références $data.

setDebug()

setDebug

(

$debug

)

Change the debug mode

Paramètres

boolean

$debug

Enable / Disable debug

Renvoie

self

Depuis

3.5

setOptions()

setOptions

(

$options = null

)

Set the options

Paramètres

array | Registry

$options

Array / Registry object with the options to load

Renvoie

BaseLayout Instance of $this to allow chaining.

Depuis

3.2

Références $options, et elseif.

Documentation des champs

$data

$data = array()

protected

$debugMessages

$debugMessages = array()

protected

$options

$options = null

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• BaseLayout.php