Class JLayoutFile

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

JLayoutBase implements JLayout

JLayoutFile

Direct known subclasses

FOFLayoutFile

Package: Joomla\Libraries\Layout
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 3.0
Link: https://docs.joomla.org/Special:MyLanguage/Sharing_layouts_across_views_or_extensions_with_JLayout
Located at cms/layout/file.php

Methods summary

`public`	# `__construct( string $layoutId, string $basePath = null, mixed $options = null )` Method to instantiate the file-based layout. Method to instantiate the file-based layout. Parameters `$layoutId` `string` - $layoutId Dot separated path to the layout file, relative to base path `$basePath` `string` - $basePath Base path to use when loading layout files `$options` `mixed` - $options Optional custom options to load. Registry or array format [@since 3.2] Since 3.0
`public string`	# `render( array $displayData = array() )` Method to render the layout. Method to render the layout. Parameters `$displayData` `array` - $displayData Array of properties available for use inside the layout file to build the displayed output Returns `string` - The necessary HTML to display the layout Since 3.0 Overrides `JLayoutBase::render`
`protected string`	# `getPath( )` Method to finds the full real file path, checking possible overrides Method to finds the full real file path, checking possible overrides Returns `string` - The full path to the layout file Since 3.0
`public JLayoutFile`	# `addIncludePath( string $path )` Add one path to include in layout search. Proxy of addIncludePaths() Add one path to include in layout search. Proxy of addIncludePaths() Parameters `$path` `string` - $path The path to search for layouts Returns `JLayoutFile` Since 3.2
`public JLayoutFile`	# `addIncludePaths( string $paths )` Add one or more paths to include in layout search Add one or more paths to include in layout search Parameters `$paths` `string` - $paths The path or array of paths to search for layouts Returns `JLayoutFile` Since 3.2
`public JLayoutFile`	# `clearIncludePaths( )` Clear the include paths Clear the include paths Returns `JLayoutFile` Since 3.5
`public array`	# `getIncludePaths( )` Get the active include paths Get the active include paths Returns `array` Since 3.5
`public string`	# `getLayoutId( )` Get the active layout id Get the active layout id Returns `string` Since 3.5
`public array`	# `getSuffixes( )` Get the active suffixes Get the active suffixes Returns `array` Since 3.5
`public JLayoutFile`	# `loadLanguageSuffixes( )` Load the automatically generated language suffixes. Example: array('es-ES', 'es', 'ltr') Load the automatically generated language suffixes. Example: array('es-ES', 'es', 'ltr') Returns `JLayoutFile` Since 3.5
`public JLayoutFile`	# `loadVersionSuffixes( )` Load the automatically generated version suffixes. Example: array('j311', 'j31', 'j3') Load the automatically generated version suffixes. Example: array('j311', 'j31', 'j3') Returns `JLayoutFile` Since 3.5
`public JLayoutFile`	# `removeIncludePath( string $path )` Remove one path from the layout search Remove one path from the layout search Parameters `$path` `string` - $path The path to remove from the layout search Returns `JLayoutFile` Since 3.2
`public JLayoutFile`	# `removeIncludePaths( string $paths )` Remove one or more paths to exclude in layout search Remove one or more paths to exclude in layout search Parameters `$paths` `string` - $paths The path or array of paths to remove for the layout search Returns `JLayoutFile` Since 3.2
`protected boolean`	# `validComponent( string $option = null )` Validate that the active component is valid Validate that the active component is valid Parameters `$option` `string` - $option URL Option of the component. Example: com_content Returns `boolean` Since 3.2
`public mixed`	# `setComponent( string $option )` Method to change the component where search for layouts Method to change the component where search for layouts Parameters `$option` `string` - $option URL Option of the component. Example: com_content Returns `mixed` - Component option string \| null for none Since 3.2
`public`	# `setClient( mixed $client )` Function to initialise the application client Function to initialise the application client Parameters `$client` `mixed` - $client Frontend: 'site' or 0 \| Backend: 'admin' or 1 Since 3.2
`public JLayoutFile`	# `setLayout( string $layoutId )` Change the layout Change the layout Deprecated 3.5 Use setLayoutId() Parameters `$layoutId` `string` - $layoutId Layout to render Returns `JLayoutFile` Since 3.2
`public JLayoutFile`	# `setLayoutId( string $layoutId )` Set the active layout id Set the active layout id Parameters `$layoutId` `string` - $layoutId Layout identifier Returns `JLayoutFile` Since 3.5
`protected JLayoutFile`	# `refreshIncludePaths( )` Refresh the list of include paths Refresh the list of include paths Deprecated 3.5 Use JLayoutFile::clearIncludePaths() Returns `JLayoutFile` Since 3.2
`public array`	# `getDefaultIncludePaths( )` Get the default array of include paths Get the default array of include paths Returns `array` Since 3.5
`public JLayoutFile`	# `setIncludePaths( array $paths )` Set the include paths to search for layouts Set the include paths to search for layouts Parameters `$paths` `array` - $paths Array with paths to search in Returns `JLayoutFile` Since 3.5
`public JLayoutFile`	# `setSuffixes( array $suffixes )` Set suffixes to search layouts Set suffixes to search layouts Parameters `$suffixes` `mixed` - $suffixes String with a single suffix or 'auto' \| 'none' or array of suffixes Returns `JLayoutFile` Since 3.5
`public string`	# `sublayout( string $layoutId, mixed $displayData )` Render a layout with the same include paths & options Render a layout with the same include paths & options Parameters `$layoutId` `string` - $layoutId The identifier for the sublayout to be searched in a subfolder with the name of the current layout `$displayData` `mixed` - $displayData Data to be rendered Returns `string` - The necessary HTML to display the layout Since 3.2

Methods inherited from JLayoutBase

addDebugMessage(), clearDebugMessages(), debug(), escape(), get(), getData(), getDebugMessages(), getOptions(), isDebugEnabled(), renderDebugMessages(), resetOptions(), set(), setData(), setDebug(), setOptions()

Magic methods summary

Properties summary

`protected static array`	`$cache`	# Cached layout paths Cached layout paths Since 3.5
`protected string`	`$layoutId`	# Dot separated path to the layout file, relative to base path Dot separated path to the layout file, relative to base path Since 3.0
`protected string`	`$basePath`	# Base path to use when loading layout files Base path to use when loading layout files Since 3.0
`protected string`	`$fullPath`	# Full path to actual layout files, after possible template override check Full path to actual layout files, after possible template override check Since 3.0.3
`protected array`	`$includePaths`	# Paths to search for layouts Paths to search for layouts Since 3.2

Properties inherited from JLayoutBase

$data, $debugMessages, $options

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JLayoutFile

Direct known subclasses

Methods summary

Parameters

Since

Parameters

Returns

Since

Overrides

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Since

Deprecated

Parameters

Returns

Since

Parameters

Returns

Since

Deprecated

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Methods inherited from JLayoutBase

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Properties inherited from JLayoutBase