Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class WebApplication - list of methods

Base class for a Joomla! Web application.

Direct known subclasses

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

Method Summary

public
__construct
(\Joomla\CMS\Input\Input $input = null, \Joomla\Registry\Registry $config = null, \Joomla\Application\Web\WebClient $client = null, \Psr\Http\Message\ResponseInterface $response = 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.
  • \Psr\Http\Message\ResponseInterface $response An optional argument to provide dependency injection for the application's response object. If the argument is a ResponseInterface object that object will become the application's response object, otherwise a default response object is created.
Since
  • 1.7.3
Show source code of this method: __construct Source Code

public static \Joomla\CMS\Application\WebApplication
(mixed $name = null)

Returns a reference to the global WebApplication object, only creating it if it doesn't already exist.
Parameters
  • string $name The name (optional) of the WebApplication class to instantiate.
Returns
  • \Joomla\CMS\Application\WebApplication
Since
  • 1.7.3
Deprecated
  • 5.0
-
  • \RuntimeException
Show source code of this method: getInstance Source Code

public void
()

Execute the application.
Returns
  • void
Since
  • 1.7.3
Show source code of this method: execute 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
  • 1.7.3
Show source code of this method: render Source Code

public \Joomla\CMS\Document\Document
()

Method to get the application document object.
Returns
  • \Joomla\CMS\Document\Document The document object
Since
  • 1.7.3
Show source code of this method: getDocument Source Code

public \Joomla\CMS\Language\Language
()

Method to get the application language object.
Returns
  • \Joomla\CMS\Language\Language The language object
Since
  • 1.7.3
Show source code of this method: getLanguage Source Code

public void
()

Flush the media version to refresh versionable assets
Returns
  • void
Since
  • 3.2
Show source code of this method: flushAssets Source Code

public \Joomla\CMS\Application\WebApplication
(\Joomla\CMS\Document\Document $document = null)

Allows the application to load a custom or default document.
Parameters
  • \Joomla\CMS\Document\Document $document An optional document object. If omitted, the factory document is created.
Returns
  • \Joomla\CMS\Application\WebApplication This method is chainable.
Since
  • 1.7.3
Show source code of this method: loadDocument Source Code

public \Joomla\CMS\Application\WebApplication
(\Joomla\CMS\Language\Language $language = null)

Allows the application to load a custom or default language.
Parameters
  • \Joomla\CMS\Language\Language $language An optional language object. If omitted, the factory language is created.
Returns
  • \Joomla\CMS\Application\WebApplication This method is chainable.
Since
  • 1.7.3
Show source code of this method: loadLanguage Source Code

public \Joomla\CMS\Application\WebApplication
(\Joomla\CMS\Session\Session $session = null)

Allows the application to load a custom or default session.
Parameters
  • \Joomla\CMS\Session\Session $session An optional session object. If omitted, the session is created.
Returns
  • \Joomla\CMS\Application\WebApplication This method is chainable.
Since
  • 1.7.3
Deprecated
  • 5.0
Show source code of this method: loadSession Source Code

public void
(\Joomla\Session\SessionEvent $event)

After the session has been started we need to populate it with some default values.
Parameters
  • \Joomla\Session\SessionEvent $event Session event being triggered
Returns
  • void
Since
  • 3.0.1
Show source code of this method: afterSessionStart Source Code

protected void
(mixed $requestUri = null)

Method to load the system URI strings for the application.
Parameters
  • string $requestUri An optional request URI to use instead of detecting one from the server environment variables.
Returns
  • void
Since
  • 1.7.3
Show source code of this method: loadSystemUris Source Code

public \Joomla\Registry\Registry
()

Retrieve the application configuration object.
Returns
  • \Joomla\Registry\Registry
Since
  • 4.0.0
Show source code of this method: getConfig Source Code

Properties Summary

protected \Joomla\CMS\Document\Document
$document
The application document object.
Since
  • 1.7.3
protected \Joomla\CMS\Language\Language
$language
The application language object.
Since
  • 1.7.3
protected static static
$instance
The application instance.
Since
  • 1.7.3

Tags Summary

Since
2.5.0