1. class
  2. Alvine
  3. \
  4. Application
  5. \
  6. Console
  7. \
  8. Option
  9. \
  10. OptionList

OptionList

class OptionList extends StringType

Liste mit Argumenten

Properties

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

Methods

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

Neues Objekt

from Option
Option
setDescription(string $description)

Hilfstext

from Option
Option
execute(mixed $value)

Ausführen der Option

from Option
string
getName()

Name

from Option
string
getAlias()

Kurzform des Befehls (ein Buchstabe)

from Option
Option
setRequired(boolean $flag = true)

Pflichtangabe

from Option
boolean
isRequired()

Pflichtangabe prüfen

from Option
Option
setLimitCount(integer $count)

Anzahl

from Option
mixed
validate($value)

Überprüfe Wert

from StringType
string
getDescription()

Beschreibung

from Option
string
__toString()

Rückgabe der Definition als Hilfstext

from Option

Details

in Option 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)

in Option at line 96
Option setDescription(string $description)

Hilfstext

Parameters

string $description Beschreibung

Return Value

Option

in 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

in Option at line 139
string getName()

Name

Return Value

string Name

in Option at line 148
string getAlias()

Kurzform des Befehls (ein Buchstabe)

Return Value

string Alias

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

Pflichtangabe

Parameters

boolean $flag

Return Value

Option

in Option at line 169
boolean isRequired()

Pflichtangabe prüfen

Return Value

boolean

in Option at line 180
Option setLimitCount(integer $count)

Anzahl

Parameters

integer $count Anzahl

Return Value

Option

in StringType at line 41
mixed validate($value)

Überprüfe Wert

Parameters

$value

Return Value

mixed Wert

in Option at line 200
string getDescription()

Beschreibung

Return Value

string Beschreibung

in Option at line 209
string __toString()

Rückgabe der Definition als Hilfstext

Return Value

string