Joomla! Administrator Application class

• since: 3.2

Located in /libraries/cms/application/administrator.php (line 19)

JApplicationBase
   |
   --JApplicationWeb
      |
      --JApplicationCms
         |
         --JApplicationAdministrator

Inherited Variables

Inherited from JApplicationCms

JApplicationCms::$docOptions
JApplicationCms::$instances
JApplicationCms::$profiler
JApplicationCms::$scope
JApplicationCms::$template
JApplicationCms::$useStrongEncryption
JApplicationCms::$_clientId
JApplicationCms::$_messageQueue
JApplicationCms::$_name

Inherited from JApplicationWeb

JApplicationWeb::$charSet
JApplicationWeb::$client
JApplicationWeb::$config
JApplicationWeb::$document
JApplicationWeb::$instance
JApplicationWeb::$language
JApplicationWeb::$mimeType
JApplicationWeb::$modifiedDate
JApplicationWeb::$response
JApplicationWeb::$session

Inherited from JApplicationBase

JApplicationBase::$dispatcher
JApplicationBase::$identity
JApplicationBase::$input

static getRouter (line 159)

Return a reference to the JRouter object.

• since: 3.2
• access: public

static JRouter getRouter ([string $name = 'administrator'], [array $options = array()])

• string $name: The name of the application.
• array $options: An optional associative array of configuration settings.

static purgeMessages (line 348)

Purge the jos_messages table of old messages

• since: 3.2
• access: public

static void purgeMessages ()

Constructor __construct (line 36)

Class constructor.

• since: 3.2
• access: public

JApplicationAdministrator __construct ([JInput $input = null], [JRegistry $config = null], [JApplicationWebClient $client = null])

• mixed $input: An optional argument to provide dependency injection for the application's input object. If the argument is a JInput object that object will become the application's input object, otherwise a default input object is created.
• mixed $config: An optional argument to provide dependency injection for the application's config object. If the argument is a JRegistry object that object will become the application's config object, otherwise a default config object is created.
• mixed $client: An optional argument to provide dependency injection for the application's client object. If the argument is a JApplicationWebClient object that object will become the application's client object, otherwise a default client object is created.

---

Redefinition of:

JApplicationCms::__construct()

Class constructor.

dispatch (line 60)

Dispatch the application

• since: 3.2
• access: public

void dispatch ([string $component = null])

• string $component: The component which is being rendered.

doExecute (line 113)

Method to run the Web application routines.

• since: 3.2
• access: protected

void doExecute ()

---

Redefinition of:

JApplicationWeb::doExecute()

Method to run the Web application routines. Most likely you will want to instantiate a controller and execute it, or perform some sort of action that populates a JDocument object so that output can be rendered to the client.

getTemplate (line 174)

Gets the name of the current template.

• return: The name of the template.
• since: 3.2
• throws: InvalidArgumentException
• access: public

string getTemplate ([boolean $params = false])

• boolean $params: True to return the template parameters

initialiseApp (line 240)

Initialise the application.

• since: 3.2
• access: protected

void initialiseApp ([array $options = array()])

• array $options: An optional associative array of configuration settings.

login (line 310)

Login authentication function

• return: True on success.
• since: 3.2
• access: public

boolean login (array $credentials, [array $options = array()])

• array $credentials: Array('username' => string, 'password' => string)
• array $options: Array('remember' => boolean)

render (line 398)

Rendering is the process of pushing the document buffers into the template placeholders, retrieving data from the document and pushing it into the application response buffer.

• since: 3.2
• access: protected

void render ()

---

Redefinition of:

JApplicationWeb::render()

Rendering is the process of pushing the document buffers into the template placeholders, retrieving data from the document and pushing it into the application response buffer.

route (line 444)

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.

• since: 3.2
• access: protected

void route ()

Inherited Methods

Inherited From JApplicationCms

JApplicationCms::__construct()
JApplicationCms::afterSessionStart()
JApplicationCms::checkSession()
JApplicationCms::enqueueMessage()
JApplicationCms::execute()
JApplicationCms::getCfg()
JApplicationCms::getClientId()
JApplicationCms::getInstance()

Inherited From JApplicationWeb

JApplicationWeb::__construct()
JApplicationWeb::afterSessionStart()
JApplicationWeb::allowCache()
JApplicationWeb::appendBody()
JApplicationWeb::checkConnectionAlive()
JApplicationWeb::checkHeadersSent()
JApplicationWeb::clearHeaders()
JApplicationWeb::compress()
JApplicationWeb::detectRequestUri()
JApplicationWeb::doExecute()
JApplicationWeb::execute()
JApplicationWeb::fetchConfigurationData()
JApplicationWeb::flushAssets()
JApplicationWeb::get()
JApplicationWeb::getBody()
JApplicationWeb::getDocument()
JApplicationWeb::getHeaders()
JApplicationWeb::getInstance()
JApplicationWeb::getLanguage()
JApplicationWeb::getSession()
JApplicationWeb::header()
JApplicationWeb::initialise()
JApplicationWeb::isSSLConnection()
JApplicationWeb::loadConfiguration()
JApplicationWeb::loadDocument()
JApplicationWeb::loadLanguage()
JApplicationWeb::loadSession()
JApplicationWeb::loadSystemUris()
JApplicationWeb::prependBody()
JApplicationWeb::redirect()
JApplicationWeb::render()
JApplicationWeb::respond()
JApplicationWeb::sendHeaders()
JApplicationWeb::set()
JApplicationWeb::setBody()
JApplicationWeb::setHeader()

Inherited From JApplicationBase

JApplicationBase::close()
JApplicationBase::getIdentity()
JApplicationBase::loadDispatcher()
JApplicationBase::loadIdentity()
JApplicationBase::registerEvent()
JApplicationBase::triggerEvent()