| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2013 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 1291 lines (42 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| __construct(Input $input = null, Registry $config = null, WebClient $client = null, Container $container = null) X-Ref |
| Class constructor. param: Input $input An optional argument to provide dependency injection for the application's input param: Registry $config An optional argument to provide dependency injection for the application's config param: WebClient $client An optional argument to provide dependency injection for the application's client param: Container $container Dependency injection container. |
| checkSession() X-Ref |
| Checks the user session. If the session record doesn't exist, initialise it. If session is new, create session variables return: void |
| enqueueMessage($msg, $type = self::MSG_INFO) X-Ref |
| Enqueue a system message. param: string $msg The message to enqueue. param: string $type The message type. Default is message. return: void |
| sanityCheckSystemVariables() X-Ref |
| Ensure several core system input variables are not arrays. return: void |
| execute() X-Ref |
| No description |
| checkUserRequireReset($option, $view, $layout, $tasks) X-Ref |
| Check if the user is required to reset their password. If the user is required to reset their password will be redirected to the page that manage the password reset. param: string $option The option that manage the password reset param: string $view The view that manage the password reset param: string $layout The layout of the view that manage the password reset param: string $tasks Permitted tasks return: void |
| getCfg($varname, $default = null) X-Ref |
| Gets a configuration value. param: string $varname The name of the value to get. param: string $default Default value to return return: mixed The user state. |
| getClientId() X-Ref |
| Gets the client id of the current running application. return: integer A client identifier. |
| getInstance($name = null, $prefix = '\JApplication', Container $container = null) X-Ref |
| Returns a reference to the global CmsApplication object, only creating it if it doesn't already exist. This method must be invoked as: $web = CmsApplication::getInstance(); param: string $name The name (optional) of the CmsApplication class to instantiate. param: string $prefix The class name prefix of the object. param: Container $container An optional dependency injection container to inject into the application. return: CmsApplication |
| getMenu($name = null, $options = array() X-Ref |
| Returns the application \JMenu object. param: string $name The name of the application/client. param: array $options An optional associative array of configuration settings. return: AbstractMenu |
| getMessageQueue($clear = false) X-Ref |
| Get the system message queue. param: boolean $clear Clear the messages currently attached to the application object return: array The system message queue. |
| getName() X-Ref |
| Gets the name of the current running application. return: string The name of the application. |
| getPathway() X-Ref |
| Returns the application Pathway object. return: Pathway |
| 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 |
| getTemplate($params = false) X-Ref |
| Gets the name of the current template. param: boolean $params An optional associative array of configuration settings return: mixed System is the fallback. |
| 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. |
| initialiseApp($options = array() X-Ref |
| Initialise the application. param: array $options An optional associative array of configuration settings. return: void |
| isHttpsForced($clientId = null) X-Ref |
| Checks if HTTPS is forced in the client configuration. param: integer $clientId An optional client id (defaults to current application client). return: boolean True if is forced for the client, false otherwise. |
| isClient($identifier) X-Ref |
| Check the client interface by name. param: string $identifier String identifier for the application interface return: boolean True if this application is of the given type client interface. |
| loadLibraryLanguage() X-Ref |
| Load the library language files for the application return: void |
| login($credentials, $options = array() X-Ref |
| Login authentication function. Username and encoded password are passed the onUserLogin event which is responsible for the user validation. A successful validation updates the current session record with the user's details. Username and encoded password are sent as credentials (along with other possibilities) to each observer (authentication plugin) for user validation. Successful validation will update the current session with the user details. param: array $credentials Array('username' => string, 'password' => string) param: array $options Array('remember' => boolean) return: boolean|\Exception True on success, false if failed or silent handling is configured, or a \Exception object on authentication error. |
| logout($userid = null, $options = array() X-Ref |
| Logout authentication function. Passed the current user information to the onUserLogout event and reverts the current session record back to 'anonymous' parameters. If any of the authentication plugins did not successfully complete the logout routine then the whole method fails. Any errors raised should be done in the plugin as this provides the ability to give much more information about why the routine may have failed. param: integer $userid The user to load - Can be an integer or string - If string, it is converted to ID automatically param: array $options Array('clientid' => array of client id's) return: boolean True on success |
| redirect($url, $status = 303) X-Ref |
| Redirect to another URL. If the headers have not been sent the redirect will be accomplished using a "301 Moved Permanently" or "303 See Other" code in the header pointing to the new location. If the headers have already been sent this will be accomplished using a JavaScript statement. param: string $url The URL to redirect to. Can only be http/https URL param: integer $status The HTTP 1.1 status code to be provided. 303 is assumed by default. return: void |
| render() X-Ref |
| Rendering is the process of pushing the document buffers into the template placeholders, retrieving data from the document and pushing it into the application response buffer. return: void |
| route() X-Ref |
| Route the application. Routing is the process of examining the request environment to determine which component should receive the request. The component optional parameters are then set in the request object to be processed when the application is being dispatched. return: void |
| 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. |
| toString($compress = false) X-Ref |
| Sends all headers prior to returning the string param: boolean $compress If true, compress the data return: string |
| getFormToken($forceNew = false) X-Ref |
| Method to determine a hash for anti-spoofing variable names param: boolean $forceNew If true, force a new token to be created return: string Hashed var name |
| checkToken($method = 'post') X-Ref |
| Checks for a form token in the request. Use in conjunction with getFormToken. param: string $method The request method in which to look for the token key. return: boolean True if found and valid, false otherwise. |
| isCli() X-Ref |
| Flag if the application instance is a CLI or web based application. Helper function, you should use the native PHP functions to detect if it is a CLI application. return: boolean |
| isTwoFactorAuthenticationRequired() X-Ref |
| No longer used return: boolean |
| hasUserConfiguredTwoFactorAuthentication() X-Ref |
| No longer used return: boolean |
| setupLogging() X-Ref |
| Setup logging functionality. return: void |
| setMenuFactory(MenuFactoryInterface $menuFactory) X-Ref |
| Sets the internal menu factory. param: MenuFactoryInterface $menuFactory The menu factory return: void |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |