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

Fonctions membres publiques

 setCommand (AbstractCommand $command)
 
- Fonctions membres publiques hérités de AbstractCommand
 __construct (?string $name=null)
 
 addArgument (string $name, ?int $mode=null, string $description='', $default=null)
 
 addOption (string $name, $shortcut=null, ?int $mode=null, $description='', $default=null)
 
 execute (InputInterface $input, OutputInterface $output)
 
 getAliases ()
 
 getApplication ()
 
 getDefinition ()
 
 getDescription ()
 
 getHelp ()
 
 getHelperSet ()
 
 getName ()
 
 getProcessedHelp ()
 
 getSynopsis (bool $short=false)
 
 isEnabled ()
 
 isHidden ()
 
 mergeApplicationDefinition (bool $mergeArgs=true)
 
 setAliases (array $aliases)
 
 setApplication (?Application $application=null)
 
 setDefinition ($definition)
 
 setDescription (string $description)
 
 setHelp (string $help)
 
 setHelperSet (HelperSet $helperSet)
 
 setHidden (bool $hidden)
 
 setName (string $name)
 

Fonctions membres protégées

 configure ()
 
 doExecute (InputInterface $input, OutputInterface $output)
 
- Fonctions membres protégées hérités de AbstractCommand
 configure ()
 
 doExecute (InputInterface $input, OutputInterface $output)
 
 initialise (InputInterface $input, OutputInterface $output)
 

Attributs protégés statiques

static $defaultName = 'help'
 
- Attributs protégés statiques hérités de AbstractCommand
static $defaultName
 

Attributs privés

 $command
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de AbstractCommand
static getDefaultName ()
 

Description détaillée

Command to render a command's help data.

Depuis
2.0.0

Documentation des fonctions membres

◆ configure()

configure ( )
protected

Configure the command.

Renvoie
void
Depuis
2.0.0

Références name, AbstractCommand\setDescription(), et AbstractCommand\setHelp().

◆ doExecute()

doExecute ( InputInterface  $input,
OutputInterface  $output 
)
protected

Internal function to execute the command.

Paramètres
InputInterface$inputThe input to inject into the command.
OutputInterface$outputThe output to inject into the command.
Renvoie
integer The command exit code
Depuis
2.0.0

◆ setCommand()

setCommand ( AbstractCommand  $command)

Set the command whose help is being presented.

Paramètres
AbstractCommand$commandThe command to process help for.
Renvoie
void
Depuis
2.0.0

Documentation des champs

◆ $command

$command
private

◆ $defaultName

$defaultName = 'help'
staticprotected
La documentation de cette classe a été générée à partir du fichier suivant :