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 statiques | Attributs privés
Référence de la classe AbstractCommand
+ Graphe d'héritage de AbstractCommand:

Fonctions membres publiques

 __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 publiques statiques

static getDefaultName ()
 

Fonctions membres protégées

 configure ()
 
 doExecute (InputInterface $input, OutputInterface $output)
 
 initialise (InputInterface $input, OutputInterface $output)
 

Attributs protégés statiques

static $defaultName
 

Attributs privés

 $aliases = []
 
 $application
 
 $applicationDefinitionMerged = false
 
 $applicationDefinitionMergedWithArgs = false
 
 $definition
 
 $description = ''
 
 $help = ''
 
 $helperSet
 
 $hidden = false
 
 $name
 
 $synopsis = []
 

Description détaillée

Base command class for a Joomla! command line application.

Depuis
2.0.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( ?string  $name = null)

Command constructor.

Paramètres
string | null$nameThe name of the command; if the name is empty and no default is set, a name must be set in the configure() method
Depuis
2.0.0

Références AbstractCommand\$name, AbstractCommand\configure(), null, et AbstractCommand\setName().

Documentation des fonctions membres

◆ addArgument()

addArgument ( string  $name,
?int  $mode = null,
string  $description = '',
  $default = null 
)

Adds an argument to the input definition.

Paramètres
string$nameThe argument name
integer$modeThe argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL
string$descriptionA description text
mixed$defaultThe default value (for InputArgument::OPTIONAL mode only)
Renvoie
$this
Depuis
2.0.0

Références $default, AbstractCommand\$description, $mode, AbstractCommand\$name, et $this.

Référencé par ListCommand\configure(), et DebugEventDispatcherCommand\configure().

◆ addOption()

addOption ( string  $name,
  $shortcut = null,
?int  $mode = null,
  $description = '',
  $default = null 
)

Adds an option to the input definition.

Paramètres
string$nameThe option name
string | array$shortcutThe shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts
integer$modeThe option mode: One of the VALUE_* constants
string$descriptionA description text
mixed$defaultThe default value (must be null for InputOption::VALUE_NONE)
Renvoie
$this
Depuis
2.0.0

Références $default, AbstractCommand\$description, $mode, AbstractCommand\$name, et $this.

Référencé par DebugRouterCommand\configure(), ExportCommand\configure(), et ImportCommand\configure().

◆ configure()

configure ( )
protected

Configure the command.

Renvoie
void
Depuis
2.0.0

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

◆ doExecute()

doExecute ( InputInterface  $input,
OutputInterface  $output 
)
abstractprotected

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

Référencé par AbstractCommand\execute().

◆ execute()

execute ( InputInterface  $input,
OutputInterface  $output 
)

Executes 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

Références $input, $output, InputInterface\bind(), AbstractCommand\doExecute(), AbstractCommand\getDefinition(), AbstractCommand\getName(), AbstractCommand\getSynopsis(), AbstractCommand\initialise(), AbstractCommand\mergeApplicationDefinition(), null, et InputInterface\validate().

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

◆ getAliases()

getAliases ( )

Get the command's aliases.

Renvoie
string[]
Depuis
2.0.0

Références AbstractCommand\$aliases.

Référencé par Application\addCommand(), TextDescriptor\describeConsoleCommand(), et TextDescriptor\getCommandAliasesText().

◆ getApplication()

getApplication ( )

Get the application object.

Renvoie
Application The application object.
Depuis
2.0.0
Exceptions

Références AbstractCommand\$application, et $this.

Référencé par AbstractCommand\mergeApplicationDefinition().

◆ getDefaultName()

static getDefaultName ( )
static

Get the default command name for this class.

This allows a command name to defined and referenced without instantiating the full command class.

Renvoie
string|null
Depuis
2.0.0

Références $class, $r, et null.

Référencé par SiteDownCommand\doExecute(), SiteUpCommand\doExecute(), et Application\register().

◆ getDefinition()

getDefinition ( )

Gets the InputDefinition attached to this command.

Renvoie
InputDefinition
Depuis
2.0.0

Références AbstractCommand\$definition.

Référencé par Application\addCommand(), TextDescriptor\describeConsoleCommand(), AbstractCommand\execute(), AbstractCommand\getSynopsis(), AbstractCommand\mergeApplicationDefinition(), et Application\runCommand().

◆ getDescription()

getDescription ( )

Get the command's description.

Renvoie
string
Depuis
2.0.0

Références AbstractCommand\$description.

Référencé par AbstractCommand\getProcessedHelp().

◆ getHelp()

getHelp ( )

Get the command's help.

Renvoie
string
Depuis
2.0.0

Références AbstractCommand\$help.

Référencé par AbstractCommand\getProcessedHelp().

◆ getHelperSet()

getHelperSet ( )

Get the command's input helper set.

Renvoie
HelperSet|null
Depuis
2.0.0

Références AbstractCommand\$helperSet.

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

◆ getName()

getName ( )

Get the command's name.

Renvoie
string|null
Depuis
2.0.0

Références AbstractCommand\$name.

Référencé par Application\addCommand(), AbstractCommand\execute(), AbstractCommand\getProcessedHelp(), et AbstractCommand\getSynopsis().

◆ getProcessedHelp()

getProcessedHelp ( )

Returns the processed help for the command.

This method is used to replace placeholders in commands with the real values. By default, this supports command.name% and command.full_name.

Renvoie
string
Depuis
2.0.0

Références AbstractCommand\$name, AbstractCommand\getDescription(), AbstractCommand\getHelp(), et AbstractCommand\getName().

Référencé par TextDescriptor\describeConsoleCommand().

◆ getSynopsis()

getSynopsis ( bool  $short = false)

Get the command's synopsis.

Paramètres
boolean$shortFlag indicating whether the short or long version of the synopsis should be returned
Renvoie
string
Depuis
2.0.0

Références $key, AbstractCommand\getDefinition(), et AbstractCommand\getName().

Référencé par TextDescriptor\describeConsoleCommand(), et AbstractCommand\execute().

◆ initialise()

initialise ( InputInterface  $input,
OutputInterface  $output 
)
protected

Internal hook to initialise the command after the input has been bound and before the input is validated.

Paramètres
InputInterface$inputThe input to inject into the command.
OutputInterface$outputThe output to inject into the command.
Renvoie
void
Depuis
2.0.0

Référencé par AbstractCommand\execute().

◆ isEnabled()

isEnabled ( )

Check if the command is enabled in this environment.

Renvoie
boolean
Depuis
2.0.0

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

◆ isHidden()

isHidden ( )

Check if the command is hidden from the command listing.

Renvoie
boolean
Depuis
2.0.0

Références AbstractCommand\$hidden.

◆ mergeApplicationDefinition()

mergeApplicationDefinition ( bool  $mergeArgs = true)
final

Merges the application definition with the command definition.

Paramètres
boolean$mergeArgsFlag indicating whether the application's definition arguments should be merged
Renvoie
void
Depuis
2.0.0

Références AbstractCommand\getApplication(), et AbstractCommand\getDefinition().

Référencé par TextDescriptor\describeConsoleCommand(), AbstractCommand\execute(), et Application\runCommand().

◆ setAliases()

setAliases ( array  $aliases)

Set the command's aliases.

Paramètres
string[]$aliases The command aliases
Renvoie
void
Depuis
2.0.0

Références AbstractCommand\$aliases.

◆ setApplication()

setApplication ( ?Application  $application = null)

Set the command's application.

Paramètres
Application$applicationThe command's application
Renvoie
void
Depuis
2.0.0

Références AbstractCommand\$application, null, et AbstractCommand\setHelperSet().

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

◆ setDefinition()

setDefinition (   $definition)

Sets the input definition for the command.

Paramètres
array | InputDefinition$definitionEither an InputDefinition object or an array of objects to write to the definition.
Renvoie
void
Depuis
2.0.0

Références AbstractCommand\$definition.

◆ setDescription()

setDescription ( string  $description)

Sets the description for the command.

Paramètres
string$descriptionThe description for the command
Renvoie
void
Depuis
2.0.0

Références AbstractCommand\$description, et description.

Référencé par ListCommand\configure(), HelpCommand\configure(), DebugEventDispatcherCommand\configure(), DebugRouterCommand\configure(), CreateSessionTableCommand\configure(), ExportCommand\configure(), et ImportCommand\configure().

◆ setHelp()

setHelp ( string  $help)

Sets the help for the command.

Paramètres
string$helpThe help for the command
Renvoie
void
Depuis
2.0.0

Références AbstractCommand\$help.

Référencé par ListCommand\configure(), HelpCommand\configure(), DebugEventDispatcherCommand\configure(), et DebugRouterCommand\configure().

◆ setHelperSet()

setHelperSet ( HelperSet  $helperSet)

Set the command's input helper set.

Paramètres
HelperSet$helperSetThe helper set.
Renvoie
void
Depuis
2.0.0

Références AbstractCommand\$helperSet.

Référencé par AbstractCommand\setApplication().

◆ setHidden()

setHidden ( bool  $hidden)

Set whether this command is hidden from the command listing.

Paramètres
boolean$hiddenFlag if this command is hidden.
Renvoie
void
Depuis
2.0.0

Références AbstractCommand\$hidden.

◆ setName()

setName ( string  $name)

Set the command's name.

Paramètres
string$nameThe command name
Renvoie
void
Depuis
2.0.0

Références AbstractCommand\$name, et name.

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

Documentation des champs

◆ $aliases

$aliases = []
private

Référencé par AbstractCommand\getAliases(), et AbstractCommand\setAliases().

◆ $application

$application
private

Référencé par AbstractCommand\getApplication(), et AbstractCommand\setApplication().

◆ $applicationDefinitionMerged

$applicationDefinitionMerged = false
private

◆ $applicationDefinitionMergedWithArgs

$applicationDefinitionMergedWithArgs = false
private

◆ $defaultName

$defaultName
staticprotected

◆ $definition

$definition
private

Référencé par AbstractCommand\getDefinition(), et AbstractCommand\setDefinition().

◆ $description

$description = ''
private

Référencé par AbstractCommand\addArgument(), AbstractCommand\addOption(), AbstractCommand\getDescription(), et AbstractCommand\setDescription().

◆ $help

$help = ''
private

Référencé par AbstractCommand\getHelp(), et AbstractCommand\setHelp().

◆ $helperSet

$helperSet
private

Référencé par AbstractCommand\getHelperSet(), et AbstractCommand\setHelperSet().

◆ $hidden

$hidden = false
private

Référencé par AbstractCommand\isHidden(), et AbstractCommand\setHidden().

◆ $name

$name
private

Référencé par AbstractCommand\__construct(), AbstractCommand\addArgument(), AbstractCommand\addOption(), AbstractCommand\getName(), AbstractCommand\getProcessedHelp(), et AbstractCommand\setName().

◆ $synopsis

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