JLayoutHelper
Description
Helper to render a JLayout object, storing a base path
Located in /libraries/cms/layout/helper.php (line 20)
Direct descendents
| Class | Description |
|---|---|
FOFLayoutHelper
|
Helper to render a FOFLayout object, storing a base path |
Variable Summary
Method Summary
static string
render
(string $layoutFile, [object $displayData = null], [string $basePath = ''], [mixed $options = null])
Variables
static string
$defaultBasePath
= '' (line 29)
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
Methods
Method to render the layout.
static string
render
(string $layoutFile, [object $displayData = null], [string $basePath = ''], [mixed $options = null])
- string $layoutFile: Dot separated path to the layout file, relative to base path
- object $displayData: Object which properties are used inside the layout file to build displayed output
- string $basePath: Base path to use when loading layout files
- mixed $options: Optional custom options to load. JRegistry or array format
Redefined in descendants as:
- FOFLayoutHelper::render() : Method to render the layout.
Documentation generated on Tue, 19 Nov 2013 15:04:26 +0100 by phpDocumentor 1.4.3