JApplication
From Joomla! Documentation
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JApplication[edit]
Description[edit]
JApplication is the base class for a Joomla Application. It acts as a Factory class for application specific objects and provides many supporting API functions. Derived clases should supply the route(), dispatch() and render() functions.
Methods[edit]
Visibility | Method name | Description |
---|---|---|
public | __construct | Class constructor. |
public | __toString | Returns the response. |
public | checkSession | Checks the user session. |
public | close | Exit the application. |
public | dispatch | Dispatch the applicaiton. |
public | enqueueMessage | Enqueue a system message. |
public | getCfg | |
public | getClientId | Gets the client id of the current running application. |
public | getMenu | Returns the application object. |
public | getMessageQueue | Get the system message queue. |
public | getName | Method to get the application name. |
public | getPathway | Returns the application object. |
public | getTemplate | Gets the name of the current template. |
public | getUserState | Gets a user state. |
public | getUserStateFromRequest | Gets the value of a user state variable. |
public | initialise | Initialise the application. |
public | isAdmin | Is admin interface? |
public | isSite | Is site interface? |
public | login | Login authentication function. |
public | logout | Logout authentication function. |
public | redirect | Redirect to another URL. |
public | render | Render the application. |
public | route | Route the application. |
public | setUserState | Sets the value of a user state variable. |
public | triggerEvent | Calls all handlers associated with an event group. |
public static | getHash | Provides a secure hash based on a seed. |
public static | getInstance | Returns the global object, only creating it if it doesn't already exist. |
public static | getRouter | Returns the application object. |
public static | isWinOS | Method to determine if the host OS is Windows. |
public static | registerEvent | Registers a handler to a particular event group. |
public static | stringURLSafe | This method transliterates a string into an URL safe string or returns a URL safe UTF-8 string based on the global configuration. |
protected | _createConfiguration | Create the configuration registry. |
protected | _createSession | Create the user session. |
- Defined in libraries/joomla/application/application.php
- Extends JObject
Importing[edit]
jimport( 'joomla.application.application' );
See also[edit]
- JApplication source code on BitBucket
- Subpackage Application
- Other versions of JApplication
See Also[edit]
- JApplication on api.joomla.org
- JApplication source code on JoomlaCode
- Subpackage Application
User contributed notes[edit]
Code Examples[edit]