Référence de la classe SiteApplication

Graphe d'héritage de SiteApplication:

Fonctions membres publiques
	__construct (Input $input=null, Registry $config=null, WebClient $client=null, Container $container=null)
	dispatch ($component=null)
	getDetectBrowser ()
	getLanguageFilter ()
	getParams ($option=null)
	getPathway ($name='site', $options=array())
	login ($credentials, $options=array())
	setDetectBrowser ($state=false)
	setLanguageFilter ($state=false)
	setTemplate ($template, $styleParams=null)
Fonctions membres publiques hérités de CMSApplication
	__construct (Input $input=null, Registry $config=null, WebClient $client=null, Container $container=null)
	checkSession ()
	enqueueMessage ($msg, $type=self::MSG_INFO)
	getCfg ($varname, $default=null)
	getClientId ()
	getMenu ($name=null, $options=array())
	getMessageQueue ($clear=false)
	getName ()
	getPathway ()
	getTemplate ($params=false)
	getUserState ($key, $default=null)
	getUserStateFromRequest ($key, $request, $default=null, $type='none')
	isHttpsForced ($clientId=null)
	isClient ($identifier)
	login ($credentials, $options=array())
	logout ($userid=null, $options=array())
	redirect ($url, $status=303)
	setUserState ($key, $value)
	toString ($compress=false)
	isCli ()
	setMenuFactory (MenuFactoryInterface $menuFactory)
Fonctions membres publiques hérités de WebApplication
	__construct (Input $input=null, Registry $config=null, WebClient $client=null, ResponseInterface $response=null)
	execute ()
	getDocument ()
	getLanguage ()
	flushAssets ()
	loadDocument (Document $document=null)
	loadLanguage (Language $language=null)
	loadSession (Session $session=null)
	afterSessionStart (SessionEvent $event)
	getConfig ()
Fonctions membres publiques hérités de AbstractWebApplication
	__construct (Input $input=null, Registry $config=null, Web\WebClient $client=null, ResponseInterface $response=null)
	__get ($name)
	execute ()
	getInput ()
	redirect ($url, $status=303)
	allowCache ($allow=null)
	setHeader ($name, $value, $replace=false)
	getHeaders ()
	clearHeaders ()
	sendHeaders ()
	setBody ($content)
	prependBody ($content)
	appendBody ($content)
	getBody ()
	getResponse ()
	isValidHttpStatus ($code)
	setResponse (ResponseInterface $response)
	isSslConnection ()
Fonctions membres publiques hérités de AbstractApplication
	__construct (Registry $config=null)
	close ($code=0)
	execute ()
	get ($key, $default=null)
	getLogger ()
	set ($key, $value=null)
	setConfiguration (Registry $config)
Fonctions membres publiques hérités de LoggerAwareInterface
	setLogger (LoggerInterface $logger)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)
Fonctions membres publiques hérités de ContainerAwareInterface
	setContainer (Container $container)
Fonctions membres publiques hérités de CMSWebApplicationInterface
	getDocument ()
Fonctions membres publiques hérités de SessionAwareWebApplicationInterface
	getSession ()
	setSession (SessionInterface $session)
	checkToken ($method='post')
	getFormToken ($forceNew=false)
Fonctions membres publiques hérités de CMSApplicationInterface
	getMessageQueue ()
	getIdentity ()
	getInput ()
	getLanguage ()
	loadIdentity (User $identity=null)
Fonctions membres publiques hérités de ExtensionManagerInterface
	bootComponent ($component)
	bootModule ($module, $applicationName)
	bootPlugin ($plugin, $type)
Fonctions membres publiques hérités de EventAwareInterface
	getDispatcher ()
	triggerEvent ($eventName, $args=[])

Fonctions membres publiques statiques
static	getRouter ($name='site', array $options=array())
Fonctions membres publiques statiques hérités de CMSApplication
static	getInstance ($name=null, $prefix='\JApplication', Container $container=null)
static	getRouter ($name=null, array $options=array())
Fonctions membres publiques statiques hérités de WebApplication
static	getInstance ($name=null)
Fonctions membres publiques statiques hérités de AbstractWebApplication
static	isAscii ($str)

Fonctions membres protégées
	authorise ($itemid)
	doExecute ()
	initialiseApp ($options=array())
	loadLibraryLanguage ()
	render ()
	route ()
Fonctions membres protégées hérités de CMSApplication
	checkUserRequireReset ($option, $view, $layout, $tasks)
	initialiseApp ($options=array())
	loadLibraryLanguage ()
	render ()
	route ()
	isTwoFactorAuthenticationRequired ()
Fonctions membres protégées hérités de WebApplication
	render ()
	loadSystemUris ($requestUri=null)
Fonctions membres protégées hérités de AbstractWebApplication
	compress ()
	respond ()
	getHttpStatusValue ($value)
	checkConnectionAlive ()
	checkHeadersSent ()
	detectRequestUri ()
	header ($string, $replace=true, $code=null)
	isRedirectState ($state)
	loadSystemUris ($requestUri=null)
Fonctions membres protégées hérités de AbstractApplication
	dispatchEvent (string $eventName, ?EventInterface $event=null)
	doExecute ()
	initialise ()

Attributs protégés
	$language_filter = false
	$detect_browser = false
Attributs protégés hérités de CMSApplication
	$docOptions = array()
	$clientId = null
	$messageQueue = array()
	$name = null
	$profiler = null
	$template = null
	$pathway = null
	$authenticationPluginType = 'authentication'
	$menus = []
Attributs protégés hérités de WebApplication
	$document
	$language
Attributs protégés hérités de AbstractWebApplication
	$input
	$response
Attributs protégés hérités de AbstractApplication
	$config

Membres hérités additionnels
Champs de données hérités de CMSApplication
	$scope = null
Champs de données hérités de AbstractWebApplication
	$charSet = 'utf-8'
	$mimeType = 'text/html'
	$httpVersion = '1.1'
	$modifiedDate
	$client
Champs de données hérités de CMSApplicationInterface
const	MSG_EMERGENCY = 'emergency'
const	MSG_ALERT = 'alert'
const	MSG_CRITICAL = 'critical'
const	MSG_ERROR = 'error'
const	MSG_WARNING = 'warning'
const	MSG_NOTICE = 'notice'
const	MSG_INFO = 'info'
const	MSG_DEBUG = 'debug'
Attributs protégés statiques hérités de CMSApplication
static	$instances = array()
Attributs protégés statiques hérités de WebApplication
static	$instance

Description détaillée

Joomla! Site Application class

Depuis

3.2

Documentation des constructeurs et destructeur

__construct()

__construct	(	Input	$input = null,
		Registry	$config = null,
		WebClient	$client = null,
		Container	$container = null
	)

Class constructor.

Paramètres

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.
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.
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.
Container	$container	Dependency injection container.

Depuis

3.2

Références $client, $config, $container, $input, Symfony\Contracts\Service\__construct(), et name.

Documentation des fonctions membres

authorise()

authorise (   $itemid )

protected

Check if the user can access the application

Paramètres

integer

$itemid

The item ID to check authorisation for

Renvoie

void

Depuis

3.2

Exceptions

Références $itemid, $url, $user, Text\_(), Route\_(), Uri\getInstance(), et Factory\getUser().

dispatch()

dispatch

(

$component = null

)

Dispatch the application

Paramètres

string

$component

The component which is being rendered.

Renvoie

void

Depuis

3.2

Références $component, $document, Factory\$document, $params, $template, $this, Uri\current(), PluginHelper\importPlugin(), null, et Joomla\CMS\Application\triggerEvent().

doExecute()

doExecute ( )

protected

Method to run the Web application routines.

Renvoie

void

Depuis

3.2

Références JDEBUG, et null.

getDetectBrowser()

getDetectBrowser

(

)

Return the current state of the detect browser option.

Renvoie

boolean

Depuis

3.2

getLanguageFilter()

getLanguageFilter

(

)

Return the current state of the language filter.

Renvoie

boolean

Depuis

3.2

getParams()

getParams

(

$option = null

)

Get the application parameters

Paramètres

string

$option

The component option

Renvoie

Registry The parameters object

Depuis

3.2

Références $description, $hash, $languages, $menu, $option, $params, $temp, $title, ComponentHelper\getParams(), et null.

getPathway()

getPathway	(		$name = 'site',
			$options = array()
	)

Return a reference to the Pathway object.

Paramètres

string	$name	The name of the application.
array	$options	An optional associative array of configuration settings.

Renvoie

Pathway A Pathway object

Depuis

3.2

Références $name, et $options.

getRouter()

static getRouter (   $name = 'site', array  $options = array()  )

static

Return a reference to the Router object.

Paramètres

string	$name	The name of the application.
array	$options	An optional associative array of configuration settings.

Renvoie

Depuis

3.2

Obsolète:

5.0 Inject the router or load it from the dependency injection container

Implémente CMSWebApplicationInterface.

Références $name, et $options.

initialiseApp()

initialiseApp (   $options = array() )

protected

Initialise the application.

Paramètres

array

$options

An optional associative array of configuration settings.

Renvoie

void

Depuis

3.2

Références $lang, $options, $params, $user, LanguageHelper\detectLanguage(), LanguageHelper\exists(), ComponentHelper\getParams(), PluginHelper\getPlugin(), Factory\getUser(), et null.

loadLibraryLanguage()

loadLibraryLanguage ( )

protected

Load the library language files for the application

Renvoie

void

Depuis

3.6.3

Références JPATH_ADMINISTRATOR, et JPATH_SITE.

login()

login	(		$credentials,
			$options = array()
	)

Login authentication function

Paramètres

array	$credentials	Array('username' => string, 'password' => string)
array	$options	Array('remember' => boolean)

Renvoie

boolean True on success.

Depuis

3.2

Références $options, et Uri\base().

render()

render ( )

protected

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.

Renvoie

void

Depuis

3.2

Références $template, $this, Uri\getInstance(), Factory\getUser(), et JPATH_THEMES.

route()

route ( )

protected

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.

Renvoie

void

Depuis

3.2

Références $active, $base, $item, $key, $position, $result, $uri, $value, Uri\base(), class, Joomla\DI\getContainer(), Uri\getInstance(), PluginHelper\importPlugin(), null, StringHelper\strtolower(), et Joomla\CMS\Application\triggerEvent().

setDetectBrowser()

setDetectBrowser

(

$state = false

)

Set the current state of the detect browser option.

Paramètres

boolean

$state

The new state of the detect browser option

Renvoie

boolean The previous state

Depuis

3.2

Références $state.

setLanguageFilter()

setLanguageFilter

(

$state = false

)

Set the current state of the language filter.

Paramètres

boolean

$state

The new state of the language filter

Renvoie

boolean The previous state

Depuis

3.2

Références $state.

setTemplate()

setTemplate	(		$template,
			$styleParams = null
	)

Overrides the default template that would be used

Paramètres

\stdClass | string	$template	The template name or definition
mixed	$styleParams	The template style parameters

Renvoie

void

Depuis

3.2

Références $template, et JPATH_THEMES.

Documentation des champs

$detect_browser

$detect_browser = false

protected

$language_filter

$language_filter = false

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• SiteApplication.php