Class JAdministrator

Description

Joomla! Application class

Provide many supporting API functions

  • since: 1.5
  • final:

Located in /administrator/includes/application.php (line 22)

JObject
   |
   --JApplication
      |
      --JAdministrator
Method Summary
static JRouter getRouter ([ $name = null], [array $options = array()])
static void purgeMessages ()
JAdministrator __construct ([array $config = array()])
void dispatch ([string $component = null])
string getTemplate ([ $params = false])
void initialise ([array $options = array()])
boolean login (array $credentials, [array $options = array()])
void render ()
void route ()
Variables
Methods
static method getRouter (line 115)

Return a reference to the JRouter object.

  • since: 1.5
  • access: public
static JRouter getRouter ([ $name = null], [array $options = array()])
  • $name
  • array $options

Redefinition of:
JApplication::getRouter()
Returns the application JRouter object.
static method purgeMessages (line 298)

Purge the jos_messages table of old messages

  • since: 1.5
  • access: public
static void purgeMessages ()
Constructor __construct (line 32)

Class constructor

  • since: 1.5
  • access: public
JAdministrator __construct ([array $config = array()])
  • array $config: An optional associative array of configuration settings. Recognized key values include 'clientId' (this list is not meant to be comprehensive).

Redefinition of:
JApplication::__construct()
Class constructor.
dispatch (line 129)

Dispatch the application

  • since: 1.5
  • access: public
void dispatch ([string $component = null])
  • string $component: The component to dispatch.

Redefinition of:
JApplication::dispatch()
Dispatch the application.
getTemplate (line 254)

Get the template

  • return: The template name
  • since: 1.0
  • access: public
string getTemplate ([ $params = false])
  • $params

Redefinition of:
JApplication::getTemplate()
Gets the name of the current template.
initialise (line 49)

Initialise the application.

  • since: 1.5
  • access: public
void initialise ([array $options = array()])
  • array $options: An optional associative array of configuration settings.

Redefinition of:
JApplication::initialise()
Initialise the application.
login (line 218)

Login authentication function

  • return: True on success.
  • see: JApplication::login
  • since: 1.5
  • access: public
boolean login (array $credentials, [array $options = array()])
  • array $credentials: Array('username' => string, 'password' => string)
  • array $options: Array('remember' => boolean)

Redefinition of:
JApplication::login()
Login authentication function.
render (line 174)

Display the application.

  • since: 1.5
  • access: public
void render ()

Redefinition of:
JApplication::render()
Render the application.
route (line 94)

Route the application

  • since: 1.5
  • access: public
void route ()

Redefinition of:
JApplication::route()
Route the application.

Inherited Methods

Inherited From JApplication

JApplication::__construct()
JApplication::checkSession()
JApplication::close()
JApplication::dispatch()
JApplication::enqueueMessage()
JApplication::getCfg()
JApplication::getClientId()
JApplication::getHash()
JApplication::getInstance()
JApplication::getMenu()
JApplication::getMessageQueue()
JApplication::getName()
JApplication::getPathway()
JApplication::getRouter()
JApplication::getTemplate()
JApplication::getUserState()
JApplication::getUserStateFromRequest()
JApplication::initialise()
JApplication::isAdmin()
JApplication::isSite()
JApplication::isWinOS()
JApplication::login()
JApplication::logout()
JApplication::redirect()
JApplication::registerEvent()
JApplication::render()
JApplication::route()
JApplication::setUserState()
JApplication::stringURLSafe()
JApplication::triggerEvent()
JApplication::_createConfiguration()
JApplication::_createSession()
JApplication::__toString()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 13:52:08 -0500 by phpDocumentor 1.4.4