Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class AdministratorApplication - list of methods

Joomla! Administrator Application class

Extends

CMSApplication
Package: Joomla\CMS\Application
Copyright: (C) 2013 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Application/AdministratorApplication.php
Project: Joomla

Method Summary

public
__construct
(\Joomla\CMS\Input\Input $input = null, \Joomla\Registry\Registry $config = null, \Joomla\Application\Web\WebClient $client = null, \Joomla\DI\Container $container = null)

Class constructor.
Parameters
  • \Joomla\CMS\Input\Input $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.
  • \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.
  • \Joomla\Application\Web\WebClient $client An optional argument to provide dependency injection for the application's client object. If the argument is a WebClient object that object will become the application's client object, otherwise a default client object is created.
  • \Joomla\DI\Container $container Dependency injection container.
Since
  • 3.2
Show source code of this method: __construct Source Code

public void
(mixed $component = null)

Dispatch the application
Parameters
  • string $component The component which is being rendered.
Returns
  • void
Since
  • 3.2
Show source code of this method: dispatch Source Code

protected void
()

Method to run the Web application routines.
Returns
  • void
Since
  • 3.2
Show source code of this method: doExecute Source Code

public static \Joomla\CMS\Router\Router
(mixed $name = 'administrator', array $options = array())

Return a reference to the Router object.
Parameters
  • string $name The name of the application.
  • array $options An optional associative array of configuration settings.
Returns
  • \Joomla\CMS\Router\Router
Since
  • 3.2
Show source code of this method: getRouter Source Code

public string
(mixed $params = false)

Gets the name of the current template.
Parameters
  • bool $params True to return the template parameters
Returns
  • string The name of the template.
Since
  • 3.2
-
  • \InvalidArgumentException
Show source code of this method: getTemplate Source Code

protected void
(mixed $options = array())

Initialise the application.
Parameters
  • array $options An optional associative array of configuration settings.
Returns
  • void
Since
  • 3.2
Show source code of this method: initialiseApp Source Code

public bool
(mixed $credentials, mixed $options = array())

Login authentication function
Parameters
  • array $credentials Array('username' => string, 'password' => string)
  • array $options Array('remember' => boolean)
Returns
  • bool True on success.
Since
  • 3.2
Show source code of this method: login Source Code

public static void
()

Purge the jos_messages table of old messages
Returns
  • void
Since
  • 3.2
Show source code of this method: purgeMessages Source Code

protected void
()

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.
Returns
  • void
Since
  • 3.2
Show source code of this method: render Source Code

protected void
()

Route the application.
Returns
  • void
Since
  • 3.2
Show source code of this method: route Source Code

public string
()

Return the application option string [main component].
Returns
  • string The component to access.
Since
  • 4.0.0
Show source code of this method: findOption Source Code

Properties Summary

protected array
$allowedUnprivilegedOptions
List of allowed components for guests and users which do not have the core.login.admin privilege.

Tags Summary

Since
3.2