JApplication/1.5

JApplication

Description

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

Visibility	Method name	Description
public	__construct	Class constructor.
public	_createConfiguration	Create the configuration registry.
public	_createSession	Create the user session.
public	addCustomHeadTag	Deprecated, use JDocument->addCustomTag instead (only when document type is HTML).
public	addMetaTag	Deprecated, use JDocument->setMetaData instead.
public	appendMetaTag	Deprecated, use JDocument->setMetaData instead.
public	appendPathWay	Deprecated functions.
public	close	Exit the application.
public	dispatch	Dispatch the applicaiton.
public	enqueueMessage	Enqueue a system message.
public	getBasePath	Deprecated, use instead.
public	getBlogCategoryCount	Deprecated.
public	getBlogSectionCount	Deprecated.
public	getCfg
public	getClientId	Gets the client id of the current running application.
public	getContentItemLinkCount	Deprecated.
public	getCustomPathWay	Deprecated, use JPathway->getPathWayNames() method instead.
public	getGlobalBlogSectionCount	Deprecated.
public	getHead	Deprecated, use JDocument->get( 'head' ) instead.
public	getInstance	Returns a reference to the global object, only creating it if it doesn't already exist.
public	getItemid	Deprecated, use ContentHelper::getItemid instead.
public	getMenu	Return a reference to the application object.
public	getMessageQueue	Get the system message queue.
public	getName	Method to get the application name.
public	getPageTitle	Deprecated, use instead.
public	getPath	Deprecated, use instead.
public	getPathway	Return a reference to the application object.
public	getRouter	Return a reference to the application object.
public	getStaticContentCount	Deprecated.
public	getTemplate	Gets the name of the current template.
public	getUser	Deprecated, use instead.
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	prependMetaTag	Deprecated, use JDocument->setMetaData instead.
public	redirect	Redirect to another URL.
public	render	Render the application.
public	route	Route the application.
public	setPageTitle	Deprecated, use instead.
public	setUserState	Sets the value of a user state variable.
public	registerEvent	Registers a handler to a particular event group.
public	triggerEvent	Calls all handlers associated with an event group.

• Defined in libraries/joomla/application/application.php
• Extends JObject

Importing

jimport( 'joomla.application.application' );

See Also

• JApplication on api.joomla.org
• JApplication source code on JoomlaCode
• Subpackage Application
• Other versions of JApplication

User contributed notes

<CodeExamplesForm />