Class JLayoutHelper

Helper to render a JLayout object, storing a base path

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.1
Link: https://docs.joomla.org/Special:MyLanguage/Sharing_layouts_across_views_or_extensions_with_JLayout
Located at cms/layout/helper.php

Methods summary

`public static string`	# `debug( string $layoutFile, object $displayData = null, string $basePath = '', mixed $options = null )` Method to render a layout with debug info Method to render a layout with debug info Parameters `$layoutFile` `string` - $layoutFile Dot separated path to the layout file, relative to base path `$displayData` `object` - $displayData Object which properties are used inside the layout file to build displayed output `$basePath` `string` - $basePath Base path to use when loading layout files `$options` `mixed` - $options Optional custom options to load. Registry or array format Returns `string` Since 3.5
`public static string`	# `render( string $layoutFile, object $displayData = null, string $basePath = '', mixed $options = null )` Method to render the layout. Method to render the layout. Parameters `$layoutFile` `string` - $layoutFile Dot separated path to the layout file, relative to base path `$displayData` `object` - $displayData Object which properties are used inside the layout file to build displayed output `$basePath` `string` - $basePath Base path to use when loading layout files `$options` `mixed` - $options Optional custom options to load. Registry or array format Returns `string` Since 3.1

`public static string`	`$defaultBasePath`	# A default base path that will be used if none is provided when calling the render method. Note that JLayoutFile itself will defaults to JPATH_ROOT . '/layouts' if no basePath is supplied at all A default base path that will be used if none is provided when calling the render method. Note that JLayoutFile itself will defaults to JPATH_ROOT . '/layouts' if no basePath is supplied at all Since 3.1