Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Fonctions membres publiques | Fonctions membres publiques statiques | Fonctions membres protégées | Attributs protégés | Attributs privés
Référence de la classe ConsoleApplication
+ Graphe d'héritage de ConsoleApplication:

Fonctions membres publiques

 __construct (Registry $config, DispatcherInterface $dispatcher, Container $container, Language $language, ?InputInterface $input=null, ?OutputInterface $output=null)
 
 __get ($name)
 
 execute ()
 
 enqueueMessage ($msg, $type=self::MSG_INFO)
 
 getName ()
 
 getConfig ()
 
 getInput ()
 
 getLanguage ()
 
 getMessageQueue ()
 
 getSession ()
 
 isClient ($identifier)
 
 isCli ()
 
 setSession (SessionInterface $session)
 
 flushAssets ()
 
 getLongVersion ()
 
 setName (string $name)
 
- Fonctions membres publiques hérités de Application
 __construct (?InputInterface $input=null, ?OutputInterface $output=null, ?Registry $config=null)
 
 addCommand (AbstractCommand $command)
 
 execute ()
 
 findNamespace (string $namespace)
 
 getAllCommands (string $namespace='')
 
 getCommands ()
 
 getConsoleInput ()
 
 getConsoleOutput ()
 
 getDefinition ()
 
 getHelperSet ()
 
 getLongVersion ()
 
 getName ()
 
 getNamespaces ()
 
 getVersion ()
 
 hasCommand (string $name)
 
 renderThrowable (\Throwable $throwable)
 
 setAutoExit (bool $autoExit)
 
 setCatchThrowables (bool $catchThrowables)
 
 setCommandLoader (Loader\LoaderInterface $loader)
 
 setHelperSet (HelperSet $helperSet)
 
 setName (string $name)
 
 setVersion (string $version)
 
 shouldAutoExit ()
 
 shouldCatchThrowables ()
 
- 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 CMSApplicationInterface
 getIdentity ()
 
 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=null, array $options=array())
 

Fonctions membres protégées

 doExecute ()
 
 getDefaultCommands ()
 
 populateHttpHost ()
 
 getDefaultInputDefinition ()
 
- Fonctions membres protégées hérités de Application
 configureIO ()
 
 doExecute ()
 
 getCommandName (InputInterface $input)
 
 getDefaultCommands ()
 
 getDefaultInputDefinition ()
 
 getDefaultHelperSet ()
 
 initialise ()
 
 doRenderThrowable (\Throwable $throwable, OutputInterface $output)
 
 runCommand (AbstractCommand $command, InputInterface $input, OutputInterface $output)
 
- Fonctions membres protégées hérités de AbstractApplication
 dispatchEvent (string $eventName, ?EventInterface $event=null)
 
 doExecute ()
 
 initialise ()
 

Attributs protégés

 $input = null
 
 $name = null
 
 $language
 
- Attributs protégés hérités de AbstractApplication
 $config
 

Attributs privés

 $messages = []
 
 $session
 

Membres hérités additionnels

- 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'
 

Description détaillée

The Joomla! CMS Console Application

Depuis
4.0.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Registry  $config,
DispatcherInterface  $dispatcher,
Container  $container,
Language  $language,
?InputInterface  $input = null,
?OutputInterface  $output = 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.
DispatcherInterface$dispatcherAn optional argument to provide dependency injection for the application's event dispatcher. If the argument is a DispatcherInterface object that object will become the application's event dispatcher, if it is null then the default event dispatcher will be created based on the application's loadDispatcher() method.
Container$containerDependency injection container.
Language$languageThe language object provisioned for the application.
InputInterface | null$inputAn optional argument to provide dependency injection for the application's input object. If the argument is an InputInterface object that object will become the application's input object, otherwise a default input object is created.
OutputInterface | null$outputAn optional argument to provide dependency injection for the application's output object. If the argument is an OutputInterface object that object will become the application's output object, otherwise a default output object is created.
Depuis
4.0.0

Références $input, $language, $output, Symfony\Contracts\Service\__construct(), language, name, Joomla\DI\setContainer(), et Joomla\Event\setDispatcher().

Documentation des fonctions membres

◆ __get()

__get (   $name)

Magic method to access properties of the application.

Paramètres
string$nameThe name of the property.
Renvoie
mixed A value if the property name is valid, null otherwise.
Depuis
4.0.0
Obsolète:
5.0 This is a B/C proxy for deprecated read accesses

Références $name, et Joomla\Application\getInput().

◆ doExecute()

doExecute ( )
protected

Method to run the application routines.

Renvoie
integer The exit code for the application
Depuis
4.0.0
Exceptions

Références $messages, $method, $style, et $type.

◆ enqueueMessage()

enqueueMessage (   $msg,
  $type = self::MSG_INFO 
)

Enqueue a system message.

Paramètres
string$msgThe message to enqueue.
string$typeThe message type.
Renvoie
void
Depuis
4.0.0

Implémente CMSApplicationInterface.

Références $type.

◆ execute()

execute ( )

Execute the application.

Renvoie
void
Depuis
4.0.0
Exceptions

Address issues with instantiating WebApplication descendants under CLI.

IMPORTANT! This code must be always be executed before the first use of PluginHelper::importPlugin(). Some plugins will attempt to register an MVCFactory for a component in their service provider. This will in turn try to get the SiteRouter service for the component which tries to get an instance of SiteApplication which will fail with a RuntimeException if the populateHttpHost() method has not already executed.

Implémente ApplicationInterface.

Références PluginHelper\importPlugin().

◆ flushAssets()

flushAssets ( )

Flush the media version to refresh versionable assets

Renvoie
void
Depuis
4.0.0

◆ getConfig()

getConfig ( )

Retrieve the application configuration object.

Renvoie
Registry
Depuis
4.0.0

Références $config.

◆ getDefaultCommands()

getDefaultCommands ( )
protected

Get the commands which should be registered by default to the application.

Renvoie
[]
Depuis
4.0.0

Références Joomla\Database\getDatabase().

◆ getDefaultInputDefinition()

getDefaultInputDefinition ( )
protected

Builds the default input definition.

Renvoie
InputDefinition
Depuis
4.2.1

Références null, InputArgument\REQUIRED, InputOption\VALUE_NONE, et InputOption\VALUE_OPTIONAL.

◆ getInput()

getInput ( )

Method to get the application input object.

Renvoie
Input
Depuis
4.0.0

Implémente CMSApplicationInterface.

Références $input.

◆ getLanguage()

getLanguage ( )

Method to get the application language object.

Renvoie
Language The language object
Depuis
4.0.0

Implémente CMSApplicationInterface.

Références $language.

◆ getLongVersion()

getLongVersion ( )

Get the long version string for the application.

Overrides the parent method due to conflicting use of the getName method between the console application and the CMS application interface.

Renvoie
string
Depuis
4.0.0

Références JDEBUG.

◆ getMessageQueue()

getMessageQueue ( )

Get the system message queue.

Renvoie
array The system message queue.
Depuis
4.0.0

Implémente CMSApplicationInterface.

Références $messages.

◆ getName()

getName ( )

Gets the name of the current running application.

Renvoie
string The name of the application.
Depuis
4.0.0

Implémente CMSApplicationInterface.

Références $name.

◆ getRouter()

static getRouter (   $name = null,
array  $options = array() 
)
static

Returns the application Router object.

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

Références $name, $options, Factory\getApplication(), et Router\getInstance().

◆ getSession()

getSession ( )

Method to get the application session object.

Renvoie
SessionInterface The session object
Depuis
4.0.0

◆ isCli()

isCli ( )

Flag if the application instance is a CLI or web based application.

Helper function, you should use the native PHP functions to detect if it is a CLI application.

Renvoie
boolean
Depuis
4.0.0
Obsolète:
5.0 Will be removed without replacements

Implémente CMSApplicationInterface.

◆ isClient()

isClient (   $identifier)

Check the client interface by name.

Paramètres
string$identifierString identifier for the application interface
Renvoie
boolean True if this application is of the given type client interface.
Depuis
4.0.0

Implémente CMSApplicationInterface.

◆ populateHttpHost()

populateHttpHost ( )
protected

Populates the HTTP_HOST and REQUEST_URI from the URL provided in the –live-site parameter.

If the URL provided is empty or invalid we will use the URL https://joomla.invalid/set/by/console/application just so that the CLI application doesn't crash when a WebApplication descendant is instantiated in it.

This is a practical workaround for using any service depending on a WebApplication descendant under CLI.

Practical example: using a component's MVCFactory which instantiates the SiteRouter service for that component which in turn relies on an instance of SiteApplication.

Renvoie
void
Depuis
4.2.1
Voir également
https://github.com/joomla/joomla-cms/issues/38518

Try to use the live site URL we were given. If all else fails, fall back to https://joomla.invalid/set/by/console/application.

Yes, this is icky but it is the only way to trick WebApplication into compliance.

Voir également
::detectRequestUri

Références $input, $uri, et Uri\getInstance().

◆ setName()

setName ( string  $name)

Set the name of the application.

Paramètres
string$nameThe new application name.
Renvoie
void
Depuis
4.0.0
Exceptions

◆ setSession()

setSession ( SessionInterface  $session)

Sets the session for the application to use, if required.

Paramètres
SessionInterface$sessionA session object.
Renvoie
$this
Depuis
4.0.0

Références $this.

Documentation des champs

◆ $input

$input = null
protected

◆ $language

$language
protected

◆ $messages

$messages = []
private

◆ $name

$name = null
protected

◆ $session

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