Class JApplicationSite

Joomla! Site Application class

Joomla\Application\AbstractApplication implements Psr\Log\LoggerAwareInterface

JApplicationBase

JApplicationWeb

JApplicationCms

JApplicationSite

Final
Package: Joomla\Libraries\Application
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 3.2
Located at cms/application/site.php

Methods summary

`public`	# `__construct( JInput $input = null, Joomla\Registry\Registry $config = null, JApplicationWebClient $client = null )` Class constructor. Class constructor. Parameters `$input` `JInput` - $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. `$config` `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. `$client` `JApplicationWebClient` - $client An optional argument to provide dependency injection for the application's client object. If the argument is a JApplicationWebClient object that object will become the application's client object, otherwise a default client object is created. Since 3.2 Overrides `JApplicationCms::__construct`
`protected`	# `authorise( integer $itemid )` Check if the user can access the application Check if the user can access the application Parameters `$itemid` `integer` - $itemid The item ID to check authorisation for Throws `Exception` - When you are not authorised to view the home page menu item Since 3.2
`public`	# `dispatch( string $component = null )` Dispatch the application Dispatch the application Parameters `$component` `string` - $component The component which is being rendered. Since 3.2
`protected`	# `doExecute( )` Method to run the Web application routines. Method to run the Web application routines. Since 3.2 Overrides `JApplicationBase::doExecute`
`public boolean`	# `getDetectBrowser( )` Return the current state of the detect browser option. Return the current state of the detect browser option. Returns `boolean` Since 3.2
`public boolean`	# `getLanguageFilter( )` Return the current state of the language filter. Return the current state of the language filter. Returns `boolean` Since 3.2
`public JMenu`	# `getMenu( string $name = 'site', array $options = array() )` Return a reference to the JMenu object. Return a reference to the JMenu object. Parameters `$name` `string` - $name The name of the application/client. `$options` `array` - $options An optional associative array of configuration settings. Returns `JMenu` - JMenu object. Since 3.2 Overrides `JApplicationCms::getMenu`
`public Joomla\Registry\Registry`	# `getPageParameters( string $option = null )` Get the application parameters Get the application parameters Deprecated 4.0 Use getParams() instead Parameters `$option` `string` - $option The component option Returns `Joomla\Registry\Registry` - The parameters object Since 3.2
`public Joomla\Registry\Registry`	# `getParams( string $option = null )` Get the application parameters Get the application parameters Parameters `$option` `string` - $option The component option Returns `Joomla\Registry\Registry` - The parameters object Since 3.2
`public JPathway`	# `getPathway( string $name = 'site', array $options = array() )` Return a reference to the JPathway object. Return a reference to the JPathway object. Parameters `$name` `string` - $name The name of the application. `$options` `array` - $options An optional associative array of configuration settings. Returns `JPathway` - A JPathway object Since 3.2 Overrides `JApplicationCms::getPathway`
`public static JRouter`	# `getRouter( string $name = 'site', array $options = array() )` Return a reference to the JRouter object. Return a reference to the JRouter object. Parameters `$name` `string` - $name The name of the application. `$options` `array` - $options An optional associative array of configuration settings. Returns `JRouter` Since 3.2 Overrides `JApplicationCms::getRouter`
`public string`	# `getTemplate( boolean $params = false )` Gets the name of the current template. Gets the name of the current template. Parameters `$params` `boolean` - $params True to return the template parameters Returns `string` - The name of the template. Throws `InvalidArgumentException` Since 3.2 Overrides `JApplicationCms::getTemplate`
`protected`	# `initialiseApp( array $options = array() )` Initialise the application. Initialise the application. Parameters `$options` `array` - $options An optional associative array of configuration settings. Since 3.2 Overrides `JApplicationCms::initialiseApp`
`protected`	# `loadLibraryLanguage( )` Load the library language files for the application Load the library language files for the application Since 3.6.3 Overrides `JApplicationCms::loadLibraryLanguage`
`public boolean`	# `login( array $credentials, array $options = array() )` Login authentication function Login authentication function Parameters `$credentials` `array` - $credentials Array('username' => string, 'password' => string) `$options` `array` - $options Array('remember' => boolean) Returns `boolean` - True on success. Since 3.2 Overrides `JApplicationCms::login`
`protected`	# `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. 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.2 Overrides `JApplicationCms::render`
`protected`	# `route( )` Route the application. Route the application. Routing is the process of examining the request environment to determine which component should receive the request. The component optional parameters are then set in the request object to be processed when the application is being dispatched. Since 3.2 Overrides `JApplicationCms::route`
`public boolean`	# `setDetectBrowser( boolean $state = false )` Set the current state of the detect browser option. Set the current state of the detect browser option. Parameters `$state` `boolean` - $state The new state of the detect browser option Returns `boolean` - The previous state Since 3.2
`public boolean`	# `setLanguageFilter( boolean $state = false )` Set the current state of the language filter. Set the current state of the language filter. Parameters `$state` `boolean` - $state The new state of the language filter Returns `boolean` - The previous state Since 3.2
`public`	# `setTemplate( string $template, mixed $styleParams = null )` Overrides the default template that would be used Overrides the default template that would be used Parameters `$template` `string` - $template The template name `$styleParams` `mixed` - $styleParams The template style parameters Since 3.2

Magic methods summary

Properties summary

`protected boolean`	`$_language_filter`	# Option to filter by language Option to filter by language Deprecated 4.0 Will be renamed $language_filter Since 3.2
`protected boolean`	`$_detect_browser`	# Option to detect language by the browser Option to detect language by the browser Deprecated 4.0 Will be renamed $detect_browser Since 3.2

Properties inherited from JApplicationCms

$_clientId, $_messageQueue, $_name, $docOptions, $instances, $profiler, $scope, $template

Properties inherited from JApplicationWeb

$charSet, $client, $document, $instance, $language, $mimeType, $modifiedDate, $response, $session

Properties inherited from JApplicationBase

$dispatcher, $identity

Properties inherited from Joomla\Application\AbstractApplication

$config, $input

Magic properties inherited from JApplicationBase

$input

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JApplicationSite

Methods summary

Parameters

Since

Overrides

Parameters

Throws

Since

Parameters

Since

Since

Overrides

Returns

Since

Returns

Since

Parameters

Returns

Since

Overrides

Deprecated

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Throws

Since

Overrides

Parameters

Since

Overrides

Since

Overrides

Parameters

Returns

Since

Overrides

Since

Overrides

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Since

Methods inherited from JApplicationCms

Methods inherited from JApplicationWeb

Methods inherited from JApplicationBase

Methods inherited from Joomla\Application\AbstractApplication

Magic methods summary

Properties summary

Deprecated

Since

Deprecated

Since

Properties inherited from JApplicationCms

Properties inherited from JApplicationWeb

Properties inherited from JApplicationBase