[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/installation/src/Application/ -> InstallationApplication.php (summary)

(no description)

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

Defines 16 functions

  __construct()
  afterSessionStart()
  debugLanguage()
  dispatch()
  doExecute()
  execute()
  fetchConfigurationData()
  executeController()
  getLocalise()
  getLocaliseAdmin()
  getTemplate()
  initialiseApp()
  loadDocument()
  render()
  setCfg()
  getMenu()

Functions
Functions that are not part of a class:

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

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

afterSessionStart(SessionEvent $event)   X-Ref
After the session has been started we need to populate it with some default values.

param: SessionEvent  $event  Session event being triggered
return: void

debugLanguage()   X-Ref
Method to display errors in language parsing.

return: string  Language debug output.

dispatch()   X-Ref
Dispatch the application.

return: void

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

return: void

execute()   X-Ref
Execute the application.

return: void

fetchConfigurationData($file = '', $class = 'JConfig')   X-Ref
Method to load a PHP configuration class file based on convention and return the instantiated data object.  You
will extend this method in child classes to provide configuration data from whatever data source is relevant
for your specific application.

param: string  $file   The path and filename of the configuration file. If not provided, configuration.php
param: string  $class  The class name to instantiate.
return: mixed   Either an array or object to be loaded into the configuration object.

executeController()   X-Ref
Executed a controller from the input task.

return: void

getLocalise()   X-Ref
Returns the language code and help URL set in the localise.xml file.
Used for forcing a particular language in localised releases.

return: mixed  False on failure, array on success.

getLocaliseAdmin(DatabaseInterface $db = null)   X-Ref
Returns the installed language files in the administrative and frontend area.

param: DatabaseInterface|null  $db  Database driver.
return: array  Array with installed language packs in admin and site area.

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

param: boolean  $params  True to return the template parameters
return: string|\stdClass  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

loadDocument(Document $document = null)   X-Ref
Allows the application to load a custom or default document.

The logic and options for creating this object are adequately generic for default cases
but for many applications it will make sense to override this method and create a document,
if required, based on more specific needs.

param: Document|null  $document  An optional document object. If omitted, the factory document is created.
return: InstallationApplication This method is chainable.

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

setCfg(array $vars = array()   X-Ref
Set configuration values.

param: array   $vars       Array of configuration values
param: string  $namespace  The namespace
return: void

getMenu($name = null, $options = array()   X-Ref
Returns the application \JMenu object.

param: string|null  $name     The name of the application/client.
param: array        $options  An optional associative array of configuration settings.
return: null



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