Actions

API17

Difference between revisions of "JApplication"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
(Layout updates)
Line 6: Line 6:
 
===Defined in===
 
===Defined in===
 
libraries/joomla/application/application.php
 
libraries/joomla/application/application.php
 +
* see source code in [[jplatform:application/application.php|BitBucket]]
 
===Subpackage===
 
===Subpackage===
 
[[Subpackage Application/11.1|Application]]
 
[[Subpackage Application/11.1|Application]]
Line 120: Line 121:
 
<source lang="php">jimport( 'joomla.application.application' );</source>
 
<source lang="php">jimport( 'joomla.application.application' );</source>
 
===See also===
 
===See also===
 +
* JApplication source code in [[jplatform:application/application.php|BitBucket]]
 
* [[JApplication|Other versions of this class]]
 
* [[JApplication|Other versions of this class]]
 
{{SeeAlso:JApplication}}
 
{{SeeAlso:JApplication}}

Revision as of 16:48, 23 April 2011

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

[Edit Descripton] 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.

Defined in

libraries/joomla/application/application.php

Subpackage

Application

Extends

JObject

Extended by

Methods

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

jimport( 'joomla.application.application' );

See also

See Also

[Edit See Also]

Examples

<CodeExamplesForm />