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 BaseApplication
+ Graphe d'héritage de BaseApplication:

Fonctions membres publiques

 __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 protégées

 doExecute ()
 
- Fonctions membres protégées hérités de AbstractApplication
 doExecute ()
 
 initialise ()
 

Attributs protégés

 $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 AbstractApplication
 $input = null
 

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Input  $input = null,
Registry  $config = 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.
Depuis
12.1

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

Documentation des fonctions membres

◆ doExecute()

doExecute ( )
protected

Method to run the application routines. Most likely you will want to instantiate a controller and execute it, or perform some sort of task directly.

Renvoie
void
Depuis
3.4 (CMS)
Obsolète:
4.0 The default concrete implementation of doExecute() will be removed, subclasses will need to provide their own implementation.

◆ getIdentity()

getIdentity ( )

Get the application identity.

Renvoie
mixed A object or null.
Depuis
12.1

◆ loadDispatcher()

loadDispatcher ( \JEventDispatcher  $dispatcher = null)

Allows the application to load a custom or default dispatcher.

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

Paramètres
\JEventDispatcher$dispatcherAn optional dispatcher object. If omitted, the factory dispatcher is created.
Renvoie
BaseApplication This method is chainable.
Depuis
12.1

Références $dispatcher, JEventDispatcher\getInstance(), et null.

◆ loadIdentity()

loadIdentity ( \JUser  $identity = null)

Allows the application to load a custom or default identity.

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

Paramètres
\JUser$identityAn optional identity object. If omitted, the factory user is created.
Renvoie
BaseApplication This method is chainable.
Depuis
12.1

Références null.

◆ registerEvent()

registerEvent (   $event,
  $handler 
)

Registers a handler to a particular event group.

Paramètres
string$eventThe event name.
callable$handlerThe handler, a function or an instance of an event object.
Renvoie
BaseApplication The application to allow chaining.
Depuis
12.1

◆ triggerEvent()

triggerEvent (   $event,
array  $args = null 
)

Calls all handlers associated with an event group.

Paramètres
string$eventThe event name.
array$argsAn array of arguments (optional).
Renvoie
array An array of results from each function call, or null if no dispatcher is defined.
Depuis
12.1

Documentation des champs

◆ $dispatcher

$dispatcher
protected

◆ $identity

$identity
protected

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