Public Member Functions
	__construct ($rules, $argv=null, $getoptConfig=array())

	__get ($key)

	__isset ($key)

	__set ($key, $value)

	__toString ()

	__unset ($key)

	addArguments ($argv)

	setArguments ($argv)

	setOptions ($getoptConfig)

	setOption ($configKey, $configValue)

	addRules ($rules)

	toString ()

	toArray ()

	toJson ()

	toXml ()

	getOptions ()

	getOption ($flag)

	getRemainingArgs ()

	getUsageMessage ()

	setAliases ($aliasMap)

	setHelp ($helpMap)

	parse ()

	checkRequiredArguments ()

Data Fields
const	MODE_ZEND = 'zend'

const	MODE_GNU = 'gnu'

const	PARAM_REQUIRED = '='

const	PARAM_OPTIONAL = '-'

const	TYPE_STRING = 's'

const	TYPE_WORD = 'w'

const	TYPE_INTEGER = 'i'

const	CONFIG_RULEMODE = 'ruleMode'

const	CONFIG_DASHDASH = 'dashDash'

const	CONFIG_IGNORECASE = 'ignoreCase'

const	CONFIG_PARSEALL = 'parseAll'

Protected Member Functions
	_parseLongOption (&$argv)

	_parseShortOptionCluster (&$argv)

	_parseSingleOption ($flag, &$argv)

	_checkParameterType ($flag, $param)

	_addRulesModeGnu ($rules)

	_addRulesModeZend ($rules)

Protected Attributes
	$_getoptConfig

	$_argv = array()

	$_progname = ''

	$_rules = array()

	$_ruleMap = array()

	$_options = array()

	$_remainingArgs = array()

	$_parsed = false

Detailed Description

Definition at line 127 of file Getopt.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$rules,
		$argv = `null`,
		$getoptConfig = `array()`
	)

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

array	$rules
array	$argv
array	$getoptConfig

Returns: void

Definition at line 242 of file Getopt.php.

     {
         if (!isset($_SERVER['argv'])) {
             #require_once 'Zend/Console/Getopt/Exception.php';
             if (ini_get('register_argc_argv') == false) {
                 throw new Zend_Console_Getopt_Exception(
                     "argv is not available, because ini option 'register_argc_argv' is set Off"
                 );
             } else {
                 throw new Zend_Console_Getopt_Exception(
                     '$_SERVER["argv"] is not set, but Zend_Console_Getopt cannot work without this information.'
                 );
             }
         }
 
         $this->_progname = $_SERVER['argv'][0];
         $this->setOptions($getoptConfig);
         $this->addRules($rules);
         if (!is_array($argv)) {
             $argv = array_slice($_SERVER['argv'], 1);
         }
         if (isset($argv)) {
             $this->addArguments((array)$argv);
         }
     }

Member Function Documentation

◆ __get()

__get ( $key )

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 $key

Returns: string

Definition at line 280 of file Getopt.php.

     {
         return $this->getOption($key);
     }

◆ __isset()

__isset ( $key )

Test whether a given option has been seen.

Parameters

string $key

Returns: boolean

Definition at line 291 of file Getopt.php.

     {
         $this->parse();
         if (isset($this->_ruleMap[$key])) {
             $key = $this->_ruleMap[$key];
             return isset($this->_options[$key]);
         }
         return false;
     }

◆ __set()

__set	(	$key,
		$value
	)

Set the value for a given option.

Parameters

string	$key
string	$value

Returns: void

Definition at line 308 of file Getopt.php.

     {
         $this->parse();
         if (isset($this->_ruleMap[$key])) {
             $key = $this->_ruleMap[$key];
             $this->_options[$key] = $value;
         }
     }

◆ __toString()

__toString ( )

Return the current set of options and parameters seen as a string.

Returns: string

Definition at line 322 of file Getopt.php.

     {
         return $this->toString();
     }

◆ __unset()

__unset ( $key )

Unset an option.

Parameters

string $key

Returns: void

Definition at line 333 of file Getopt.php.

     {
         $this->parse();
         if (isset($this->_ruleMap[$key])) {
             $key = $this->_ruleMap[$key];
             unset($this->_options[$key]);
         }
     }

◆ _addRulesModeGnu()

_addRulesModeGnu ( $rules )

protected

Define legal options using the gnu-style format.

Parameters

string $rules

Returns: void

Options may be single alphanumeric characters. Options may have a ':' which indicates a required string parameter. No long options or option aliases are supported in GNU style.

Definition at line 884 of file Getopt.php.

     {
         $ruleArray = array();
 
         preg_match_all('/([a-zA-Z0-9]:?)/', $rules, $ruleArray);
         foreach ($ruleArray[1] as $rule) {
             $r = array();
             $flag = substr($rule, 0, 1);
             if ($this->_getoptConfig[self::CONFIG_IGNORECASE]) {
                 $flag = strtolower($flag);
             }
             $r['alias'][] = $flag;
             if (substr($rule, 1, 1) == ':') {
                 $r['param'] = 'required';
                 $r['paramType'] = 'string';
             } else {
                 $r['param'] = 'none';
             }
             $this->_rules[$flag] = $r;
             $this->_ruleMap[$flag] = $flag;
         }
     }

◆ _addRulesModeZend()

_addRulesModeZend ( $rules )

protected

Define legal options using the Zend-style format.

Parameters

array $rules

Exceptions

Zend_Console_Getopt_Exception

Returns: void

Definition at line 919 of file Getopt.php.

     {
         foreach ($rules as $ruleCode => $helpMessage)
         {
             // this may have to translate the long parm type if there
             // are any complaints that =string will not work (even though that use
             // case is not documented)
             if (in_array(substr($ruleCode, -2, 1), array('-', '='))) {
                 $flagList  = substr($ruleCode, 0, -2);
                 $delimiter = substr($ruleCode, -2, 1);
                 $paramType = substr($ruleCode, -1);
             } else {
                 $flagList = $ruleCode;
                 $delimiter = $paramType = null;
             }
             if ($this->_getoptConfig[self::CONFIG_IGNORECASE]) {
                 $flagList = strtolower($flagList);
             }
             $flags = explode('|', $flagList);
             $rule = array();
             $mainFlag = $flags[0];
             foreach ($flags as $flag) {
                 if (empty($flag)) {
                     #require_once 'Zend/Console/Getopt/Exception.php';
                     throw new Zend_Console_Getopt_Exception(
                         "Blank flag not allowed in rule \"$ruleCode\".");
                 }
                 if (strlen($flag) == 1) {
                     if (isset($this->_ruleMap[$flag])) {
                         #require_once 'Zend/Console/Getopt/Exception.php';
                         throw new Zend_Console_Getopt_Exception(
                             "Option \"-$flag\" is being defined more than once.");
                     }
                     $this->_ruleMap[$flag] = $mainFlag;
                     $rule['alias'][] = $flag;
                 } else {
                     if (isset($this->_rules[$flag]) || isset($this->_ruleMap[$flag])) {
                         #require_once 'Zend/Console/Getopt/Exception.php';
                         throw new Zend_Console_Getopt_Exception(
                             "Option \"--$flag\" is being defined more than once.");
                     }
                     $this->_ruleMap[$flag] = $mainFlag;
                     $rule['alias'][] = $flag;
                 }
             }
             if (isset($delimiter)) {
                 switch ($delimiter) {
                     case self::PARAM_REQUIRED:
                         $rule['param'] = 'required';
                         break;
                     case self::PARAM_OPTIONAL:
                     default:
                         $rule['param'] = 'optional';
                 }
                 switch (substr($paramType, 0, 1)) {
                     case self::TYPE_WORD:
                         $rule['paramType'] = 'word';
                         break;
                     case self::TYPE_INTEGER:
                         $rule['paramType'] = 'integer';
                         break;
                     case self::TYPE_STRING:
                     default:
                         $rule['paramType'] = 'string';
                 }
             } else {
                 $rule['param'] = 'none';
             }
             $rule['help'] = $helpMessage;
             $this->_rules[$mainFlag] = $rule;
         }
     }

◆ _checkParameterType()

_checkParameterType	(	$flag,
		$param
	)

protected

Return true if the parameter is in a valid format for the option $flag. Throw an exception in most other cases.

Parameters

string	$flag
string	$param

Exceptions

Zend_Console_Getopt_Exception

Returns: bool

Definition at line 848 of file Getopt.php.

     {
         $type = 'string';
         if (isset($this->_rules[$flag]['paramType'])) {
             $type = $this->_rules[$flag]['paramType'];
         }
         switch ($type) {
             case 'word':
                 if (preg_match('/\W/', $param)) {
                     #require_once 'Zend/Console/Getopt/Exception.php';
                     throw new Zend_Console_Getopt_Exception(
                         "Option \"$flag\" requires a single-word parameter, but was given \"$param\".",
                         $this->getUsageMessage());
                 }
                 break;
             case 'integer':
                 if (preg_match('/\D/', $param)) {
                     #require_once 'Zend/Console/Getopt/Exception.php';
                     throw new Zend_Console_Getopt_Exception(
                         "Option \"$flag\" requires an integer parameter, but was given \"$param\".",
                         $this->getUsageMessage());
                 }
                 break;
             case 'string':
             default:
                 break;
         }
         return true;
     }

◆ _parseLongOption()

_parseLongOption ( & $argv )

protected

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 &$argv

Returns: void

Definition at line 764 of file Getopt.php.

     {
         $optionWithParam = ltrim(array_shift($argv), '-');
         $l = explode('=', $optionWithParam, 2);
         $flag = array_shift($l);
         $param = array_shift($l);
         if (isset($param)) {
             array_unshift($argv, $param);
         }
         $this->_parseSingleOption($flag, $argv);
     }

◆ _parseShortOptionCluster()

_parseShortOptionCluster ( & $argv )

protected

Parse command-line arguments for short options. Short options are those preceded by a single '-' character. Short options may be clustered.

Parameters

mixed &$argv

Returns: void

Definition at line 784 of file Getopt.php.

     {
         $flagCluster = ltrim(array_shift($argv), '-');
         foreach (str_split($flagCluster) as $flag) {
             $this->_parseSingleOption($flag, $argv);
         }
     }

◆ _parseSingleOption()

_parseSingleOption	(		$flag,
		&	$argv
	)

protected

Parse command-line arguments for a single option.

Parameters

string	$flag
mixed	$argv

Exceptions

Zend_Console_Getopt_Exception

Returns: void

Definition at line 800 of file Getopt.php.

     {
         if ($this->_getoptConfig[self::CONFIG_IGNORECASE]) {
             $flag = strtolower($flag);
         }
         if (!isset($this->_ruleMap[$flag])) {
             #require_once 'Zend/Console/Getopt/Exception.php';
             throw new Zend_Console_Getopt_Exception(
                 "Option \"$flag\" is not recognized.",
                 $this->getUsageMessage());
         }
         $realFlag = $this->_ruleMap[$flag];
         switch ($this->_rules[$realFlag]['param']) {
             case 'required':
                 if (count($argv) > 0 && substr($argv[0], 0, 1) != '-') {
                     $param = array_shift($argv);
                     $this->_checkParameterType($realFlag, $param);
                 } else {
                     #require_once 'Zend/Console/Getopt/Exception.php';
                     throw new Zend_Console_Getopt_Exception(
                         "Option \"$flag\" requires a parameter.",
                         $this->getUsageMessage());
                 }
                 break;
             case 'optional':
                 if (count($argv) > 0 && substr($argv[0], 0, 1) != '-') {
                     $param = array_shift($argv);
                     $this->_checkParameterType($realFlag, $param);
                 } else {
                     $param = true;
                 }
                 break;
             default:
                 $param = true;
         }
         $this->_options[$realFlag] = $param;
     }

◆ addArguments()

addArguments ( $argv )

Define additional command-line arguments. These are appended to those defined when the constructor was called.

Parameters

array $argv

Exceptions

Zend_Console_Getopt_Exception When not given an array as parameter

Returns: Zend_Console_Getopt Provides a fluent interface

Definition at line 350 of file Getopt.php.

     {
         if(!is_array($argv)) {
             #require_once 'Zend/Console/Getopt/Exception.php';
             throw new Zend_Console_Getopt_Exception(
                 "Parameter #1 to addArguments should be an array");
         }
         $this->_argv = array_merge($this->_argv, $argv);
         $this->_parsed = false;
         return $this;
     }

◆ addRules()

addRules ( $rules )

Define additional option rules. These are appended to the rules defined when the constructor was called.

Parameters

array $rules

Returns: Zend_Console_Getopt Provides a fluent interface

Call addRulesModeFoo() for ruleMode 'foo'. The developer should subclass Getopt and provide this method.

Definition at line 424 of file Getopt.php.

     {
         $ruleMode = $this->_getoptConfig['ruleMode'];
         switch ($this->_getoptConfig['ruleMode']) {
             case self::MODE_ZEND:
                 if (is_array($rules)) {
                     $this->_addRulesModeZend($rules);
                     break;
                 }
                 // intentional fallthrough
             case self::MODE_GNU:
                 $this->_addRulesModeGnu($rules);
                 break;
             default:
                 $method = '_addRulesMode' . ucfirst($ruleMode);
                 $this->$method($rules);
         }
         $this->_parsed = false;
         return $this;
     }

◆ checkRequiredArguments()

checkRequiredArguments ( )

Exceptions

Zend_Console_Getopt_Exception

Definition at line 737 of file Getopt.php.

     {
         foreach ($this->_rules as $name => $rule) {
             if ($rule['param'] === 'required') {
                 $defined = false;
                 foreach ($rule['alias'] as $alias) {
                     $defined = $defined === true ? true : array_key_exists($alias, $this->_options);
                 }
                 if ($defined === false) {
                     #require_once 'Zend/Console/Getopt/Exception.php';
                     throw new Zend_Console_Getopt_Exception(
                         'Option "$alias" requires a parameter.',
                         $this->getUsageMessage()
                     );
                 }
             }
         }
     }

◆ getOption()

getOption ( $flag )

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 null.

Parameters

string $flag

Returns: mixed

Definition at line 558 of file Getopt.php.

     {
         $this->parse();
         if ($this->_getoptConfig[self::CONFIG_IGNORECASE]) {
             $flag = strtolower($flag);
         }
         if (isset($this->_ruleMap[$flag])) {
             $flag = $this->_ruleMap[$flag];
             if (isset($this->_options[$flag])) {
                 return $this->_options[$flag];
             }
         }
         return null;
     }

◆ getOptions()

getOptions ( )

Return a list of options that have been seen in the current argv.

Returns: array

Definition at line 542 of file Getopt.php.

     {
         $this->parse();
         return array_keys($this->_options);
     }

◆ getRemainingArgs()

getRemainingArgs ( )

Return the arguments from the command-line following all options found.

Returns: array

Definition at line 578 of file Getopt.php.

     {
         $this->parse();
         return $this->_remainingArgs;
     }

◆ getUsageMessage()

getUsageMessage ( )

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.

Returns: string

Definition at line 593 of file Getopt.php.

     {
         $usage = "Usage: {$this->_progname} [ options ]\n";
         $maxLen = 20;
         $lines = array();
         foreach ($this->_rules as $rule) {
             $flags = array();
             if (is_array($rule['alias'])) {
                 foreach ($rule['alias'] as $flag) {
                     $flags[] = (strlen($flag) == 1 ? '-' : '--') . $flag;
                 }
             }
             $linepart['name'] = implode('|', $flags);
             if (isset($rule['param']) && $rule['param'] != 'none') {
                 $linepart['name'] .= ' ';
                 switch ($rule['param']) {
                     case 'optional':
                         $linepart['name'] .= "[ <{$rule['paramType']}> ]";
                         break;
                     case 'required':
                         $linepart['name'] .= "<{$rule['paramType']}>";
                         break;
                 }
             }
             if (strlen($linepart['name']) > $maxLen) {
                 $maxLen = strlen($linepart['name']);
             }
             $linepart['help'] = '';
             if (isset($rule['help'])) {
                 $linepart['help'] .= $rule['help'];
             }
             $lines[] = $linepart;
         }
         foreach ($lines as $linepart) {
             $usage .= sprintf("%s %s\n",
             str_pad($linepart['name'], $maxLen),
             $linepart['help']);
         }
         return $usage;
     }

◆ parse()

parse ( )

Parse command-line arguments and find both long and short options.

Also find option parameters, and remaining arguments after all options have been parsed.

Returns: Zend_Console_Getopt|null Provides a fluent interface

Definition at line 699 of file Getopt.php.

     {
         if ($this->_parsed === true) {
             return;
         }
         $argv = $this->_argv;
         $this->_options = array();
         $this->_remainingArgs = array();
         while (count($argv) > 0) {
             if ($argv[0] == '--') {
                 array_shift($argv);
                 if ($this->_getoptConfig[self::CONFIG_DASHDASH]) {
                     $this->_remainingArgs = array_merge($this->_remainingArgs, $argv);
                     break;
                 }
             }
             if (substr($argv[0], 0, 2) == '--') {
                 $this->_parseLongOption($argv);
             } else if (substr($argv[0], 0, 1) == '-' && ('-' != $argv[0] || count($argv) >1))  {
                 $this->_parseShortOptionCluster($argv);
             } else if($this->_getoptConfig[self::CONFIG_PARSEALL]) {
                 $this->_remainingArgs[] = array_shift($argv);
             } else {
                 /*
                  * We should put all other arguments in _remainingArgs and stop parsing
                  * since CONFIG_PARSEALL is false.
                  */
                 $this->_remainingArgs = array_merge($this->_remainingArgs, $argv);
                 break;
             }
         }
         $this->_parsed = true;
         return $this;
     }

◆ setAliases()

setAliases ( $aliasMap )

Define aliases for options.

The parameter $aliasMap is an associative array mapping option name (short or long) to an alias.

Parameters

array $aliasMap

Exceptions

Zend_Console_Getopt_Exception

Returns: Zend_Console_Getopt Provides a fluent interface

Definition at line 644 of file Getopt.php.

     {
         foreach ($aliasMap as $flag => $alias)
         {
             if ($this->_getoptConfig[self::CONFIG_IGNORECASE]) {
                 $flag = strtolower($flag);
                 $alias = strtolower($alias);
             }
             if (!isset($this->_ruleMap[$flag])) {
                 continue;
             }
             $flag = $this->_ruleMap[$flag];
             if (isset($this->_rules[$alias]) || isset($this->_ruleMap[$alias])) {
                 $o = (strlen($alias) == 1 ? '-' : '--') . $alias;
                 #require_once 'Zend/Console/Getopt/Exception.php';
                 throw new Zend_Console_Getopt_Exception(
                     "Option \"$o\" is being defined more than once.");
             }
             $this->_rules[$flag]['alias'][] = $alias;
             $this->_ruleMap[$alias] = $flag;
         }
         return $this;
     }

◆ setArguments()

setArguments ( $argv )

Define full set of command-line arguments. These replace any currently defined.

Parameters

array $argv

Exceptions

Zend_Console_Getopt_Exception When not given an array as parameter

Returns: Zend_Console_Getopt Provides a fluent interface

Definition at line 370 of file Getopt.php.

     {
         if(!is_array($argv)) {
             #require_once 'Zend/Console/Getopt/Exception.php';
             throw new Zend_Console_Getopt_Exception(
                 "Parameter #1 to setArguments should be an array");
         }
         $this->_argv = $argv;
         $this->_parsed = false;
         return $this;
     }

◆ setHelp()

setHelp ( $helpMap )

Define help messages for options.

The parameter $help_map is an associative array mapping option name (short or long) to the help string.

Parameters

array $helpMap

Returns: Zend_Console_Getopt Provides a fluent interface

Definition at line 677 of file Getopt.php.

     {
         foreach ($helpMap as $flag => $help)
         {
             if (!isset($this->_ruleMap[$flag])) {
                 continue;
             }
             $flag = $this->_ruleMap[$flag];
             $this->_rules[$flag]['help'] = $help;
         }
         return $this;
     }

◆ setOption()

setOption	(	$configKey,
		$configValue
	)

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

string	$configKey
string	$configValue

Returns: Zend_Console_Getopt Provides a fluent interface

Definition at line 409 of file Getopt.php.

     {
         if ($configKey !== null) {
             $this->_getoptConfig[$configKey] = $configValue;
         }
         return $this;
     }

◆ setOptions()

setOptions ( $getoptConfig )

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 $getoptConfig

Returns: Zend_Console_Getopt Provides a fluent interface

Definition at line 390 of file Getopt.php.

     {
         if (isset($getoptConfig)) {
             foreach ($getoptConfig as $key => $value) {
                 $this->setOption($key, $value);
             }
         }
         return $this;
     }

◆ toArray()

toArray ( )

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.

Returns: array

Definition at line 474 of file Getopt.php.

     {
         $this->parse();
         $s = array();
         foreach ($this->_options as $flag => $value) {
             $s[] = $flag;
             if ($value !== true) {
                 $s[] = $value;
             }
         }
         return $s;
     }

◆ toJson()

toJson ( )

Return the current set of options and parameters seen in Json format.

Returns: string

See also: Zend_Json

Definition at line 492 of file Getopt.php.

     {
         $this->parse();
         $j = array();
         foreach ($this->_options as $flag => $value) {
             $j['options'][] = array(
                 'option' => array(
                     'flag' => $flag,
                     'parameter' => $value
                 )
             );
         }
 
         #require_once 'Zend/Json.php';
         $json = Zend_Json::encode($j);
 
         return $json;
     }

◆ toString()

toString ( )

Return the current set of options and parameters seen as a string.

Returns: string

Definition at line 455 of file Getopt.php.

     {
         $this->parse();
         $s = array();
         foreach ($this->_options as $flag => $value) {
             $s[] = $flag . '=' . ($value === true ? 'true' : $value);
         }
         return implode(' ', $s);
     }

◆ toXml()

toXml ( )

Return the current set of options and parameters seen in XML format.

Returns: string

Definition at line 519 of file Getopt.php.

     {
         $this->parse();
         $doc = new DomDocument('1.0', 'utf-8');
         $optionsNode = $doc->createElement('options');
         $doc->appendChild($optionsNode);
         foreach ($this->_options as $flag => $value) {
             $optionNode = $doc->createElement('option');
             $optionNode->setAttribute('flag', utf8_encode($flag));
             if ($value !== true) {
                 $optionNode->setAttribute('parameter', utf8_encode($value));
             }
             $optionsNode->appendChild($optionNode);
         }
         $xml = $doc->saveXML();
         return $xml;
     }

Field Documentation

◆ $_argv

$_argv = array()

protected

Definition at line 180 of file Getopt.php.

◆ $_getoptConfig

$_getoptConfig

protected

Initial value:

= array(
        self::CONFIG_RULEMODE   => self::MODE_ZEND,
        self::CONFIG_DASHDASH   => true,
        self::CONFIG_IGNORECASE => false,
        self::CONFIG_PARSEALL   => true,
    )

Defaults for getopt configuration are: ruleMode is 'zend' format, dashDash (–) token is enabled, ignoreCase is not enabled, parseAll is enabled.

Definition at line 168 of file Getopt.php.

◆ $_options

$_options = array()

protected

Definition at line 209 of file Getopt.php.

◆ $_parsed

$_parsed = false

protected

Definition at line 223 of file Getopt.php.

◆ $_progname

$_progname = ''

protected

Definition at line 187 of file Getopt.php.

◆ $_remainingArgs

$_remainingArgs = array()

protected

Definition at line 216 of file Getopt.php.

◆ $_ruleMap

$_ruleMap = array()

protected

Definition at line 201 of file Getopt.php.

◆ $_rules

$_rules = array()

protected

Definition at line 194 of file Getopt.php.

◆ CONFIG_DASHDASH

const CONFIG_DASHDASH = 'dashDash'

Definition at line 157 of file Getopt.php.

◆ CONFIG_IGNORECASE

const CONFIG_IGNORECASE = 'ignoreCase'

Definition at line 158 of file Getopt.php.

◆ CONFIG_PARSEALL

const CONFIG_PARSEALL = 'parseAll'

Definition at line 159 of file Getopt.php.

◆ CONFIG_RULEMODE

const CONFIG_RULEMODE = 'ruleMode'

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.

Definition at line 156 of file Getopt.php.

◆ MODE_GNU

const MODE_GNU = 'gnu'

Definition at line 136 of file Getopt.php.

◆ MODE_ZEND

const MODE_ZEND = 'zend'

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.

Definition at line 135 of file Getopt.php.

◆ PARAM_OPTIONAL

const PARAM_OPTIONAL = '-'

Definition at line 143 of file Getopt.php.

◆ PARAM_REQUIRED

const PARAM_REQUIRED = '='

Constant tokens for various symbols used in the mode_zend rule format.

Definition at line 142 of file Getopt.php.

◆ TYPE_INTEGER

const TYPE_INTEGER = 'i'

Definition at line 146 of file Getopt.php.

◆ TYPE_STRING

const TYPE_STRING = 's'

Definition at line 144 of file Getopt.php.

◆ TYPE_WORD

const TYPE_WORD = 'w'

Definition at line 145 of file Getopt.php.

The documentation for this class was generated from the following file:

vendor/magento/zendframework1/library/Zend/Console/Getopt.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __get()

◆ __isset()

◆ __set()

◆ __toString()

◆ __unset()

◆ _addRulesModeGnu()

◆ _addRulesModeZend()

◆ _checkParameterType()

◆ _parseLongOption()

◆ _parseShortOptionCluster()

◆ _parseSingleOption()

◆ addArguments()

◆ addRules()

◆ checkRequiredArguments()

◆ getOption()

◆ getOptions()

◆ getRemainingArgs()

◆ getUsageMessage()

◆ parse()

◆ setAliases()

◆ setArguments()

◆ setHelp()

◆ setOption()

◆ setOptions()

◆ toArray()

◆ toJson()

◆ toString()

◆ toXml()

Field Documentation

◆ $_argv

◆ $_getoptConfig

◆ $_options

◆ $_parsed

◆ $_progname

◆ $_remainingArgs

◆ $_ruleMap

◆ $_rules

◆ CONFIG_DASHDASH

◆ CONFIG_IGNORECASE

◆ CONFIG_PARSEALL

◆ CONFIG_RULEMODE

◆ MODE_GNU

◆ MODE_ZEND

◆ PARAM_OPTIONAL

◆ PARAM_REQUIRED

◆ TYPE_INTEGER

◆ TYPE_STRING

◆ TYPE_WORD