API17

JApplication

From Joomla! Documentation

Revision as of 17:48, 23 April 2011 by Doxiki2 (talk | contribs) (Layout updates)

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.

[Edit Descripton] Template:Description:JApplication

Defined in[edit]

libraries/joomla/application/application.php

Subpackage[edit]

Application

Extends[edit]

JObject

Extended by[edit]

Methods[edit]

Method name Description
__construct Class constructor.
__toString Returns the response.
checkSession Checks the user session.
close Exit the application.
dispatch Dispatch the applicaiton.
enqueueMessage Enqueue a system message.
getCfg
getClientId Gets the client id of the current running application.
getMenu Returns the application object.
getMessageQueue Get the system message queue.
getName Method to get the application name.
getPathway Returns the application object.
getTemplate Gets the name of the current template.
getUserState Gets a user state.
getUserStateFromRequest Gets the value of a user state variable.
initialise Initialise the application.
isAdmin Is admin interface?
isSite Is site interface?
login Login authentication function.
logout Logout authentication function.
redirect Redirect to another URL.
render Render the application.
route Route the application.
setUserState Sets the value of a user state variable.
triggerEvent Calls all handlers associated with an event group.
getHash Provides a secure hash based on a seed.
getInstance Returns the global object, only creating it if it doesn't already exist.
getRouter Returns the application object.
isWinOS Method to determine if the host OS is Windows.
registerEvent Registers a handler to a particular event group.
stringURLSafe This method transliterates a string into an URL safe string or returns a URL safe UTF-8 string based on the global configuration.
_createConfiguration Create the configuration registry.
_createSession Create the user session.

Importing[edit]

jimport( 'joomla.application.application' );

See also[edit]

Template:SeeAlso:JApplication [Edit See Also]

Examples[edit]

<CodeExamplesForm />