[Zend_Console_Getopt] element index

Package indexes

All elements
a c e g m p s t u z _
_
top
Variable $_argv
Zend_Console_Getopt::$_argv in Getopt.php
Stores the command-line arguments for the calling applicaion.
Variable $_getoptConfig
Zend_Console_Getopt::$_getoptConfig in Getopt.php
Defaults for getopt configuration are: ruleMode is 'zend' format, dashDash (--) token is enabled, ignoreCase is not enabled.
Variable $_options
Zend_Console_Getopt::$_options in Getopt.php
Stores options given by the user in the current invocation of the application, as well as parameters given in options.
Variable $_parsed
Zend_Console_Getopt::$_parsed in Getopt.php
State of the options: parsed or not yet parsed?
Variable $_progname
Zend_Console_Getopt::$_progname in Getopt.php
Stores the name of the calling applicaion.
Variable $_remainingArgs
Zend_Console_Getopt::$_remainingArgs in Getopt.php
Stores the command-line arguments other than options.
Variable $_ruleMap
Zend_Console_Getopt::$_ruleMap in Getopt.php
Stores alternate spellings of legal options.
Variable $_rules
Zend_Console_Getopt::$_rules in Getopt.php
Stores the list of legal options for this application.
Method _addRulesModeGnu
Zend_Console_Getopt::_addRulesModeGnu() in Getopt.php
Define legal options using the gnu-style format.
Method _addRulesModeZend
Zend_Console_Getopt::_addRulesModeZend() in Getopt.php
Define legal options using the Zend-style format.
Method _checkParameterType
Zend_Console_Getopt::_checkParameterType() in Getopt.php
Return true if the parameter is in a valid format for the option $flag.
Method _parseLongOption
Zend_Console_Getopt::_parseLongOption() in Getopt.php
Parse command-line arguments for a single long option.
Method _parseShortOptionCluster
Zend_Console_Getopt::_parseShortOptionCluster() in Getopt.php
Parse command-line arguments for short options.
Method _parseSingleOption
Zend_Console_Getopt::_parseSingleOption() in Getopt.php
Parse command-line arguments for a single option.
Method __construct
Zend_Console_Getopt::__construct() in Getopt.php
The constructor takes one to three parameters.
Method __construct
Zend_Console_Getopt_Exception::__construct() in Exception.php
Method __get
Zend_Console_Getopt::__get() in Getopt.php
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.
Method __isset
Zend_Console_Getopt::__isset() in Getopt.php
Test whether a given option has been seen.
Method __set
Zend_Console_Getopt::__set() in Getopt.php
Set the value for a given option.
Method __toString
Zend_Console_Getopt::__toString() in Getopt.php
Return the current set of options and parameters seen as a string.
Method __unset
Zend_Console_Getopt::__unset() in Getopt.php
Unset an option.
a
top
Method addArguments
Zend_Console_Getopt::addArguments() in Getopt.php
Define additional command-line arguments.
Method addRules
Zend_Console_Getopt::addRules() in Getopt.php
Define additional option rules.
c
top
Class Constant CONFIG_DASHDASH
Zend_Console_Getopt::CONFIG_DASHDASH in Getopt.php
Class Constant CONFIG_IGNORECASE
Zend_Console_Getopt::CONFIG_IGNORECASE in Getopt.php
Class Constant CONFIG_RULEMODE
Zend_Console_Getopt::CONFIG_RULEMODE in Getopt.php
These are constants for optional behavior of this class.
e
top
Page Exception.php
Exception.php in Exception.php
g
top
Page Getopt.php
Getopt.php in Getopt.php
Method getOption
Zend_Console_Getopt::getOption() in Getopt.php
Return the state of the option seen on the command line of the current application invocation.
Method getOptions
Zend_Console_Getopt::getOptions() in Getopt.php
Return a list of options that have been seen in the current argv.
Method getRemainingArgs
Zend_Console_Getopt::getRemainingArgs() in Getopt.php
Return the arguments from the command-line following all options found.
Method getUsageMessage
Zend_Console_Getopt::getUsageMessage() in Getopt.php
Return a useful option reference, formatted for display in an error message.
Method getUsageMessage
Zend_Console_Getopt_Exception::getUsageMessage() in Exception.php
m
top
Class Constant MODE_GNU
Zend_Console_Getopt::MODE_GNU in Getopt.php
Class Constant MODE_ZEND
Zend_Console_Getopt::MODE_ZEND in Getopt.php
The options for a given application can be in multiple formats.
p
top
Class Constant PARAM_OPTIONAL
Zend_Console_Getopt::PARAM_OPTIONAL in Getopt.php
Class Constant PARAM_REQUIRED
Zend_Console_Getopt::PARAM_REQUIRED in Getopt.php
Constant tokens for various symbols used in the mode_zend rule format.
Method parse
Zend_Console_Getopt::parse() in Getopt.php
Parse command-line arguments and find both long and short options.
s
top
Method setAliases
Zend_Console_Getopt::setAliases() in Getopt.php
Define aliases for options.
Method setArguments
Zend_Console_Getopt::setArguments() in Getopt.php
Define full set of command-line arguments.
Method setHelp
Zend_Console_Getopt::setHelp() in Getopt.php
Define help messages for options.
Method setOption
Zend_Console_Getopt::setOption() in Getopt.php
Define one configuration option as a key/value pair.
Method setOptions
Zend_Console_Getopt::setOptions() in Getopt.php
Define multiple configuration options from an associative array.
t
top
Method toArray
Zend_Console_Getopt::toArray() in Getopt.php
Return the current set of options and parameters seen as an array of canonical options and parameters.
Method toJson
Zend_Console_Getopt::toJson() in Getopt.php
Return the current set of options and parameters seen in Json format.
Method toString
Zend_Console_Getopt::toString() in Getopt.php
Return the current set of options and parameters seen as a string.
Method toXml
Zend_Console_Getopt::toXml() in Getopt.php
Return the current set of options and parameters seen in XML format.
Class Constant TYPE_INTEGER
Zend_Console_Getopt::TYPE_INTEGER in Getopt.php
Class Constant TYPE_STRING
Zend_Console_Getopt::TYPE_STRING in Getopt.php
Class Constant TYPE_WORD
Zend_Console_Getopt::TYPE_WORD in Getopt.php
u
top
Variable $usage
Zend_Console_Getopt_Exception::$usage in Exception.php
z
top
Class Zend_Console_Getopt
Zend_Console_Getopt in Getopt.php
Zend_Console_Getopt is a class to parse options for command-line applications.
Class Zend_Console_Getopt_Exception
Zend_Console_Getopt_Exception in Exception.php
a c e g m p s t u z _