From Joomla! Documentation

The "API15" 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 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[edit]



Method name Description
__construct Class constructor.
getInstance Returns a reference to the global JApplication object, only creating it if it doesn't already exist.
initialise Initialise the application.
route Route the application.
dispatch Dispatch the applicaiton.
render Render the application.
close Exit the application.
redirect Redirect to another URL.
enqueueMessage Enqueue a system message.
getMessageQueue Get the system message queue.
getName Method to get the application name
getUserState Gets a user state.
setUserState Sets the value of a user state variable.
getUserStateFromRequest Gets the value of a user state variable.
login Login authentication function.
logout Logout authentication function.
getTemplate Gets the name of the current template.
getRouter Return a reference to the application JRouter object.
getPathway Return a reference to the application JPathway object.
getMenu Return a reference to the application JPathway object.
getClientId Gets the client id of the current running application.
isAdmin Is admin interface?
isSite Is site interface?
appendPathWay Deprecated functions Deprecated, use JPathWay->addItem() method instead.
getCustomPathWay Deprecated, use JPathway->getPathWayNames() method instead.
getHead Deprecated, use JDocument->get( 'head' ) instead.
addMetaTag Deprecated, use JDocument->setMetaData instead.
appendMetaTag Deprecated, use JDocument->setMetaData instead.
prependMetaTag Deprecated, use JDocument->setMetaData instead
addCustomHeadTag Deprecated, use JDocument->addCustomTag instead (only when document type is HTML).
getBlogSectionCount Deprecated.
getBlogCategoryCount Deprecated.
getGlobalBlogSectionCount Deprecated.
getStaticContentCount Deprecated.
getContentItemLinkCount Deprecated.
getPath Deprecated, use JApplicationHelper::getPath instead.
getBasePath Deprecated, use JURI::base() instead.
getUser Deprecated, use JFactory::getUser instead.
getItemid Deprecated, use ContentHelper::getItemid instead.
setPageTitle Deprecated, use JDocument::setTitle instead.
getPageTitle Deprecated, use JDocument::getTitle instead.
registerEvent Registers a handler to a particular event group.
triggerEvent Calls all handlers associated with an event group.


jimport( 'joomla.application.application' );

See Also[edit]


Code Examples[edit]