Class constructor. Builds a new JApplication object for the specified client application. Subclasses generally do not require the $config parameter. The $config array will contain at least four elements:

JApplication __construct([$config = array()])

This method closes the application gracefully.

void close($code)

This abstract method pulls the option from the request object, maps it to the relevant component, and executes the component, storing the rendered result in the global JDocument object. If the component does not exist, it determines a default component to dispatch. Descendant classes should provide their own dispatch() method.

void dispatch($component)

This method adds a new message to the application message queue and clears the session message queue.

void enqueueMessage($msg, [$type = 'message'])

This method returns a configuration value

mixed getCfg($varname)

This method returns the client id of the application currently running.

integer getClientId()

This method returns a reference to the global JApplication object. If the application object does not exist, it creates it.

JApplication &getInstance($client, [$config = array()], [string $prefix ='J'])

This method returns a reference to the application JMenu object.

JMenu &getMenu([$name = null], [$options = array()])

This method returns a copy of the application message queue. If no application messages exist and there are session messages, the session message queue will be moved to the application message queue.

array getMessageQueue()

This method returns the application dispatcher name. By default, it is derived from the class name, or it can be set by passing a $config['name'] in the application class constructor.

string getName()

This method returns a reference to the application JPathway object that maintains an array of breadcrumbs.

JPathway &getPathway([$name = null], [$options = array()])

This method returns a reference to the application JRouter object.

JRouter &getRouter([$name = null], [$options = array()])

This method returns the name of the current application template. This method must always be overridden by a subclass. The base JApplication::getTemplate() method simply returns 'system'. Subclasses (JAdministrator and JSite for example) that extend JApplication override this method to return the current template.

string getTemplate()

This method returns a value from the user session registry.

mixed getUserState($key)

This method updates and returns a value from the user state registry. If a $default value is provided and the $key does not exist it will be inserted into the user state registry. For valid type values see JFilterInput::clean().

string getUserState($key, $request, [$default = null], [$type = 'none'])

This method initializes the application. Prepares the application language, defines date formats, and builds the application router. Subclasses JSite and JAdministrator have their own initialise() method that call parent::initialise() to complete their initialization process.

void initialise([$options = array()])

This method determines whether the current application is the administrator backend (ClientID is 1.)

boolean isAdmin()

This method determines whether the current application is the site frontend(ClientID is 0.)

boolean isSite()

This method passes the username and encoded password to the onLoginUser event, which is responsible for user validation. The username and encoded password are sent as credentials (along with other possibilities) to each observer (authentication plugin) for user validation. A successful validation updates the current session record with the user's details.

boolean login($credentials, [$options = array()])

If a user is logged-in, this method logs the user out. It passes the current user information to the onLogoutUser event and reverts the current session record back to anonymous parameters.

boolean logout([$userid = null], [$options = array()])

This method redirects the application to the specified URL and optionally enqueues a message in the system message queue (which will be displayed the next time a page is loaded) using the enqueueMessage method. This method closes the application. If the headers have not been sent the redirect will be accomplished using a "301 Moved Permanently" code in the header pointing to the new location. If the headers have already been sent this will be accomplished using a JavaScript statement.

void redirect($url, [$msg = ''], [$msgType = 'message'])

This method registers a handler to a particular event group with the global event dispatcher.

void registerEvent($event, $handler)

This method renders the response by pushing the document buffers into the template placeholders, retrieving data from the document and pushing it into the JResponse buffer. Descendant classes should provide their own render() method.

void render()

This method routes the application by examining the request environment to determine which component should receive the request. The component optional parameters are then set in the request object that will be processed when the application is dispatched. This method chooses the route through the application based on the request URI. Descendant classes should provide their own route() method.

void route()

This method sets the value of a user state variable.

mixed setUserState($key, $value)

This method will notify any registered event handlers that are associated with the event that an event has occurred. $args is exploded and each element is passed as an individual argument to the handler.

array triggerEvent($event, [$args = null])