Class Argument

Argument

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');

Alvine\Core\Alvine

Alvine\Application\Console\Argument

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/Argument.class.php

Methods summary
`public`	# `__construct( string $name )` Neues Terminal-Objekt Neues Terminal-Objekt Für globale Befehle, muss der Name für Argument::GLOBALKEY sein Parameters `$name` Name
`public Alvine\Application\Console\Argument`	# `add( Alvine\Application\Console\Option $option )` Option hinzufügen Option hinzufügen Parameters `$option` Option Returns `Alvine\Application\Console\Argument`
`public boolean`	# `hasPosition( )` Position Position Returns boolean Position
`public Alvine\Application\Console\Argument`	# `setPosition( integer $position )` Position Position Parameters `$position` Position Returns `Alvine\Application\Console\Argument`
`public integer`	# `getPosition( )` Position Position Returns integer Position
`public Alvine\Application\Console\Argument`	# `execute( Alvine\Types\StringList $options = null, Alvine\Types\StringList $global = null )` Execute 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 `$options` Optionen `$global` Globale Optionen Returns `Alvine\Application\Console\Argument`
`public Alvine\Application\Console\Argument`	# `setDescription( string $description )` Beschreibung Beschreibung Parameters `$description` Beschreibung Returns `Alvine\Application\Console\Argument`
`public string`	# `getDescription( )` Beschreibung Beschreibung Returns string Beschreibung
`public string`	# `getName( )` Name Name Returns string Name
`public Alvine\Application\Console\Argument`	# `setRequired( boolean $flag = true )` Erforderlich Erforderlich Parameters `$flag` Erforderlich Returns `Alvine\Application\Console\Argument`
`public boolean`	# `isRequired( )` Erforderlich Erforderlich Returns boolean Erforderlich
`public string`	# `validate( string $value )` Wert Wert Parameters `$value` Wert Returns string Wert
`public string`	# `__toString( )` Zeichenkette Zeichenkette Ausgabe des Arguments als Hilfetext mit allen Informationen Returns string Hilfetexte

Constants summary
`string`	`GLOBALKEY` Name für globale Optionen Name für globale Optionen	# `'globalargument'`

Properties summary
`protected string`	`$name` Name des Arguments. Für globale Argumente muss der Name Argument::GLOBALKEY sein. Name des Arguments. Für globale Argumente muss der Name Argument::GLOBALKEY sein.	#
`protected boolean`	`$required` Argument muss angegeben werden Argument muss angegeben werden	#
`protected string`	`$description` Beschreibung für Hilfe Beschreibung für Hilfe	#
`protected type`	`$option` Optionen Optionen	#
`protected type`	`$position`	#

Namespaces

Classes

Class Argument

Parameters

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns