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

Fonctions membres publiques

 __construct (Input $input=null, Registry $config=null, \JApplicationWebClient $client=null)
 
 dispatch ($component=null)
 
 getTemplate ($params=false)
 
 login ($credentials, $options=array())
 
- Fonctions membres publiques hérités de CMSApplication
 __construct (Input $input=null, Registry $config=null, \JApplicationWebClient $client=null)
 
 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='administrator', array $options=array())
 
static purgeMessages ()
 
- 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

 doExecute ()
 
 initialiseApp ($options=array())
 
 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 ()
 

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
 
- 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
 
- 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! Administrator 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, $input, et null.

Documentation des fonctions membres

◆ 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, $template, JAdministratorHelper\findOption(), getDocument, et null.

◆ doExecute()

doExecute ( )
protected

Method to run the Web application routines.

Renvoie
void
Depuis
3.2

Références $lang, $options, JDEBUG, et null.

◆ getRouter()

static getRouter (   $name = 'administrator',
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, $params, $query, $template, et JPATH_THEMES.

◆ 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, et ComponentHelper\getParams().

◆ 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 $lang, et $options.

◆ purgeMessages()

static purgeMessages ( )
static

Purge the jos_messages table of old messages

Renvoie
void
Depuis
3.2

Références $config, $db, $query, et $user.

◆ 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 $component, $file, $input, et elseif.

◆ 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 $uri.


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