Element index for package Console_CommandLine
[ a ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ w ]
[ x ]
[ _ ]
top
a
- $action
- in file Option.php, variable Console_CommandLine_Option::$action
The option action, defaults to "StoreString".
- $actions
- 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.
- $add_list_option
- in file Option.php, variable Console_CommandLine_Option::$add_list_option
For options that uses the "choice" property only.
- $add_version_option
- 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.
- $aliases
- in file Command.php, variable Console_CommandLine_Command::$aliases
An array of aliases for the subcommand.
- $args
- in file Result.php, variable Console_CommandLine_Result::$args
The result arguments array.
- $args
- in file CommandLine.php, variable Console_CommandLine::$args
An array of Console_CommandLine_Argument objects.
- $argument_optional
- 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.
- accept
- in file CommandLine.php, method Console_CommandLine::accept()
Method to allow Console_CommandLine to accept either:
- addArgument
- in file CommandLine.php, method Console_CommandLine::addArgument()
Adds an argument to the command line parser and returns it.
- addBuiltinOptions
- in file CommandLine.php, method Console_CommandLine::addBuiltinOptions()
Adds the builtin "Help" and "Version" options if needed.
- addCommand
- in file CommandLine.php, method Console_CommandLine::addCommand()
Adds a sub-command to the command line parser.
- addOption
- in file CommandLine.php, method Console_CommandLine::addOption()
Adds an option to the command line parser and returns it.
- argumentList
- 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.
- ARGUMENT_REQUIRED
- in file Exception.php, class constant Console_CommandLine_Exception::ARGUMENT_REQUIRED
Exception code constants.
- Action.php
- procedural page Action.php
- Argument.php
- procedural page Argument.php
top
c
- $callback
- 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.
- $choices
- in file Argument.php, variable Console_CommandLine_Argument::$choices
An array of possible values for the argument.
- $command
- in file Result.php, variable Console_CommandLine_Result::$command
A result instance for the subcommand.
- $commands
- in file CommandLine.php, variable Console_CommandLine::$commands
An array of Console_CommandLine_Command objects (sub commands).
- $command_name
- in file Result.php, variable Console_CommandLine_Result::$command_name
Name of the command invoked by the user, false if no command invoked.
- columnWrap
- in file Default.php, method Console_CommandLine_Renderer_Default::columnWrap()
Wraps the text passed to the method at the specified width.
- commandList
- 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.
- commandUsageLine
- in file Default.php, method Console_CommandLine_Renderer_Default::commandUsageLine()
Returns the command line usage message for subcommands.
- Console_CommandLine
- in file CommandLine.php, class Console_CommandLine
Main class for parsing command line options and arguments.
- Callback.php
- procedural page Callback.php
- Counter.php
- procedural page Counter.php
- Command.php
- procedural page Command.php
- CustomMessageProvider.php
- procedural page CustomMessageProvider.php
- CommandLine.php
- procedural page CommandLine.php
- Console_CommandLine_Action
- in file Action.php, class Console_CommandLine_Action
Class that represent an option action.
- Console_CommandLine_Action_Callback
- in file Callback.php, class Console_CommandLine_Action_Callback
Class that represent the Callback action.
- Console_CommandLine_Action_Counter
- in file Counter.php, class Console_CommandLine_Action_Counter
Class that represent the Version action.
- Console_CommandLine_Action_Help
- 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.
- Console_CommandLine_Action_StoreArray
- in file StoreArray.php, class Console_CommandLine_Action_StoreArray
Class that represent the StoreArray action.
- Console_CommandLine_Action_StoreFalse
- in file StoreFalse.php, class Console_CommandLine_Action_StoreFalse
Class that represent the StoreFalse action.
- Console_CommandLine_Action_StoreFloat
- in file StoreFloat.php, class Console_CommandLine_Action_StoreFloat
Class that represent the StoreFloat action.
- Console_CommandLine_Action_StoreInt
- in file StoreInt.php, class Console_CommandLine_Action_StoreInt
Class that represent the StoreInt action.
- Console_CommandLine_Action_StoreString
- in file StoreString.php, class Console_CommandLine_Action_StoreString
Class that represent the StoreString action.
- Console_CommandLine_Action_StoreTrue
- in file StoreTrue.php, class Console_CommandLine_Action_StoreTrue
Class that represent the StoreTrue action.
- Console_CommandLine_Action_Version
- 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.
- Console_CommandLine_Argument
- in file Argument.php, class Console_CommandLine_Argument
Class that represent a command line argument.
- Console_CommandLine_Command
- in file Command.php, class Console_CommandLine_Command
Class that represent a command with option and arguments.
- Console_CommandLine_CustomMessageProvider
- in file CustomMessageProvider.php, class Console_CommandLine_CustomMessageProvider
Common interfacefor message providers that allow overriding with custom messages
- 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.
- Console_CommandLine_Option
- in file Option.php, class Console_CommandLine_Option
Class that represent a commandline option.
- Console_CommandLine_Outputter
- in file Outputter.php, class Console_CommandLine_Outputter
Outputters common interface, all outputters must implement this interface.
- Console_CommandLine_Outputter_Default
- in file Default.php, class Console_CommandLine_Outputter_Default
Console_CommandLine default Outputter.
- Console_CommandLine_Renderer
- in file Renderer.php, class Console_CommandLine_Renderer
Renderers common interface, all renderers must implement this interface.
- Console_CommandLine_Renderer_Default
- in file Default.php, class Console_CommandLine_Renderer_Default
Console_CommandLine default renderer.
- Console_CommandLine_Result
- in file Result.php, class Console_CommandLine_Result
A lightweight class to store the result of the command line parsing.
- Console_CommandLine_XmlParser
- in file XmlParser.php, class Console_CommandLine_XmlParser
Parser for command line xml definitions.
top
top
e
- $errors
- in file CommandLine.php, variable Console_CommandLine::$errors
Error messages.
- Element.php
- procedural page Element.php
- Exception.php
- procedural page Exception.php
- ex1.php
- procedural page ex1.php
- ex2.php
- procedural page ex2.php
- ex3.php
- procedural page ex3.php
- ex4.php
- procedural page ex4.php
- ex5.php
- procedural page ex5.php
- error
- in file Renderer.php, method Console_CommandLine_Renderer::error()
Returns a formatted error message.
- error
- in file Default.php, method Console_CommandLine_Renderer_Default::error()
Returns a formatted error message.
- execute
- in file StoreFloat.php, method Console_CommandLine_Action_StoreFloat::execute()
Executes the action with the value entered by the user.
- execute
- in file StoreFalse.php, method Console_CommandLine_Action_StoreFalse::execute()
Executes the action with the value entered by the user.
- execute
- in file StoreInt.php, method Console_CommandLine_Action_StoreInt::execute()
Executes the action with the value entered by the user.
- execute
- in file StoreTrue.php, method Console_CommandLine_Action_StoreTrue::execute()
Executes the action with the value entered by the user.
- execute
- in file StoreArray.php, method Console_CommandLine_Action_StoreArray::execute()
Executes the action with the value entered by the user.
- execute
- in file Version.php, method Console_CommandLine_Action_Version::execute()
Executes the action with the value entered by the user.
- execute
- in file StoreString.php, method Console_CommandLine_Action_StoreString::execute()
Executes the action with the value entered by the user.
- execute
- in file List.php, method Console_CommandLine_Action_List::execute()
Executes the action with the value entered by the user.
- execute
- in file Action.php, method Console_CommandLine_Action::execute()
Executes the action with the value entered by the user.
- execute
- in file Callback.php, method Console_CommandLine_Action_Callback::execute()
Executes the action with the value entered by the user.
- execute
- in file Help.php, method Console_CommandLine_Action_Help::execute()
Executes the action with the value entered by the user.
- execute
- in file Counter.php, method Console_CommandLine_Action_Counter::execute()
Executes the action with the value entered by the user.
- execute
- in file Password.php, method Console_CommandLine_Action_Password::execute()
Executes the action with the value entered by the user.
- expectsArgument
- in file Option.php, method Console_CommandLine_Option::expectsArgument()
Returns true if the option requires one or more argument and false otherwise.
top
f
- $firstPass
- in file StoreArray.php, variable Console_CommandLine_Action_StoreArray::$firstPass
Force a clean result when first called, overriding any defaults assigned.
- $force_options_defaults
- 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).
- format
- in file Action.php, method Console_CommandLine_Action::format()
Allow a value to be pre-formatted prior to being used in a choices test.
- fromXmlFile
- in file CommandLine.php, method Console_CommandLine::fromXmlFile()
Returns a command line parser instance built from an xml file.
- fromXmlString
- in file CommandLine.php, method Console_CommandLine::fromXmlString()
Returns a command line parser instance built from an xml string.
top
top
top
top
top
top
top
o
- $option
- in file Action.php, variable Console_CommandLine_Action::$option
A reference to the option instance.
- $optional
- 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.
- $options
- in file Result.php, variable Console_CommandLine_Result::$options
The result options associative array.
- $options
- in file CommandLine.php, variable Console_CommandLine::$options
An array of Console_CommandLine_Option objects.
- $options_on_different_lines
- in file Default.php, variable Console_CommandLine_Renderer_Default::$options_on_different_lines
Integer that define the max width of the help text.
- $outputter
- in file CommandLine.php, variable Console_CommandLine::$outputter
The command line parser outputter instance.
- Option.php
- procedural page Option.php
- Outputter.php
- procedural page Outputter.php
- optionList
- 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.
- OPTION_UNKNOWN
- in file Exception.php, class constant Console_CommandLine_Exception::OPTION_UNKNOWN
Exception code constants.
- OPTION_VALUE_REQUIRED
- in file Exception.php, class constant Console_CommandLine_Exception::OPTION_VALUE_REQUIRED
Exception code constants.
- OPTION_VALUE_TYPE_ERROR
- in file Exception.php, class constant Console_CommandLine_Exception::OPTION_VALUE_TYPE_ERROR
Exception code constants.
- OPTION_VALUE_UNEXPECTED
- in file Exception.php, class constant Console_CommandLine_Exception::OPTION_VALUE_UNEXPECTED
Exception code constants.
top
top
top
top
top
top
v
- $version
- 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.
- Version.php
- procedural page Version.php
- validate
- in file XmlParser.php, method Console_CommandLine_XmlParser::validate()
Validates the xml definition using Relax NG.
- validate
- in file Option.php, method Console_CommandLine_Option::validate()
Validates the option instance.
- validate
- in file Element.php, method Console_CommandLine_Element::validate()
Validates the element instance and set it's default values.
- validate
- in file Argument.php, method Console_CommandLine_Argument::validate()
Validates the argument instance.
- version
- in file Default.php, method Console_CommandLine_Renderer_Default::version()
Returns the program version string.
- version
- in file Renderer.php, method Console_CommandLine_Renderer::version()
Returns the program version string.
top
top
top
Documentation generated on Mon, 11 Mar 2019 15:51:31 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|