Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
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)
 
 setLayout ($layoutId)
 
 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)
 
 refreshIncludePaths ()
 

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$layoutIdDot separated path to the layout file, relative to base path
string$basePathBase path to use when loading layout files
mixed$optionsOptional 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$pathThe path to search for layouts
Renvoie
self
Depuis
3.2

Références $path.

◆ addIncludePaths()

addIncludePaths (   $paths)

Add one or more paths to include in layout search

Paramètres
string$pathsThe path or array of paths to search for layouts
Renvoie
self
Depuis
3.2

◆ clearIncludePaths()

clearIncludePaths ( )

Clear the include paths

Renvoie
self
Depuis
3.5

◆ getDefaultIncludePaths()

getDefaultIncludePaths ( )

Get the default array of include paths

Renvoie
array
Depuis
3.5

Références $component, DIRECTORY_SEPARATOR, 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, JPath\find(), JLoader\import(), et json_encode.

◆ 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.

◆ loadVersionSuffixes()

loadVersionSuffixes ( )

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

Renvoie
self
Depuis
3.5

◆ refreshIncludePaths()

refreshIncludePaths ( )
protected

Refresh the list of include paths

Renvoie
self
Depuis
3.2
Obsolète:
3.5 Use FileLayout::clearIncludePaths()

◆ removeIncludePath()

removeIncludePath (   $path)

Remove one path from the layout search

Paramètres
string$pathThe path to remove from the layout search
Renvoie
self
Depuis
3.2

Références $path.

◆ removeIncludePaths()

removeIncludePaths (   $paths)

Remove one or more paths to exclude in layout search

Paramètres
string$pathsThe path or array of paths to remove for the layout search
Renvoie
self
Depuis
3.2

◆ render()

render (   $displayData = array())

Method to render the layout.

Paramètres
array$displayDataArray 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$clientFrontend: 'site' or 0 | Backend: 'admin' or 1
Renvoie
void
Depuis
3.2

Références $client.

◆ setComponent()

setComponent (   $option)

Method to change the component where search for layouts

Paramètres
string$optionURL 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$pathsArray with paths to search in
Renvoie
self
Depuis
3.5

◆ setLayout()

setLayout (   $layoutId)

Change the layout

Paramètres
string$layoutIdLayout to render
Renvoie
self
Depuis
3.2
Obsolète:
3.5 Use setLayoutId()

◆ setLayoutId()

setLayoutId (   $layoutId)

Set the active layout id

Paramètres
string$layoutIdLayout identifier
Renvoie
self
Depuis
3.5

Références null.

◆ setSuffixes()

setSuffixes ( array  $suffixes)

Set suffixes to search layouts

Paramètres
mixed$suffixesString with a single suffix or 'auto' | 'none' or array of suffixes
Renvoie
self
Depuis
3.5

◆ sublayout()

sublayout (   $layoutId,
  $displayData 
)

Render a layout with the same include paths & options

Paramètres
string$layoutIdThe identifier for the sublayout to be searched in a subfolder with the name of the current layout
mixed$displayDataData 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$optionURL 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 :