Class Option

Optionen

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.

Alvine\Core\Alvine

Alvine\Application\Console\Option

Direct known subclasses

Alvine\Application\Console\Option\ArgumentList, Alvine\Application\Console\Option\Boolean, Alvine\Application\Console\Option\Integer, Alvine\Application\Console\Option\StringType

Indirect known subclasses

Alvine\Application\Console\Option\OptionList

Abstract
Namespace: Alvine\Application\Console
Package: Alvine\Application
Category: Alvine
License: Alvine Nutzungslizenz
Author: schukai GmbH info@schukai.de
Version: $Revision: 216 $
Since: 20140420
Link: alvine.io
Link: http://wiki.bash-hackers.org/scripting/terminalcodes
Located at console/Option.class.php

Methods summary
`public`	# `__construct( string $name, string $alias = null )` Neues Objekt Neues Objekt Parameters `$name` Name (--name) `$alias` Alias (-alias)
`public Alvine\Application\Console\Option`	# `setDescription( string $description )` Hilfstext Hilfstext Parameters `$description` Beschreibung Returns `Alvine\Application\Console\Option`
`public Alvine\Application\Console\Option`	# `execute( mixed $value )` Ausführen der Option 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 `$value` Wert Returns `Alvine\Application\Console\Option` Throws `Alvine\Application\Console\Option\LimitException`
`public string`	# `getName( )` Name Name Returns string Name
`public string`	# `getAlias( )` Alias Alias Returns string Alias
`public Alvine\Application\Console\Option`	# `setRequired( boolean $flag = true )` Pflichtangabe Pflichtangabe Parameters `$flag` Returns `Alvine\Application\Console\Option`
`public boolean`	# `isRequired( )` Pflichtangabe prüfen Pflichtangabe prüfen Returns boolean
`public Alvine\Application\Console\Option`	# `setLimitCount( integer $count )` Anzahl Anzahl Parameters `$count` Anzahl Returns `Alvine\Application\Console\Option`
`abstract public mixed`	# `validate( $value )` Überprüfen des Wertes Überprüfen des Wertes Returns mixed Wert Var \mixed Wert
`public string`	# `getDescription( )` Beschreibung Beschreibung Returns string Beschreibung
`public string`	# `__toString( )` Rückgabe der Definition als Hilfstext Rückgabe der Definition als Hilfstext Returns string

Properties summary
`protected string`	`$name` Name Name	#
`protected string`	`$alias` Alias Alias	#
`protected boolean`	`$required` Argument muss angegeben werden Argument muss angegeben werden	#
`protected string`	`$description` Hilfstext Hilfstext	#
`protected integer`	`$maxLimit` Begrenzung der Verwendung Begrenzung der Verwendung	#
`protected integer`	`$counter` Zähler Zähler	#

Namespaces

Classes

Class Option

Direct known subclasses

Indirect known subclasses

Parameters

Parameters

Returns

Parameters

Returns

Throws

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Var

Returns

Returns