Class InstallationApplicationWeb

Description
Description | Vars | Methods (details)

Joomla! Installation Application class

  • since: 3.1

Located in /installation/application/web.php (line 19) 

JApplicationBase
   |
   --JApplicationWeb
      |
      --JApplicationCms
         |
         --InstallationApplicationWeb
Method Summary
Description | Vars | Methods (details)
InstallationApplicationWeb __construct ()
string debugLanguage ()
void dispatch ()
void doExecute ()
mixed fetchConfigurationData ([string $file = ''], [string $class = 'JConfig'])
JController fetchController (string $task)
mixed getLocalise ()
array getLocaliseAdmin ([mixed $db = false])
string getTemplate ([boolean $params = false])
void initialiseApp ([array $options = array()])
InstallationApplicationWeb loadDocument ([JDocument $document = null])
InstallationApplicationWeb loadSession ([JSession $session = null])
void render ()
void sendJsonResponse (mixed $response)
void setCfg ([array $vars = array()], [string $namespace = 'config'])
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JApplicationCms

JApplicationCms::$docOptions
 JApplicationCms::$instances
 JApplicationCms::$profiler
 JApplicationCms::$scope
 JApplicationCms::$template
 JApplicationCms::$useStrongEncryption
 JApplicationCms::$_clientId
 JApplicationCms::$_messageQueue
 JApplicationCms::$_name

Inherited from JApplicationWeb

JApplicationWeb::$charSet
 JApplicationWeb::$client
 JApplicationWeb::$config
 JApplicationWeb::$document
 JApplicationWeb::$instance
 JApplicationWeb::$language
 JApplicationWeb::$mimeType
 JApplicationWeb::$modifiedDate
 JApplicationWeb::$response
 JApplicationWeb::$session

Inherited from JApplicationBase

JApplicationBase::$dispatcher
 JApplicationBase::$identity
 JApplicationBase::$input
Methods
Description | Vars Methods (details)
Constructor __construct (line 26)

Class constructor.

  • since: 3.1
  • access: public
InstallationApplicationWeb __construct ()
Redefinition of:
JApplicationCms::__construct()
Class constructor.
debugLanguage (line 83)

Method to display errors in language parsing

  • return: Language debug output
  • since: 3.1
  • access: public
string debugLanguage ()
dispatch (line 155)

Dispatch the application

  • since: 3.1
  • access: public
void dispatch ()
doExecute (line 216)

Method to run the Web application routines.

  • since: 3.1
  • access: protected
void doExecute ()
Redefinition of:
JApplicationWeb::doExecute()
Method to run the Web application routines. Most likely you will want to instantiate a controller and execute it, or perform some sort of action that populates a JDocument object so that output can be rendered to the client.
fetchConfigurationData (line 239)

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.

  • return: Either an array or object to be loaded into the configuration object.
  • since: 11.3
  • throws: RuntimeException
  • access: protected
mixed fetchConfigurationData ([string $file = ''], [string $class = 'JConfig'])
  • string $file: The path and filename of the configuration file. If not provided, configuration.php in JPATH_BASE will be used.
  • string $class: The class name to instantiate.
Redefinition of:
JApplicationWeb::fetchConfigurationData()
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.
fetchController (line 254)

Method to get a controller object.

  • since: 3.1
  • throws: RuntimeException
  • access: protected
JController fetchController (string $task)
  • string $task: The task being executed
getLocalise (line 282)

Returns the language code and help url set in the localise.xml file.

Used for forcing a particular language in localised releases.

  • return: False on failure, array on success.
  • since: 3.1
  • access: public
mixed getLocalise ()
getLocaliseAdmin (line 317)

Returns the installed language files in the administrative and front-end area.

  • return: Array with installed language packs in admin and site area
  • since: 3.1
  • access: public
array getLocaliseAdmin ([mixed $db = false])
  • mixed $db: JDatabaseDriver instance
getTemplate (line 377)

Gets the name of the current template.

  • return: The name of the template.
  • since: 3.1
  • access: public
string getTemplate ([boolean $params = false])
  • boolean $params: True to return the template parameters
initialiseApp (line 399)

Initialise the application.

  • since: 3.1
  • access: protected
void initialiseApp ([array $options = array()])
  • array $options: An optional associative array of configuration settings.
loadDocument (line 468)

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.

  • return: This method is chainable.
  • since: 3.2
  • access: public
InstallationApplicationWeb loadDocument ([JDocument $document = null])
  • JDocument $document: An optional document object. If omitted, the factory document is created.
Redefinition of:
JApplicationWeb::loadDocument()
Allows the application to load a custom or default document.
loadSession (line 508)

Allows the application to load a custom or default session.

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 session, if required, based on more specific needs.

  • return: This method is chainable.
  • since: 3.1
  • access: public
InstallationApplicationWeb loadSession ([JSession $session = null])
  • JSession $session: An optional session object. If omitted, the session is created.
Redefinition of:
JApplicationWeb::loadSession()
Allows the application to load a custom or default session.
render (line 560)

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.1
  • access: public
void render ()
Redefinition of:
JApplicationWeb::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.
sendJsonResponse (line 592)

Method to send a JSON response. The data parameter can be a Exception object for when an error has occurred or a stdClass for a good response.

  • since: 3.1
  • access: public
void sendJsonResponse (mixed $response)
  • mixed $response: stdClass on success, Exception on failure.
setCfg (line 620)

Set configuration values

  • since: 3.1
  • access: public
void setCfg ([array $vars = array()], [string $namespace = 'config'])
  • array $vars: Array of configuration values
  • string $namespace: The namespace

Inherited Methods

Inherited From JApplicationCms

JApplicationCms::__construct()
JApplicationCms::afterSessionStart()
JApplicationCms::checkSession()
JApplicationCms::enqueueMessage()
JApplicationCms::execute()
JApplicationCms::getCfg()
JApplicationCms::getClientId()
JApplicationCms::getInstance()

Inherited From JApplicationWeb

JApplicationWeb::__construct()
JApplicationWeb::afterSessionStart()
JApplicationWeb::allowCache()
JApplicationWeb::appendBody()
JApplicationWeb::checkConnectionAlive()
JApplicationWeb::checkHeadersSent()
JApplicationWeb::clearHeaders()
JApplicationWeb::compress()
JApplicationWeb::detectRequestUri()
JApplicationWeb::doExecute()
JApplicationWeb::execute()
JApplicationWeb::fetchConfigurationData()
JApplicationWeb::flushAssets()
JApplicationWeb::get()
JApplicationWeb::getBody()
JApplicationWeb::getDocument()
JApplicationWeb::getHeaders()
JApplicationWeb::getInstance()
JApplicationWeb::getLanguage()
JApplicationWeb::getSession()
JApplicationWeb::header()
JApplicationWeb::initialise()
JApplicationWeb::isSSLConnection()
JApplicationWeb::loadConfiguration()
JApplicationWeb::loadDocument()
JApplicationWeb::loadLanguage()
JApplicationWeb::loadSession()
JApplicationWeb::loadSystemUris()
JApplicationWeb::prependBody()
JApplicationWeb::redirect()
JApplicationWeb::render()
JApplicationWeb::respond()
JApplicationWeb::sendHeaders()
JApplicationWeb::set()
JApplicationWeb::setBody()
JApplicationWeb::setHeader()

Inherited From JApplicationBase

JApplicationBase::close()
JApplicationBase::getIdentity()
JApplicationBase::loadDispatcher()
JApplicationBase::loadIdentity()
JApplicationBase::registerEvent()
JApplicationBase::triggerEvent()

Documentation generated on Tue, 19 Nov 2013 15:18:24 +0100 by phpDocumentor 1.4.3