Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe SiteApplication
+ Graphe d'héritage de SiteApplication:

Fonctions membres publiques

 __construct (Input $input=null, Registry $config=null, \JApplicationWebClient $client=null)
 
 dispatch ($component=null)
 
 getDetectBrowser ()
 
 getLanguageFilter ()
 
 getMenu ($name='site', $options=array())
 
 getPageParameters ($option=null)
 
 getParams ($option=null)
 
 getPathway ($name='site', $options=array())
 
 getTemplate ($params=false)
 
 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, \JApplicationWebClient $client=null)
 
 afterSessionStart ()
 
 checkSession ()
 
 enqueueMessage ($msg, $type='message')
 
 execute ()
 
 getCfg ($varname, $default=null)
 
 getClientId ()
 
 getMenu ($name=null, $options=array())
 
 getMessageQueue ($clear=false)
 
 getName ()
 
 getPathway ($name=null, $options=array())
 
 getTemplate ($params=false)
 
 getUserState ($key, $default=null)
 
 getUserStateFromRequest ($key, $request, $default=null, $type='none')
 
 isAdmin ()
 
 isSite ()
 
 isHttpsForced ($clientId=null)
 
 isClient ($identifier)
 
 loadSession (\JSession $session=null)
 
 login ($credentials, $options=array())
 
 logout ($userid=null, $options=array())
 
 redirect ($url, $status=303)
 
 setUserState ($key, $value)
 
 toString ($compress=false)
 
- Fonctions membres publiques hérités de WebApplication
 __construct (Input $input=null, Registry $config=null, \JApplicationWebClient $client=null)
 
 initialise ($session=null, $document=null, $language=null, $dispatcher=null)
 
 execute ()
 
 redirect ($url, $status=303)
 
 loadConfiguration ($data)
 
 allowCache ($allow=null)
 
 setHeader ($name, $value, $replace=false)
 
 getHeaders ()
 
 clearHeaders ()
 
 sendHeaders ()
 
 setBody ($content)
 
 prependBody ($content)
 
 appendBody ($content)
 
 getBody ($asArray=false)
 
 getDocument ()
 
 getLanguage ()
 
 getSession ()
 
 flushAssets ()
 
 isSSLConnection ()
 
 loadDocument (\JDocument $document=null)
 
 loadLanguage (\JLanguage $language=null)
 
 loadSession (\JSession $session=null)
 
 afterSessionStart ()
 
- Fonctions membres publiques hérités de BaseApplication
 __construct (Input $input=null, Registry $config=null)
 
 getIdentity ()
 
 registerEvent ($event, $handler)
 
 triggerEvent ($event, array $args=null)
 
 loadDispatcher (\JEventDispatcher $dispatcher=null)
 
 loadIdentity (\JUser $identity=null)
 
- Fonctions membres publiques hérités de AbstractApplication
 __construct (Input $input=null, Registry $config=null)
 
 close ($code=0)
 
 execute ()
 
 get ($key, $default=null)
 
 getLogger ()
 
 set ($key, $value=null)
 
 setConfiguration (Registry $config)
 
 setLogger (LoggerInterface $logger)
 

Fonctions membres publiques statiques

static getRouter ($name='site', array $options=array())
 
- Fonctions membres publiques statiques hérités de CMSApplication
static getInstance ($name=null)
 
static getRouter ($name=null, array $options=array())
 
- Fonctions membres publiques statiques hérités de WebApplication
static getInstance ($name=null)
 

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 ()
 
- Fonctions membres protégées hérités de WebApplication
 render ()
 
 compress ()
 
 respond ()
 
 isRedirectState ($state)
 
 getHttpStatusValue ($value)
 
 checkConnectionAlive ()
 
 checkHeadersSent ()
 
 detectRequestUri ()
 
 fetchConfigurationData ($file='', $class='\JConfig')
 
 header ($string, $replace=true, $code=null)
 
 loadSystemUris ($requestUri=null)
 
- Fonctions membres protégées hérités de BaseApplication
 doExecute ()
 
- Fonctions membres protégées hérités de AbstractApplication
 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
 
- Attributs protégés hérités de WebApplication
 $document
 
 $language
 
 $session
 
 $response
 
- Attributs protégés hérités de BaseApplication
 $dispatcher
 
 $identity
 
- 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 WebApplication
 $charSet = 'utf-8'
 
 $mimeType = 'text/html'
 
 $modifiedDate
 
 $client
 
- Champs de données hérités de AbstractApplication
 $input = null
 
- 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,
\JApplicationWebClient  $client = null 
)

Class constructor.

Paramètres
Input$inputAn optional argument to provide dependency injection for the application's input object. If the argument is a object that object will become the application's input object, otherwise a default input object is created.
Registry$configAn 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.
\JApplicationWebClient$clientAn optional argument to provide dependency injection for the application's client object. If the argument is a object that object will become the application's client object, otherwise a default client object is created.
Depuis
3.2

Références $client, $config, et $input.

Documentation des fonctions membres

◆ authorise()

authorise (   $itemid)
protected

Check if the user can access the application

Paramètres
integer$itemidThe item ID to check authorisation for
Renvoie
void
Depuis
3.2
Exceptions

Références $itemid, $url, et $user.

◆ dispatch()

dispatch (   $component = null)

Dispatch the application

Paramètres
string$componentThe component which is being rendered.
Renvoie
void
Depuis
3.2

Références $component, $document, $params, $template, getDocument, JROUTER_MODE_SEF, null, et ComponentHelper\renderComponent().

◆ 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

◆ getMenu()

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

Return a reference to the object.

Paramètres
string$nameThe name of the application/client.
array$optionsAn optional associative array of configuration settings.
Renvoie
object.
Depuis
3.2

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

◆ getPageParameters()

getPageParameters (   $option = null)

Get the application parameters

Paramètres
string$optionThe component option
Renvoie
Registry The parameters object
Depuis
3.2
Obsolète:
4.0 Use getParams() instead

Références $option.

◆ getParams()

getParams (   $option = null)

Get the application parameters

Paramètres
string$optionThe component option
Renvoie
Registry The parameters object
Depuis
3.2

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

◆ getPathway()

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

Return a reference to the object.

Paramètres
string$nameThe name of the application.
array$optionsAn optional associative array of configuration settings.
Renvoie
A object
Depuis
3.2

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

◆ getRouter()

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

Return a reference to the object.

Paramètres
string$nameThe name of the application.
array$optionsAn optional associative array of configuration settings.
Renvoie
Depuis
3.2

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

◆ getTemplate()

getTemplate (   $params = false)

Gets the name of the current template.

Paramètres
boolean$paramsTrue to return the template parameters
Renvoie
string The name of the template.
Depuis
3.2
Exceptions

Références $db, $id, $item, $menu, $params, $query, $template, $tmpl, JPATH_THEMES, et null.

◆ initialiseApp()

initialiseApp (   $options = array())
protected

Initialise the application.

Paramètres
array$optionsAn optional associative array of configuration settings.
Renvoie
void
Depuis
3.2

Références $lang, $options, $params, $user, ComponentHelper\getParams(), et null.

◆ loadLibraryLanguage()

loadLibraryLanguage ( )
protected

Load the library language files for the application

Renvoie
void
Depuis
3.6.3

Références JPATH_ADMINISTRATOR, JPATH_SITE, et null.

◆ login()

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

Login authentication function

Paramètres
array$credentialsArray('username' => string, 'password' => string)
array$optionsArray('remember' => boolean)
Renvoie
boolean True on success.
Depuis
3.2

Références $options.

◆ 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 $file, $template, 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 null.

◆ setDetectBrowser()

setDetectBrowser (   $state = false)

Set the current state of the detect browser option.

Paramètres
boolean$stateThe 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$stateThe 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
string$templateThe template name
mixed$styleParamsThe 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 :