 |
Joomla CMS
3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
|
|
Joomla CMS
3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
|
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() |
Base class for rendering a display layout loaded from from a layout file
Method to instantiate the file-based layout.
| 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 [ |
| addIncludePath | ( | $path | ) |
Add one path to include in layout search. Proxy of addIncludePaths()
| string | $path | The path to search for layouts |
Références $path.
| addIncludePaths | ( | $paths | ) |
Add one or more paths to include in layout search
| string|string[] | $paths The path or array of paths to search for layouts |
| clearIncludePaths | ( | ) |
Clear the include paths
| getDefaultIncludePaths | ( | ) |
Get the default array of include paths
Références $component, DIRECTORY_SEPARATOR, JPATH_ADMINISTRATOR, JPATH_ROOT, JPATH_SITE, JPATH_THEMES, et null.
| getIncludePaths | ( | ) |
Get the active include paths
| getLayoutId | ( | ) |
Get the active layout id
|
protected |
Method to finds the full real file path, checking possible overrides
Références $hash, $suffix, JLoader\import(), et json_encode.
| getSuffixes | ( | ) |
Get the active suffixes
| loadLanguageSuffixes | ( | ) |
Load the automatically generated language suffixes. Example: array('es-ES', 'es', 'ltr')
Références $lang.
| loadVersionSuffixes | ( | ) |
Load the automatically generated version suffixes. Example: array('j311', 'j31', 'j3')
|
protected |
Refresh the list of include paths
| removeIncludePath | ( | $path | ) |
Remove one path from the layout search
| string | $path | The path to remove from the layout search |
Références $path.
| removeIncludePaths | ( | $paths | ) |
Remove one or more paths to exclude in layout search
| string | $paths | The path or array of paths to remove for the layout search |
| render | ( | $displayData = array() | ) |
Method to render the layout.
| array | $displayData | Array of properties available for use inside the layout file to build the displayed output |
Implémente LayoutInterface.
Références $displayData, et $path.
| setClient | ( | $client | ) |
Function to initialise the application client
| mixed | $client | Frontend: 'site' or 0 | Backend: 'admin' or 1 |
Références $client.
| setComponent | ( | $option | ) |
Method to change the component where search for layouts
| string | $option | URL Option of the component. Example: com_content |
Références $component, $option, ApplicationHelper\getComponentName(), et null.
| setIncludePaths | ( | $paths | ) |
Set the include paths to search for layouts
| array | $paths | Array with paths to search in |
| setLayout | ( | $layoutId | ) |
Change the layout
| string | $layoutId | Layout to render |
| setLayoutId | ( | $layoutId | ) |
| setSuffixes | ( | array | $suffixes | ) |
Set suffixes to search layouts
| mixed | $suffixes | String with a single suffix or 'auto' | 'none' or array of suffixes |
| sublayout | ( | $layoutId, | |
| $displayData | |||
| ) |
Render a layout with the same include paths & options
| 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 |
Références $basePath, $displayData, $options, et $sublayout.
|
protected |
Validate that the active component is valid
| string | $option | URL Option of the component. Example: com_content |
Références $component, $option, ComponentHelper\isEnabled(), et null.
|
protected |
|
staticprotected |
|
protected |
|
protected |
|
protected |
