Terminology: Argument: an element of the argv array. This may be part of an option, or it may be a non-option command-line argument. Flag: the letter or word set off by a '-' or '--'. Example: in '--output filename', '--output' is the flag. Parameter: the additional argument that is associated with the option. Example: in '--output filename', the 'filename' is the parameter. Option: the combination of a flag and its parameter, if any. Example: in '--output filename', the whole thing is the option.

The following features are supported:

• Short flags like '-a'. Short flags are preceded by a single dash. Short flags may be clustered e.g. '-abc', which is the same as '-a' '-b' '-c'.
• Long flags like '--verbose'. Long flags are preceded by a double dash. Long flags may not be clustered.
• Options may have a parameter, e.g. '--output filename'.
• Parameters for long flags may also be set off with an equals sign, e.g. '--output=filename'.
• Parameters for long flags may be checked as string, word, or integer.
• Automatic generation of a helpful usage message.
• Signal end of options with '--'; subsequent arguments are treated as non-option arguments, even if they begin with '-'.
• Raise exception Zend\Console\Exception* in several cases when invalid flags or parameters are given. Usage message is returned in the exception object.

The format for specifying options uses a PHP associative array. The key is has the format of a list of pipe-separated flag names, followed by an optional '=' to indicate a required parameter or '-' to indicate an optional parameter. Following that, the type of parameter may be specified as 's' for string, 'w' for word, or 'i' for integer.

Examples: - 'user|username|u=s' this means '--user' or '--username' or '-u' are synonyms, and the option requires a string parameter. - 'p=i' this means '-p' requires an integer parameter. No synonyms. - 'verbose|v-i' this means '--verbose' or '-v' are synonyms, and they take an optional integer parameter. - 'help|h' this means '--help' or '-h' are synonyms, and they take no parameter.

The values in the associative array are strings that are used as brief descriptions of the options when printing a usage message.

The simpler format for specifying options used by PHP's getopt() function is also supported. This is similar to GNU getopt and shell getopt format.

Example: 'abc:' means options '-a', '-b', and '-c' are legal, and the latter requires a string parameter.

 Methods

__construct(array $rules, array $argv, array $getoptConfig) 

__get(string $key) : string

__isset(string $key) : bool

__set(string $key, string $value) 

__toString() : string

__unset(string $key) 

addArguments(array $argv) : \Zend\Console\self

addRules(array $rules) : \Zend\Console\self

getArguments() 

getOption(string $flag) : mixed

getOptions() : array

getRemainingArgs() : array

getUsageMessage() : string

parse() : \Zend\Console\self

setAliases(array $aliasMap) : \Zend\Console\self

setArguments(array $argv) : \Zend\Console\self

setHelp(array $helpMap) : \Zend\Console\self

setOption(string $configKey, string $configValue) : \Zend\Console\self

setOptionCallback(string $option, \Closure $callback) : \Zend\Console\self

setOptions(array $getoptConfig) : \Zend\Console\self

toArray() : array

toJson() : string

toString() : string

toXml() : string

_addRulesModeGnu(string $rules) 

_addRulesModeZend(array $rules) 

_checkParameterType(string $flag, string $param) : bool

_parseLongOption(mixed $argv) 

_parseShortOptionCluster(mixed $argv) 

_parseSingleOption(string $flag, mixed $argv) 

_setBooleanFlagValue(string $flag) 

_setNumericOptionValue(int $value) : void

_setSingleOptionValue(string $flag, string $value) 

triggerCallbacks() 

 Properties

$argv : array

$getoptConfig 

$optionCallbacks : array

$options : array

$parsed : bool

$progname : string

$remainingArgs : array

$ruleMap : array

$rules : array

 Constants

CONFIG_CUMULATIVE_FLAGS 

CONFIG_CUMULATIVE_PARAMETERS 

CONFIG_DASHDASH 

CONFIG_FREEFORM_FLAGS 

CONFIG_IGNORECASE 

CONFIG_NUMERIC_FLAGS 

CONFIG_PARAMETER_SEPARATOR 

CONFIG_PARSEALL 

CONFIG_RULEMODE 

MODE_GNU 

MODE_ZEND 

PARAM_OPTIONAL 

PARAM_REQUIRED 

TYPE_INTEGER 

TYPE_NUMERIC_FLAG 

TYPE_STRING 

TYPE_WORD