abstract class Option extends Alvine

Optionen werden anders als Argumente immer mit einem einfachen oder doppelten Minus eingeleitet.

Optionen dienen zur genaueren Spezifikation eines Arguments.

Optionen müssen die Methode onMatch definieren, um die gewünschte Aktion auszuführen.

Properties

protected string $name
protected string $alias
protected boolean $required
protected string $description
protected integer $maxLimit
protected integer $counter

Methods

__construct(string $name, string $alias = null)

Neues Objekt

setDescription(string $description)

Hilfstext

execute(mixed $value)

Ausführen der Option

string
getName()

Name

string
getAlias()

Kurzform des Befehls (ein Buchstabe)

setRequired(boolean $flag = true)

Pflichtangabe

boolean
isRequired()

Pflichtangabe prüfen

setLimitCount(integer $count)

Anzahl

mixed
validate($value)

Überprüfen des Wertes

string
getDescription()

Beschreibung

string
__toString()

Rückgabe der Definition als Hilfstext

Details

at line 81
__construct(string $name, string $alias = null)

Neues Objekt

Der Alias darf einen Buchstaben besitzen

Parameters

string $name Name (--name)
string $alias Alias (-alias)

at line 96
Option setDescription(string $description)

Hilfstext

Parameters

string $description Beschreibung

Return Value

Option

at line 117
Option execute(mixed $value)

Ausführen der Option

Diese Methode prüft ob das Objekt eine Methode onMatch besitzt und ruft diese in dem Fall auf.

Wird keine Methode onMatch definiert, so erfolgt keine weitere Operation.

Parameters

mixed $value Wert

Return Value

Option

Exceptions

LimitException

at line 139
string getName()

Name

Return Value

string Name

at line 148
string getAlias()

Kurzform des Befehls (ein Buchstabe)

Return Value

string Alias

at line 159
Option setRequired(boolean $flag = true)

Pflichtangabe

Parameters

boolean $flag

Return Value

Option

at line 169
boolean isRequired()

Pflichtangabe prüfen

Return Value

boolean

at line 180
Option setLimitCount(integer $count)

Anzahl

Parameters

integer $count Anzahl

Return Value

Option

at line 193
abstract mixed validate($value)

Überprüfen des Wertes

Parameters

$value

Return Value

mixed Wert

at line 200
string getDescription()

Beschreibung

Return Value

string Beschreibung

at line 209
string __toString()

Rückgabe der Definition als Hilfstext

Return Value

string