in file CommandLine.php, variable Console_CommandLine::$actions Array of valid actions for an option, this array will also store user registered actions.
$action_params
in file Option.php, variable Console_CommandLine_Option::$action_params An associative array of additional params to pass to the class corresponding to the action, this array will also be passed to the callback defined for an action of type Callback, Example:
$add_help_option
in file CommandLine.php, variable Console_CommandLine::$add_help_option Boolean that determine if the command line parser should add the help (-h, --help) option automatically.
in file CommandLine.php, variable Console_CommandLine::$add_version_option Boolean that determine if the command line parser should add the version (-v, --version) option automatically.
$args
in file CommandLine.php, variable Console_CommandLine::$args An array of Console_CommandLine_Argument objects.
in file Option.php, variable Console_CommandLine_Option::$argument_optional For options that expect an argument, this property tells the parser if the option argument is optional and can be ommited.
in file Default.php, method Console_CommandLine_Renderer_Default::argumentList() Render the arguments list that will be displayed to the user, you can override this method if you want to change the look of the list.
in file Option.php, variable Console_CommandLine_Option::$callback The callback function (or method) to call for an action of type Callback, this can be any callable supported by the php function call_user_func.
$choices
in file Option.php, variable Console_CommandLine_Option::$choices An array of possible values for the option if this array is not empty and the value passed is not in the array an exception is raised.
in file Default.php, method Console_CommandLine_Renderer_Default::commandList() Render the command list that will be displayed to the user, you can override this method if you want to change the look of the list.
in file Help.php, class Console_CommandLine_Action_Help Class that represent the Help action, a special action that displays the help message, telling the user how to use the program.
Console_CommandLine_Action_List
in file List.php, class Console_CommandLine_Action_List Class that represent the List action, a special action that simply output an array as a list.
Console_CommandLine_Action_Password
in file Password.php, class Console_CommandLine_Action_Password Class that represent the Password action, a special action that allow the user to specify the password on the commandline or to be prompted for entering it.
in file Version.php, class Console_CommandLine_Action_Version Class that represent the Version action, a special action that displays the version string of the program.
in file Command.php, class Console_CommandLine_Command Class that represent a command with option and arguments.
Console_CommandLine_Element
in file Element.php, class Console_CommandLine_Element Class that represent a command line element (an option, or an argument).
Console_CommandLine_Exception
in file Exception.php, class Console_CommandLine_Exception Class for exceptions raised by the Console_CommandLine package.
Console_CommandLine_MessageProvider
in file MessageProvider.php, class Console_CommandLine_MessageProvider Message providers common interface, all message providers must implement this interface.
Console_CommandLine_MessageProvider_Default
in file Default.php, class Console_CommandLine_MessageProvider_Default Lightweight class that manages messages used by Console_CommandLine package, allowing the developper to customize these messages, for example to internationalize a command line frontend.
in file Option.php, method Console_CommandLine_Option::dispatchAction() Formats the value $value according to the action of the option and updates the passed Console_CommandLine_Result object.
in file CommandLine.php, variable Console_CommandLine::$force_options_defaults Boolean that tells the parser to set relevant options default values, according to the option action.
$force_posix
in file CommandLine.php, variable Console_CommandLine::$force_posix Boolean that tells the parser to be POSIX compliant, POSIX demands the following behavior: the first non-option stops option processing.
factory
in file Exception.php, method Console_CommandLine_Exception::factory() Convenience method that builds the exception with the array of params by calling the message provider class.
findOption
in file CommandLine.php, method Console_CommandLine::findOption() Finds the option that matches the given short_name (ex: -v), long_name (ex: --verbose) or name (ex: verbose).
in file CommandLine.php, method Console_CommandLine::getArgcArgv() Tries to return an array containing argc and argv, or trigger an error if it fails to get them.
in file Element.php, variable Console_CommandLine_Element::$help_name The name of variable displayed in the usage message, if no set it defaults to the "name" property.
in file Argument.php, variable Console_CommandLine_Argument::$multiple Setting this to true will tell the parser that the argument expects more than one argument and that argument values should be stored in an array.
in file Argument.php, variable Console_CommandLine_Argument::$optional Setting this to true will tell the parser that the argument is optional and can be ommited.
in file Default.php, method Console_CommandLine_Renderer_Default::optionList() Render the options list that will be displayed to the user, you can override this method if you want to change the look of the list.
in file XmlParser.php, method Console_CommandLine_XmlParser::parse() Parses the given xml definition file and returns a Console_CommandLine instance constructed with the xml data.
parse
in file CommandLine.php, method Console_CommandLine::parse() Parses the command line arguments and returns a Console_CommandLine_Result instance.
parseString
in file XmlParser.php, method Console_CommandLine_XmlParser::parseString() Parses the given xml definition string and returns a Console_CommandLine instance constructed with the xml data.
parseToken
in file CommandLine.php, method Console_CommandLine::parseToken() Parses the command line token and modifies *by reference* the $options and $args arrays.
in file CommandLine.php, variable Console_CommandLine::$version A string that represents the version of the program, if this property is not empty and property add_version_option is not set to false, the command line parser will add a --version option, that will display the property content.