| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2012 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 299 lines (6 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
BaseLayout:: (16 methods):
setOptions()
getOptions()
resetOptions()
escape()
getDebugMessages()
render()
renderDebugMessages()
addDebugMessage()
clearDebugMessages()
debug()
get()
getData()
isDebugEnabled()
set()
setData()
setDebug()
Class: BaseLayout - X-Ref
Base class for rendering a display layout| setOptions($options = null) X-Ref |
| Set the options param: array|Registry $options Array / Registry object with the options to load return: BaseLayout Instance of $this to allow chaining. |
| getOptions() X-Ref |
| Get the options return: Registry Object with the options |
| resetOptions() X-Ref |
| Function to empty all the options return: BaseLayout Instance of $this to allow chaining. |
| escape($output) X-Ref |
| Method to escape output. param: string $output The output to escape. return: string The escaped output. |
| getDebugMessages() X-Ref |
| Get the debug messages array return: array |
| render($displayData) X-Ref |
| Method to render the layout. param: array $displayData Array of properties available for use inside the layout file to build the displayed output return: string The necessary HTML to display the layout |
| renderDebugMessages() X-Ref |
| Render the list of debug messages return: string Output text/HTML code |
| addDebugMessage($message) X-Ref |
| Add a debug message to the debug messages array param: string $message Message to save return: self |
| clearDebugMessages() X-Ref |
| Clear the debug messages array return: self |
| debug($data = array() X-Ref |
| Render a layout with debug info param: mixed $data Data passed to the layout return: string |
| get($key, $defaultValue = null) X-Ref |
| Method to get the value from the data array param: string $key Key to search for in the data array param: mixed $defaultValue Default value to return if the key is not set return: mixed Value from the data array | defaultValue if doesn't exist |
| getData() X-Ref |
| Get the data being rendered return: array |
| isDebugEnabled() X-Ref |
| Check if debug mode is enabled return: boolean |
| set($key, $value) X-Ref |
| Method to set a value in the data array. Example: $layout->set('items', $items); param: string $key Key for the data array param: mixed $value Value to assign to the key return: self |
| setData(array $data) X-Ref |
| Set the the data passed the layout param: array $data Array with the data for the layout return: self |
| setDebug($debug) X-Ref |
| Change the debug mode param: boolean $debug Enable / Disable debug return: self |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |