| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2020 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE |
| File Size: | 100 lines (3 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
CMSWebApplicationInterface:: (6 methods):
getDocument()
getMenu()
getRouter()
getUserState()
getUserStateFromRequest()
setUserState()
Interface: CMSWebApplicationInterface - X-Ref
Interface defining a Joomla! CMS Application class for web applications.| getDocument() X-Ref |
| Method to get the application document object. return: Document The document object |
| getMenu($name = null, $options = array() X-Ref |
| Get the menu object. param: string $name The application name for the menu param: array $options An array of options to initialise the menu with return: AbstractMenu|null An AbstractMenu object or null if not set. |
| getRouter($name = null, array $options = array() X-Ref |
| Returns the application Router object. param: string $name The name of the application. param: array $options An optional associative array of configuration settings. return: Router |
| getUserState($key, $default = null) X-Ref |
| Gets a user state. param: string $key The path of the state. param: mixed $default Optional default value, returned if the internal value is null. return: mixed The user state or null. |
| getUserStateFromRequest($key, $request, $default = null, $type = 'none') X-Ref |
| Gets the value of a user state variable. param: string $key The key of the user state variable. param: string $request The name of the variable passed in a request. param: string $default The default value for the variable if not found. Optional. param: string $type Filter for the variable, for valid values see {@link InputFilter::clean()}. Optional. return: mixed The request user state. |
| setUserState($key, $value) X-Ref |
| Sets the value of a user state variable. param: string $key The path of the state. param: mixed $value The value of the variable. return: mixed|void The previous state, if one existed. Void otherwise. |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |