Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe AdministratorApplication
+ Graphe d'héritage de AdministratorApplication:

Fonctions membres publiques

 __construct (Input $input=null, Registry $config=null, WebClient $client=null, Container $container=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, 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='administrator', array $options=array())
 
static purgeMessages ()
 
- 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

 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 ()
 
 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

 $allowedUnprivilegedOptions
 
- 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! Administrator 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$inputAn 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$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.
WebClient$clientAn 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$containerDependency injection container.
Depuis
3.2

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

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 $clientId, $component, $document, Factory\$document, $template, Text\_(), Factory\getDocument(), 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 $options, JDEBUG, et null.

◆ getRouter()

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

Return a reference to the Router object.

Paramètres
string$nameThe name of the application.
array$optionsAn optional associative array of configuration settings.
Renvoie
Router
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.

◆ 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 $params, $template, Text\_(), Joomla\CMS\Application\getIdentity(), InputFilter\getInstance(), Joomla\CMS\Application\getLogger(), JPATH_THEMES, et Text\sprintf().

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

◆ 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, $options, $result, Uri\base(), et Joomla\CMS\Application\getIdentity().

◆ purgeMessages()

static purgeMessages ( )
static

Purge the jos_messages table of old messages

Renvoie
void
Depuis
3.2
Obsolète:
5.0 Purge the messages through the model

Références Factory\getApplication(), et Factory\getUser().

◆ 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, $input, elseif, Session\getFormToken(), Factory\getUser(), et Text\sprintf().

◆ 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, Uri\getInstance(), PluginHelper\importPlugin(), et Joomla\CMS\Application\triggerEvent().

Documentation des champs

◆ $allowedUnprivilegedOptions

$allowedUnprivilegedOptions
protected
Valeur initiale :
= [
'com_login',
'com_ajax',
]

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