Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class SiteApplication - list of methods

Joomla! Site Application class

Extends

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

Method Summary

public
__construct
(\Joomla\CMS\Input\Input $input = null, \Joomla\Registry\Registry $config = null, \Joomla\Application\Web\WebClient $client = null, \Joomla\DI\Container $container = 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.
  • \Joomla\DI\Container $container Dependency injection container.
Since
  • 3.2
Show source code of this method: __construct Source Code

protected void
(mixed $itemid)

Check if the user can access the application
Parameters
  • int $itemid The item ID to check authorisation for
Returns
  • void
Since
  • 3.2
-
  • \Exception When you are not authorised to view the home page menu item
Show source code of this method: authorise Source Code

public void
(mixed $component = null)

Dispatch the application
Parameters
  • string $component The component which is being rendered.
Returns
  • void
Since
  • 3.2
Show source code of this method: dispatch Source Code

protected void
()

Method to run the Web application routines.
Returns
  • void
Since
  • 3.2
Show source code of this method: doExecute Source Code

public bool
()

Return the current state of the detect browser option.
Returns
  • bool
Since
  • 3.2
Show source code of this method: getDetectBrowser Source Code

public bool
()

Return the current state of the language filter.
Returns
  • bool
Since
  • 3.2
Show source code of this method: getLanguageFilter Source Code

public \Joomla\Registry\Registry
(mixed $option = null)

Get the application parameters
Parameters
  • string $option The component option
Returns
  • \Joomla\Registry\Registry The parameters object
Since
  • 3.2
Show source code of this method: getParams Source Code

public \Joomla\CMS\Pathway\Pathway
(mixed $name = 'site', mixed $options = array())

Return a reference to the Pathway object.
Parameters
  • string $name The name of the application.
  • array $options An optional associative array of configuration settings.
Returns
  • \Joomla\CMS\Pathway\Pathway A Pathway object
Since
  • 3.2
Show source code of this method: getPathway Source Code

public static \Joomla\CMS\Router\Router
(mixed $name = 'site', array $options = array())

Return a reference to the Router object.
Parameters
  • string $name The name of the application.
  • array $options An optional associative array of configuration settings.
Returns
  • \Joomla\CMS\Router\Router
Since
  • 3.2
Show source code of this method: getRouter Source Code

public string
(mixed $params = false)

Gets the name of the current template.
Parameters
  • bool $params True to return the template parameters
Returns
  • string The name of the template.
Since
  • 3.2
-
  • \InvalidArgumentException
Show source code of this method: getTemplate Source Code

protected void
(mixed $options = array())

Initialise the application.
Parameters
  • array $options An optional associative array of configuration settings.
Returns
  • void
Since
  • 3.2
Show source code of this method: initialiseApp Source Code

protected void
()

Load the library language files for the application
Returns
  • void
Since
  • 3.6.3
Show source code of this method: loadLibraryLanguage Source Code

public bool
(mixed $credentials, mixed $options = array())

Login authentication function
Parameters
  • array $credentials Array('username' => string, 'password' => string)
  • array $options Array('remember' => boolean)
Returns
  • bool True on success.
Since
  • 3.2
Show source code of this method: login 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
  • 3.2
Show source code of this method: render Source Code

protected void
()

Route the application.
Returns
  • void
Since
  • 3.2
Show source code of this method: route Source Code

public bool
(mixed $state = false)

Set the current state of the detect browser option.
Parameters
  • bool $state The new state of the detect browser option
Returns
  • bool The previous state
Since
  • 3.2
Show source code of this method: setDetectBrowser Source Code

public bool
(mixed $state = false)

Set the current state of the language filter.
Parameters
  • bool $state The new state of the language filter
Returns
  • bool The previous state
Since
  • 3.2
Show source code of this method: setLanguageFilter Source Code

public void
(mixed $template, mixed $styleParams = null)

Overrides the default template that would be used
Parameters
  • \stdClass|string $template The template name or definition
  • mixed $styleParams The template style parameters
Returns
  • void
Since
  • 3.2
Show source code of this method: setTemplate Source Code

Properties Summary

protected bool
$language_filter
Option to filter by language
Since
  • 4.0.0
protected bool
$detect_browser
Option to detect language by the browser
Since
  • 4.0.0

Tags Summary

Since
3.2