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

Fonctions membres publiques

 __construct (Application $application, ?AbstractCommand $command=null)
 
 disableCommand ()
 
 enableCommand ()
 
 isCommandEnabled ()
 
- Fonctions membres publiques hérités de ConsoleEvent
 __construct (string $name, Application $application, ?AbstractCommand $command=null)
 
 getApplication ()
 
 getCommand ()
 
- Fonctions membres publiques hérités de Event
 addArgument ($name, $value)
 
 setArgument ($name, $value)
 
 removeArgument ($name)
 
 clearArguments ()
 
 stop ()
 
 offsetSet ($name, $value)
 
 offsetUnset ($name)
 
- Fonctions membres publiques hérités de AbstractEvent
 __construct ($name, array $arguments=[])
 
 getName ()
 
 getArgument ($name, $default=null)
 
 hasArgument ($name)
 
 getArguments ()
 
 isStopped ()
 
 stopPropagation ()
 
 count ()
 
 serialize ()
 
 __serialize ()
 
 unserialize ($serialized)
 
 __unserialize (array $data)
 
 offsetExists ($name)
 
 offsetGet ($name)
 

Champs de données

const RETURN_CODE_DISABLED = 113
 

Attributs privés

 $commandEnabled = true
 

Membres hérités additionnels

- Attributs protégés hérités de AbstractEvent
 $name
 
 $arguments
 
 $stopped = false
 

Description détaillée

Event triggered before a command is executed.

Depuis
2.0.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Application  $application,
?AbstractCommand  $command = null 
)

Event constructor.

Paramètres
Application$applicationThe active application.
AbstractCommand | null$commandThe command being executed.
Depuis
2.0.0

Références ConsoleEvent\$application, ConsoleEvent\$command, Symfony\Contracts\Service\__construct(), et ConsoleEvents\BEFORE_COMMAND_EXECUTE.

Documentation des fonctions membres

◆ disableCommand()

disableCommand ( )

Disable the command.

Renvoie
void
Depuis
2.0.0

◆ enableCommand()

enableCommand ( )

Enable the command.

Renvoie
void
Depuis
2.0.0

◆ isCommandEnabled()

isCommandEnabled ( )

Check if the command is enabled.

Renvoie
boolean
Depuis
2.0.0

Références BeforeCommandExecuteEvent\$commandEnabled.

Documentation des champs

◆ $commandEnabled

$commandEnabled = true
private

◆ RETURN_CODE_DISABLED

const RETURN_CODE_DISABLED = 113

Référencé par Application\runCommand().


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