Getopt is a class to parse options for command-line applications.
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.
The following features are supported:
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.
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.
The constructor takes one to three parameters.
The first parameter is $rules, which may be a string for gnu-style format, or a structured array for Zend-style format.
The second parameter is $argv, and it is optional. If not specified, $argv is inferred from the global argv.
The third parameter is an array of configuration parameters to control the behavior of this instance of Getopt; it is optional.
| Parameters: |
|
|---|---|
| Throws ExceptionInvalidArgumentException: | |
Return the state of the option seen on the command line of the current application invocation. This function returns true, or the parameter to the option, if any. If the option was not given, this function returns null.
The magic __get method works in the context of naming the option as a virtual member of this class.
| Parameters: | string – |
|---|---|
| Return type: | string |
Test whether a given option has been seen.
| Parameters: | string – |
|---|---|
| Return type: | bool |
Set the value for a given option.
| Parameters: |
|
|---|---|
| Return type: | void |
Return the current set of options and parameters seen as a string.
| Return type: | string |
|---|
Define additional command-line arguments. These are appended to those defined when the constructor was called.
| Parameters: | array – |
|---|---|
| Throws ZendConsoleExceptionInvalidArgumentException: | |
| When not given an array as parameter | |
| Return type: | ZendConsoleGetopt Provides a fluent interface |
Define full set of command-line arguments. These replace any currently defined.
| Parameters: | array – |
|---|---|
| Throws ZendConsoleExceptionInvalidArgumentException: | |
| When not given an array as parameter | |
| Return type: | ZendConsoleGetopt Provides a fluent interface |
Define multiple configuration options from an associative array. These are not program options, but properties to configure the behavior of Zend_Console_Getopt.
| Parameters: | array – |
|---|---|
| Return type: | ZendConsoleGetopt Provides a fluent interface |
Define one configuration option as a key/value pair. These are not program options, but properties to configure the behavior of Zend_Console_Getopt.
| Parameters: |
|
|---|---|
| Return type: | ZendConsoleGetopt Provides a fluent interface |
Define additional option rules. These are appended to the rules defined when the constructor was called.
| Parameters: | array – |
|---|---|
| Return type: | ZendConsoleGetopt Provides a fluent interface |
Return the current set of options and parameters seen as a string.
| Return type: | string |
|---|
Return the current set of options and parameters seen as an array of canonical options and parameters.
Clusters have been expanded, and option aliases have been mapped to their primary option names.
| Return type: | array |
|---|
Return the current set of options and parameters seen in Json format.
| Return type: | string |
|---|
Return the current set of options and parameters seen in XML format.
| Return type: | string |
|---|
Return a list of options that have been seen in the current argv.
| Return type: | array |
|---|
Return the state of the option seen on the command line of the current application invocation.
This function returns true, or the parameter value to the option, if any. If the option was not given, this function returns false.
| Parameters: | string – |
|---|---|
| Return type: | mixed |
Return the arguments from the command-line following all options found.
| Return type: | array |
|---|
Return a useful option reference, formatted for display in an error message.
Note that this usage information is provided in most Exceptions generated by this class.
| Return type: | string |
|---|
Define aliases for options.
The parameter $aliasMap is an associative array mapping option name (short or long) to an alias.
| Parameters: | array – |
|---|---|
| Throws ZendConsoleExceptionExceptionInterface: | |
| Return type: | ZendConsoleGetopt Provides a fluent interface |
Define help messages for options.
The parameter $helpMap is an associative array mapping option name (short or long) to the help string.
| Parameters: | array – |
|---|---|
| Return type: | ZendConsoleGetopt Provides a fluent interface |
Parse command-line arguments and find both long and short options.
Also find option parameters, and remaining arguments after all options have been parsed.
| Return type: | ZendConsoleGetopt|null Provides a fluent interface |
|---|
Parse command-line arguments for a single long option. A long option is preceded by a double ‘–’ character. Long options may not be clustered.
| Parameters: | mixed – |
|---|---|
| Return type: | void |
Parse command-line arguments for short options. Short options are those preceded by a single ‘-‘ character. Short options may be clustered.
| Parameters: | mixed – |
|---|---|
| Return type: | void |
Parse command-line arguments for a single option.
| Parameters: |
|
|---|---|
| Throws ZendConsoleExceptionExceptionInterface: | |
| Return type: | void |
Set given value as value of numeric option
Throw runtime exception if this action is deny by configuration or no one numeric option handlers is defined
| Parameters: | int – |
|---|---|
| Throws ExceptionRuntimeException: | |
| Return type: | void |
Add relative to options’ flag value
If options list already has current flag as key and parser should follow cumulative params by configuration, we should to add new param to array, not to overwrite
| Parameters: |
|
|---|---|
| Return type: | null |
Set TRUE value to given flag, if this option does not exist yet In other case increase value to show count of flags’ usage
| Parameters: | string – |
|---|---|
| Return type: | null |
Return true if the parameter is in a valid format for the option $flag. Throw an exception in most other cases.
| Parameters: |
|
|---|---|
| Throws ZendConsoleExceptionExceptionInterface: | |
| Return type: | bool |
The options for a given application can be in multiple formats. modeGnu is for traditional ‘ab:c:’ style getopt format. modeZend is for a more structured format.
Constant tokens for various symbols used in the mode_zend rule format.
These are constants for optional behavior of this class. ruleMode is either ‘zend’ or ‘gnu’ or a user-defined mode. dashDash is true if ‘–’ signifies the end of command-line options. ignoreCase is true if ‘–opt’ and ‘–OPT’ are implicitly synonyms. parseAll is true if all options on the command line should be parsed, regardless of whether an argument appears before them.