[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Application/ -> AdministratorApplication.php (summary)

Joomla! Content Management System

Copyright: (C) 2013 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 491 lines (17 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

AdministratorApplication:: (11 methods):
  __construct()
  dispatch()
  doExecute()
  getRouter()
  getTemplate()
  initialiseApp()
  login()
  purgeMessages()
  render()
  route()
  findOption()


Class: AdministratorApplication  - X-Ref

Joomla! Administrator Application class

__construct(Input $input = null, Registry $config = null, WebClient $client = null, Container $container = null)   X-Ref
Class constructor.

param: Input      $input      An optional argument to provide dependency injection for the application's input
param: Registry   $config     An optional argument to provide dependency injection for the application's config
param: WebClient  $client     An optional argument to provide dependency injection for the application's
param: Container  $container  Dependency injection container.

dispatch($component = null)   X-Ref
Dispatch the application

param: string  $component  The component which is being rendered.
return: void

doExecute()   X-Ref
Method to run the Web application routines.

return: void

getRouter($name = 'administrator', array $options = array()   X-Ref
Return a reference to the Router object.

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

getTemplate($params = false)   X-Ref
Gets the name of the current template.

param: boolean  $params  True to return the template parameters
return: string  The name of the template.

initialiseApp($options = array()   X-Ref
Initialise the application.

param: array  $options  An optional associative array of configuration settings.
return: void

login($credentials, $options = array()   X-Ref
Login authentication function

param: array  $credentials  Array('username' => string, 'password' => string)
param: array  $options      Array('remember' => boolean)
return: boolean  True on success.

purgeMessages()   X-Ref
Purge the jos_messages table of old messages

return: void

render()   X-Ref
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.

return: void

route()   X-Ref
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.

return: void

findOption()   X-Ref
Return the application option string [main component].

return: string  The component to access.



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer