Class JApplicationAdministrator

Joomla! Administrator Application class

Joomla\Application\AbstractApplication implements Psr\Log\LoggerAwareInterface

JApplicationBase

JApplicationWeb

JApplicationCms

JApplicationAdministrator

Package: Joomla\Libraries\Application
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 3.2
Located at cms/application/administrator.php

Methods summary

`public`	# `__construct( JInput $input = null, Joomla\Registry\Registry $config = null, JApplicationWebClient $client = null )` Class constructor. Class constructor. Parameters `$input` `JInput` - $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. `$config` `Joomla\Registry\Registry` - $config An optional argument to provide dependency injection for the application's config object. If the argument is a Registry object that object will become the application's config object, otherwise a default config object is created. `$client` `JApplicationWebClient` - $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. Since 3.2 Overrides `JApplicationCms::__construct`
`public`	# `dispatch( string $component = null )` Dispatch the application Dispatch the application Parameters `$component` `string` - $component The component which is being rendered. Since 3.2
`protected`	# `doExecute( )` Method to run the Web application routines. Method to run the Web application routines. Since 3.2 Overrides `JApplicationBase::doExecute`
`public static JRouter`	# `getRouter( string $name = 'administrator', array $options = array() )` Return a reference to the JRouter object. Return a reference to the JRouter object. Parameters `$name` `string` - $name The name of the application. `$options` `array` - $options An optional associative array of configuration settings. Returns `JRouter` Since 3.2 Overrides `JApplicationCms::getRouter`
`public string`	# `getTemplate( boolean $params = false )` Gets the name of the current template. Gets the name of the current template. Parameters `$params` `boolean` - $params True to return the template parameters Returns `string` - The name of the template. Throws `InvalidArgumentException` Since 3.2 Overrides `JApplicationCms::getTemplate`
`protected`	# `initialiseApp( array $options = array() )` Initialise the application. Initialise the application. Parameters `$options` `array` - $options An optional associative array of configuration settings. Since 3.2 Overrides `JApplicationCms::initialiseApp`
`public boolean`	# `login( array $credentials, array $options = array() )` Login authentication function Login authentication function Parameters `$credentials` `array` - $credentials Array('username' => string, 'password' => string) `$options` `array` - $options Array('remember' => boolean) Returns `boolean` - True on success. Since 3.2 Overrides `JApplicationCms::login`
`public static`	# `purgeMessages( )` Purge the jos_messages table of old messages Purge the jos_messages table of old messages Since 3.2
`protected`	# `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. 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 Overrides `JApplicationCms::render`
`protected`	# `route( )` Route the application. 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 Overrides `JApplicationCms::route`

Magic methods summary

Properties summary

Properties inherited from JApplicationCms

$_clientId, $_messageQueue, $_name, $docOptions, $instances, $profiler, $scope, $template

Properties inherited from JApplicationWeb

$charSet, $client, $document, $instance, $language, $mimeType, $modifiedDate, $response, $session

Properties inherited from JApplicationBase

$dispatcher, $identity

Properties inherited from Joomla\Application\AbstractApplication

$config, $input

Magic properties inherited from JApplicationBase

$input

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JApplicationAdministrator

Methods summary

Parameters

Since

Overrides

Parameters

Since

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Throws

Since

Overrides

Parameters

Since

Overrides

Parameters

Returns

Since

Overrides

Since

Since

Overrides

Since

Overrides

Methods inherited from JApplicationCms

Methods inherited from JApplicationWeb

Methods inherited from JApplicationBase

Methods inherited from Joomla\Application\AbstractApplication

Magic methods summary

Properties summary

Properties inherited from JApplicationCms

Properties inherited from JApplicationWeb

Properties inherited from JApplicationBase

Properties inherited from Joomla\Application\AbstractApplication

Magic properties inherited from JApplicationBase