Référence de la classe FileLayout

Graphe d'héritage de FileLayout:

Fonctions membres publiques
	__construct ($layoutId, $basePath=null, $options=null)
	render ($displayData=array())
	addIncludePath ($path)
	addIncludePaths ($paths)
	clearIncludePaths ()
	getIncludePaths ()
	getLayoutId ()
	getSuffixes ()
	loadLanguageSuffixes ()
	loadVersionSuffixes ()
	removeIncludePath ($path)
	removeIncludePaths ($paths)
	setComponent ($option)
	setClient ($client)
	setLayoutId ($layoutId)
	getDefaultIncludePaths ()
	setIncludePaths ($paths)
	setSuffixes (array $suffixes)
	sublayout ($layoutId, $displayData)
Fonctions membres publiques hérités de BaseLayout
	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)

Fonctions membres protégées
	getPath ()
	validComponent ($option=null)

Attributs protégés
	$layoutId = ''
	$basePath = null
	$fullPath = null
	$includePaths = array()
Attributs protégés hérités de BaseLayout
	$options = null
	$data = array()
	$debugMessages = array()

Attributs protégés statiques
static	$cache = array()

Description détaillée

Base class for rendering a display layout loaded from from a layout file

3.0

Documentation des constructeurs et destructeur

__construct()

__construct	(		$layoutId,
			$basePath = null,
			$options = null
	)

Method to instantiate the file-based layout.

Paramètres

string	$layoutId	Dot separated path to the layout file, relative to base path
string	$basePath	Base path to use when loading layout files
mixed	$options	Optional custom options to load. Registry or array format [

Depuis

3.2]

3.0

Références $basePath, et $options.

Documentation des fonctions membres

addIncludePath()

addIncludePath

(

$path

)

Add one path to include in layout search. Proxy of addIncludePaths()

Paramètres

string|string[]

$path The path to search for layouts

Renvoie

self

Depuis

3.2

Références $path, et $this.

addIncludePaths()

addIncludePaths

(

$paths

)

Add one or more paths to include in layout search

Paramètres

string|string[]

$paths The path or array of paths to search for layouts

Renvoie

self

Depuis

3.2

Références $this.

clearIncludePaths()

clearIncludePaths

(

)

Clear the include paths

Renvoie

self

Depuis

3.5

Références $this.

getDefaultIncludePaths()

getDefaultIncludePaths

(

)

Get the default array of include paths

Renvoie

array

Depuis

3.5

Références $component, $template, Factory\getApplication(), JPATH_ADMINISTRATOR, JPATH_ROOT, JPATH_SITE, JPATH_THEMES, et null.

getIncludePaths()

getIncludePaths

(

)

Get the active include paths

Renvoie

array

Depuis

3.5

getLayoutId()

getLayoutId

(

)

Get the active layout id

Renvoie

string

Depuis

3.5

getPath()

getPath ( )

protected

Method to finds the full real file path, checking possible overrides

Renvoie

string The full path to the layout file

Depuis

3.0

Références $hash, $suffix, et Path\find().

getSuffixes()

getSuffixes

(

)

Get the active suffixes

Renvoie

array

Depuis

3.5

loadLanguageSuffixes()

loadLanguageSuffixes

(

)

Load the automatically generated language suffixes. Example: array('es-ES', 'es', 'ltr')

Renvoie

self

Depuis

3.5

Références $lang, $this, et Factory\getLanguage().

loadVersionSuffixes()

loadVersionSuffixes

(

)

Load the automatically generated version suffixes. Example: array('j311', 'j31', 'j3')

Renvoie

self

Depuis

3.5

Références $this.

removeIncludePath()

removeIncludePath

(

$path

)

Remove one path from the layout search

Paramètres

string

$path

The path to remove from the layout search

Renvoie

self

Depuis

3.2

Références $path, et $this.

removeIncludePaths()

removeIncludePaths

(

$paths

)

Remove one or more paths to exclude in layout search

Paramètres

string

$paths

The path or array of paths to remove for the layout search

Renvoie

self

Depuis

3.2

Références $this.

render()

render

(

$displayData = array()

)

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, et $path.

setClient()

setClient

(

$client

)

Function to initialise the application client

Paramètres

mixed

$client

Frontend: 'site' or 0 | Backend: 'admin' or 1

Renvoie

void

Depuis

3.2

Références $client, et Factory\getApplication().

setComponent()

setComponent

(

$option

)

Method to change the component where search for layouts

Paramètres

string

$option

URL Option of the component. Example: com_content

Renvoie

mixed Component option string | null for none

Depuis

3.2

Références $component, $option, ApplicationHelper\getComponentName(), et null.

setIncludePaths()

setIncludePaths

(

$paths

)

Set the include paths to search for layouts

Paramètres

array

$paths

Array with paths to search in

Renvoie

self

Depuis

3.5

Références $this.

setLayoutId()

setLayoutId

(

$layoutId

)

Set the active layout id

Paramètres

string

$layoutId

Layout identifier

Renvoie

self

Depuis

3.5

Références $this, et null.

setSuffixes()

setSuffixes

(

array

$suffixes

)

Set suffixes to search layouts

Paramètres

mixed

$suffixes

String with a single suffix or 'auto' | 'none' or array of suffixes

Renvoie

self

Depuis

3.5

Références $this.

sublayout()

sublayout	(		$layoutId,
			$displayData
	)

Render a layout with the same include paths & options

Paramètres

string	$layoutId	The identifier for the sublayout to be searched in a subfolder with the name of the current layout
mixed	$displayData	Data to be rendered

Renvoie

string The necessary HTML to display the layout

Depuis

3.2

Références $basePath, $displayData, $options, et $sublayout.

validComponent()

validComponent (   $option = null )

protected

Validate that the active component is valid

Paramètres

string

$option

URL Option of the component. Example: com_content

Renvoie

boolean

Depuis

3.2

Références $component, $option, ComponentHelper\isEnabled(), et null.

Documentation des champs

$basePath

$basePath = null

protected

$cache

$cache = array()

staticprotected

$fullPath

$fullPath = null

protected

$includePaths

$includePaths = array()

protected

$layoutId

$layoutId = ''

protected

---

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

• FileLayout.php