[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Application/ -> SiteApplication.php (summary)

Joomla! Content Management System

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

Defines 18 functions

  __construct()
  authorise()
  dispatch()
  doExecute()
  getDetectBrowser()
  getLanguageFilter()
  getParams()
  getPathway()
  getRouter()
  getTemplate()
  initialiseApp()
  loadLibraryLanguage()
  login()
  render()
  route()
  setDetectBrowser()
  setLanguageFilter()
  setTemplate()

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      $input      An optional argument to provide dependency injection for the application's input
param: Registry   $config     An optional argument to provide dependency injection for the application's config
param: WebClient  $client     An optional argument to provide dependency injection for the application's client
param: Container  $container  Dependency injection container.

authorise($itemid)   X-Ref
Check if the user can access the application

param: integer  $itemid  The item ID to check authorisation for
return: void

dispatch($component = null)   X-Ref
Dispatch the application

param: string  $component  The component which is being rendered.
return: void

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

return: void

getDetectBrowser()   X-Ref
Return the current state of the detect browser option.

return: boolean

getLanguageFilter()   X-Ref
Return the current state of the language filter.

return: boolean

getParams($option = null)   X-Ref
Get the application parameters

param: string  $option  The component option
return: Registry  The parameters object

getPathway($name = 'site', $options = array()   X-Ref
Return a reference to the Pathway object.

param: string  $name     The name of the application.
param: array   $options  An optional associative array of configuration settings.
return: Pathway  A Pathway object

getRouter($name = 'site', array $options = array()   X-Ref
Return a reference to the Router object.

param: string  $name     The name of the application.
param: array   $options  An optional associative array of configuration settings.
return: \Joomla\CMS\Router\Router

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

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

loadLibraryLanguage()   X-Ref
Load the library language files for the application

return: void

login($credentials, $options = array()   X-Ref
Login authentication function

param: array  $credentials  Array('username' => string, 'password' => string)
param: array  $options      Array('remember' => boolean)
return: boolean  True on success.

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

route()   X-Ref
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.

return: void

setDetectBrowser($state = false)   X-Ref
Set the current state of the detect browser option.

param: boolean  $state  The new state of the detect browser option
return: boolean  The previous state

setLanguageFilter($state = false)   X-Ref
Set the current state of the language filter.

param: boolean  $state  The new state of the language filter
return: boolean  The previous state

setTemplate($template, $styleParams = null)   X-Ref
Overrides the default template that would be used

param: \stdClass|string $template    The template name or definition
param: mixed            $styleParams The template style parameters
return: void



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