JApplication
From Joomla! Documentation
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.
Contents |
Availability
Defined in
/libraries/joomla/application/application.php
Methods
| Method name | Description |
|---|---|
| __construct | Class constructor. |
| __toString | Returns the response. |
| addCustomHeadTag | Deprecated, use JDocument->addCustomTag instead (only when document type is HTML). |
| addMetaTag | Deprecated, use JDocument->setMetaData instead. |
| appendMetaTag | Deprecated, use JDocument->setMetaData instead. |
| appendPathWay | Deprecated, use JPathWay->addItem() method instead. |
| close | Exit the application. |
| dispatch | Dispatch the applicaiton. |
| enqueueMessage | Enqueue a system message. |
| getBasePath | Deprecated, use JURI::base() instead. |
| getBlogCategoryCount | Deprecated. |
| getBlogSectionCount | Deprecated. |
| getCfg | Gets a configuration value. |
| getClientId | Gets the client id of the current running application. |
| getContentItemLinkCount | Deprecated. |
| getCustomPathWay | Deprecated, use JPathway->getPathWayNames() method instead. |
| getGlobalBlogSectionCount | Deprecated. |
| getHead | Deprecated, use JDocument->get( 'head' ) instead. |
| getInstance | Returns a reference to the global JApplication object, only creating it if it doesn't already exist. |
| getItemid | Deprecated, use ContentHelper::getItemid instead. |
| getMenu | Return a reference to the application JPathway object. |
| getMessageQueue | Get the system message queue. |
| getName | Method to get the application name |
| getPageTitle | Deprecated, use JDocument::getTitle instead. |
| getPath | Deprecated, use JApplicationHelper::getPath instead. |
| getPathway | Return a reference to the application JPathway object. |
| getRouter | Return a reference to the application JRouter object. |
| getStaticContentCount | Deprecated. |
| getTemplate | Gets the name of the current template. |
| getUser | Deprecated, use JFactory::getUser instead. |
| 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. |
| prependMetaTag | Deprecated, use JDocument->setMetaData instead |
| redirect | Redirect to another URL. |
| registerEvent | Registers a handler to a particular event group. |
| render | Render the application. Rendering is the process of pushing the document buffers into the template placeholders, retrieving data from the document and pushing it into the JResponse buffer. |
| route | Route the application. Routing is the process of examining the request environment to determine which component should receive the request. The component optional parameters are then set in the request object to be processed when the application is being dispatched. |
| setPageTitle | Deprecated, use JDocument::setTitle instead. |
| setUserState | Sets the value of a user state variable. |
| triggerEvent | Calls all handlers associated with an event group. |
Importing
jimport( 'joomla.application.application' );
