Class Command

Befehl

Ein Befehl stellt ein Argument das Ihn auslöst und die verfügbaren Optionen bereit. Über die onMatch-Methoden der Argumente und Methoden wird das Verhalten des Befehls gesteuert.

// Schalteroption (boolean) mit dem Namen --myoption und dem Alias -o
$myOption = new \Alvine\Application\Console\Option\Boolean('myoption','o');
// Darf einmal auftreten
$myOption->setLimitCount(1);
// Hat einen Hilfetext
$myOption->setDescription('Beschreibung');
// Wird die Option aufgerufen so wird im Befehlsobjekt der Wert gesetzt
$myOption->onMatch = function(\Alvine\Application\Console\Option $option, $value) {
  // ... mache etwas mit $option und $value
};

$arg = new \Alvine\Application\Console\Argument('myCommand');

// Option hinzufügen
$arg->add($myOption);
$arg->onMatch = function(\Alvine\Application\Console\Argument $argument, \Alvine\Types\StringList $options, \Alvine\Types\StringList $global) {
  // ... mache etwas mit $argument, $options, $global
};
$arg->setDescription('Mein Befehl');

Ein Befehl bearbeitet massgeblich die onMatch() Methoden der Argumente und Optionen.

Application -> ArgumentParser: parse() ArgumentParser -> Argument: hasPosition() ArgumentParser -> Argument: isRequired() ArgumentParser -> Argument: execute() Argument -> OptionParser: add($option) OptionParser -> Option: getName() OptionParser -> Option: getAlias() OptionParser -> Option: isRequired() OptionParser -> Option: execute() Option -> Option: onMatch($value) note right: Die definierte Funktion besitzt als\nzusaetlichen Parameter die Option\nund ist definiert als\n onMatch($option, $value) Argument -> OptionParser: parse() Argument -> Argument: onMatch($options, $global) note right: Die definierte Funktion besitzt als\nzusaetlichen Parameter das Argument\nund ist definiert als\n onMatch($argument, $options, $global)