LayoutHelper
Helper to render a Layout object, storing a base path
| link | |
|---|---|
| since |
3.1 |
| package |
Joomla CMS |
Methods
debug
Method to render a layout with debug info
debug( layoutFile, displayData = null, basePath = '', options = null) :
| since |
3.5 |
|---|
Arguments
- layoutFile
stringDot separated path to the layout file, relative to base path- displayData
mixedObject which properties are used inside the layout file to build displayed output- basePath
stringBase path to use when loading layout files- options
mixedOptional custom options to load. Registry or array format
Response
string
render
Method to render the layout.
render( layoutFile, displayData = null, basePath = '', options = null) :
| since |
3.1 |
|---|
Arguments
- layoutFile
stringDot separated path to the layout file, relative to base path- displayData
mixedObject which properties are used inside the layout file to build displayed output- basePath
stringBase path to use when loading layout files- options
mixedOptional custom options to load. Registry or array format
Response
string
Properties
defaultBasePath
A default base path that will be used if none is provided when calling the render method.
Note that FileLayout itself will defaults to JPATH_ROOT . '/layouts' if no basePath is supplied at all
| since |
3.1 |
|---|
Type(s)
string