1. class
  2. Alvine
  3. \
  4. Application
  5. \
  6. Console
  7. \
  8. Argument

Argument

class Argument extends Alvine

Ein Argument kann beim aufruf einer Komandozeilenanwendung nach dem Dateinamen angegeben werden.

$arg = new \Alvine\Application\Console\Argument('myCommand');
$arg->onMatch = function($obj, $cmd, $options) {
  // ... mache etwas mit $cmd und $options
};
$arg->setDescription('Mein Befehl');

Constants

GLOBALKEY

Name für globale Optionen

Properties

protected string $name
protected boolean $required
protected string $description
protected type $option
protected type $position

Methods

__construct(string $name)

Neues Terminal-Objekt

Argument
add(Option $option)

Option hinzufügen

boolean
hasPosition()

Position

Argument
setPosition(integer $position)

Position

integer
getPosition()

Position

Argument
execute(StringList $options = null, StringList $global = null)

Execute

Argument
setDescription(string $description)

Beschreibung

string
getDescription()

Beschreibung

string
getName()

Name

Argument
setRequired(boolean $flag = true)

Erforderlich

boolean
isRequired()

Erforderlich

string
validate(string $value)

Wert

string
__toString()

Zeichenkette

Argument
addDebugOption(Command $command)

No description

Argument
addOutputOption(Command $command)

No description

Argument
addVerboseOption(Command $command)

No description

Details

at line 90
__construct(string $name)

Neues Terminal-Objekt

Für globale Befehle, muss der Name für Argument::GLOBALKEY sein

Parameters

string $name Name

at line 108
Argument add(Option $option)

Option hinzufügen

Parameters

Option $option Option

Return Value

Argument

at line 118
boolean hasPosition()

Position

Return Value

boolean Position

at line 129
Argument setPosition(integer $position)

Position

Parameters

integer $position Position

Return Value

Argument

at line 139
integer getPosition()

Position

Return Value

integer Position

at line 163
Argument execute(StringList $options = null, StringList $global = null)

Execute

Ausführen eines Arguments und Aufruf der Argument::onMatch() Methode.

(new \Alvine\Application\Console\Argument('addnode'))->onMatch
    = function(\Alvine\Application\Console\Argument $argument, // Argument
               \Alvine\Types\StringList $options,             // übergebene Optionen
               \Alvine\Types\StringList $global) {            // übergebene Gloabloptionen
  // ... mach was ...
}

Parameters

StringList $options Optionen
StringList $global Globale Optionen

Return Value

Argument

at line 188
Argument setDescription(string $description)

Beschreibung

Parameters

string $description Beschreibung

Return Value

Argument

at line 198
string getDescription()

Beschreibung

Return Value

string Beschreibung

at line 207
string getName()

Name

Return Value

string Name

at line 218
Argument setRequired(boolean $flag = true)

Erforderlich

Parameters

boolean $flag Erforderlich

Return Value

Argument

at line 228
boolean isRequired()

Erforderlich

Return Value

boolean Erforderlich

at line 239
string validate(string $value)

Wert

Parameters

string $value Wert

Return Value

string Wert

at line 250
string __toString()

Zeichenkette

Ausgabe des Arguments als Hilfetext mit allen Informationen

Return Value

string Hilfetexte

at line 287
Argument addDebugOption(Command $command)

Parameters

Command $command

Return Value

Argument

at line 306
Argument addOutputOption(Command $command)

Parameters

Command $command

Return Value

Argument

at line 325
Argument addVerboseOption(Command $command)

Parameters

Command $command

Return Value

Argument