[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

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

Joomla! Content Management System

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

Defines 13 functions

  __construct()
  getInstance()
  execute()
  render()
  getDocument()
  getLanguage()
  flushAssets()
  loadDocument()
  loadLanguage()
  loadSession()
  afterSessionStart()
  loadSystemUris()
  getConfig()

Functions
Functions that are not part of a class:

__construct(Input $input = null, Registry $config = null, WebClient $client = null, ResponseInterface $response = null)   X-Ref
Class constructor.

param: Input              $input     An optional argument to provide dependency injection for the application's
param: Registry           $config    An optional argument to provide dependency injection for the application's
param: WebClient          $client    An optional argument to provide dependency injection for the application's
param: ResponseInterface  $response  An optional argument to provide dependency injection for the application's

getInstance($name = null)   X-Ref
Returns a reference to the global WebApplication object, only creating it if it doesn't already exist.

This method must be invoked as: $web = WebApplication::getInstance();

param: string  $name  The name (optional) of the WebApplication class to instantiate.
return: WebApplication

execute()   X-Ref
Execute the application.

return: void

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

getDocument()   X-Ref
Method to get the application document object.

return: Document  The document object

getLanguage()   X-Ref
Method to get the application language object.

return: Language  The language object

flushAssets()   X-Ref
Flush the media version to refresh versionable assets

return: void

loadDocument(Document $document = null)   X-Ref
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.

param: Document  $document  An optional document object. If omitted, the factory document is created.
return: WebApplication This method is chainable.

loadLanguage(Language $language = null)   X-Ref
Allows the application to load a custom or default language.

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

param: Language  $language  An optional language object. If omitted, the factory language is created.
return: WebApplication This method is chainable.

loadSession(Session $session = null)   X-Ref
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.

param: Session  $session  An optional session object. If omitted, the session is created.
return: WebApplication This method is chainable.

afterSessionStart(SessionEvent $event)   X-Ref
After the session has been started we need to populate it with some default values.

param: SessionEvent  $event  Session event being triggered
return: void

loadSystemUris($requestUri = null)   X-Ref
Method to load the system URI strings for the application.

param: string  $requestUri  An optional request URI to use instead of detecting one from the
return: void

getConfig()   X-Ref
Retrieve the application configuration object.

return: Registry



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