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

Fonctions membres publiques

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

 dispatchEvent (string $eventName, ?EventInterface $event=null)
 
 doExecute ()
 
 initialise ()
 

Attributs protégés

 $config
 

Description détaillée

Joomla Framework Base Application Class

Depuis
1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Registry  $config = null)

Class constructor.

Paramètres
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
1.0

Références AbstractApplication\$config, et AbstractApplication\initialise().

Documentation des fonctions membres

◆ close()

close (   $code = 0)

Method to close the application.

Paramètres
integer$codeThe exit code (optional; default is 0).
Renvoie
void
Depuis
1.0

Implémente ApplicationInterface.

Référencé par Application\__construct(), Application\execute(), et AbstractWebApplication\redirect().

◆ dispatchEvent()

dispatchEvent ( string  $eventName,
?EventInterface  $event = null 
)
protected

Dispatches an application event if the dispatcher has been set.

Paramètres
string$eventNameThe event to dispatch.
EventInterface | null$eventThe event object.
Renvoie
EventInterface|null The dispatched event or null if no dispatcher is set
Depuis
2.0.0

Références $this, Joomla\CMS\Application\getDispatcher(), et null.

Référencé par Application\doExecute(), AbstractApplication\execute(), AbstractWebApplication\execute(), Application\execute(), AbstractWebApplication\redirect(), et Application\runCommand().

◆ doExecute()

doExecute ( )
abstractprotected

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
mixed
Depuis
1.0

Référencé par AbstractApplication\execute(), et AbstractWebApplication\execute().

◆ execute()

◆ get()

get (   $key,
  $default = null 
)

Returns a property of the object or the default value if the property is not set.

Paramètres
string$keyThe name of the property.
mixed$defaultThe default value (optional) if none is set.
Renvoie
mixed The value of the configuration.
Depuis
1.0

Implémente ConfigurationAwareApplicationInterface.

Références $default, et $key.

Référencé par MetadataManager\createSessionRecord(), et MetadataManager\updateSessionRecord().

◆ getLogger()

getLogger ( )

Get the logger.

Renvoie
LoggerInterface
Depuis
1.0

Références LoggerAwareInterface\setLogger().

◆ initialise()

initialise ( )
protected

Custom initialisation method.

Called at the end of the AbstractApplication::__construct method. This is for developers to inject initialisation code for their application classes.

Renvoie
void
Depuis
1.0

Référencé par AbstractApplication\__construct().

◆ set()

set (   $key,
  $value = null 
)

Modifies a property of the object, creating it if it does not already exist.

Paramètres
string$keyThe name of the property.
mixed$valueThe value of the property to set (optional).
Renvoie
mixed Previous value of the property
Depuis
1.0

Implémente ConfigurationAwareApplicationInterface.

Références $key, et $value.

◆ setConfiguration()

setConfiguration ( Registry  $config)

Sets the configuration for the application.

Paramètres
Registry$configA registry object holding the configuration.
Renvoie
$this
Depuis
1.0

Implémente ConfigurationAwareApplicationInterface.

Références AbstractApplication\$config, et $this.

Documentation des champs

◆ $config


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