Class ConsoleOptionParser

Properties summary

• $_args protected
  Cake\Console\ConsoleInputArgument[]
  Positional argument definitions.
• $_command protected
  string
  Command name.
• $_description protected
  string
  Description text - displays before options when help is generated
• $_epilog protected
  string
  Epilog text - displays after options when help is generated
• $_options protected
  Cake\Console\ConsoleInputOption[]
  Option definitions.
• $_shortOptions protected
  array
  Map of short -> long options, generated when using addOption()
• $_subcommandSort protected
  boolean
  Subcommand sorting option
• $_subcommands protected
  Cake\Console\ConsoleInputSubcommand[]
  Subcommands for this Shell.
• $_tokens protected
  array
  Array of args (argv).
• $rootName protected
  string
  Root alias used in help output

Method Summary

• __construct() public

  Construct an OptionParser so you can define its behavior

• _nextToken() protected

  Find the next token in the argv set.

• _optionExists() protected

  Check to see if $name has an option (short/long) defined for it.

• _parseArg() protected

  Parse an argument, and ensure that the argument doesn't exceed the number of arguments and that the argument is a valid choice.

• _parseLongOption() protected

  Parse the value for a long option out of $this->_tokens. Will handle options with an = in them.

• _parseOption() protected

  Parse an option by its name index.

• _parseShortOption() protected

  Parse the value for a short option out of $this->_tokens If the $option is a combination of multiple shortcuts like -otf they will be shifted onto the token stack and parsed individually.

• addArgument() public

  Add a positional argument to the option parser.

• addArguments() public

  Add multiple arguments at once. Take an array of argument definitions. The keys are used as the argument names, and the values as params for the argument.

• addOption() public

  Add an option to the option parser. Options allow you to define optional or required parameters for your console application. Options are defined by the parameters they use.

• addOptions() public

  Add multiple options at once. Takes an array of option definitions. The keys are used as option names, and the values as params for the option.

• addSubcommand() public

  Append a subcommand to the subcommand list. Subcommands are usually methods on your Shell, but can also be used to document Tasks.

• addSubcommands() public

  Add multiple subcommands at once.

• argumentNames() public

  Get the list of argument names.

• arguments() public

  Gets the arguments defined in the parser.

• buildFromArray() public static

  Build a parser from an array. Uses an array like

• command() public

  Gets or sets the command name for shell/task.

• create() public static

  Static factory method for creating new OptionParsers so you can chain methods off of them.

• description() public

  Get or set the description text for shell/task.

• enableSubcommandSort() public

  Enables sorting of subcommands

• epilog() public

  Gets or sets an epilog to the parser. The epilog is added to the end of the options and arguments listing when help is generated.

• findClosestItem() protected

  Tries to guess the item name the user originally wanted using the some regex pattern and the levenshtein algorithm.

• getCommand() public

  Gets the command name for shell/task.

• getCommandError() protected

  Get the message output in the console stating that the command can not be found and tries to guess what the user wanted to say. Output a list of available subcommands as well.

• getDescription() public

  Gets the description text for shell/task.

• getEpilog() public

  Gets the epilog.

• getOptionError() protected

  Get the message output in the console stating that the option can not be found and tries to guess what the user wanted to say. Output a list of available options as well.

• getShortOptionError() protected

  Get the message output in the console stating that the short option can not be found. Output a list of available short options and what option they refer to as well.

• help() public

  Gets formatted help for this parser object.

• isSubcommandSortEnabled() public

  Checks whether or not sorting is enabled for subcommands.

• merge() public

  Get or set the command name for shell/task.

• options() public

  Get the defined options in the parser.

• parse() public

  Parse the argv array into a set of params and args. If $command is not null and $command is equal to a subcommand that has a parser, that parser will be used to parse the $argv

• removeOption() public

  Remove an option from the option parser.

• removeSubcommand() public

  Remove a subcommand from the option parser.

• setCommand() public

  Sets the command name for shell/task.

• setDescription() public

  Sets the description text for shell/task.

• setEpilog() public

  Sets an epilog to the parser. The epilog is added to the end of the options and arguments listing when help is generated.

• setHelpAlias() public

  Set the alias used in the HelpFormatter

• setRootName() public

  Set the root name used in the HelpFormatter

• subcommands() public

  Get the array of defined subcommands

• toArray() public

  Returns an array representation of this parser.

Method Detail

$spec = [
     'description' => 'text',
     'epilog' => 'text',
     'arguments' => [
         // list of arguments compatible with addArguments.
     ],
     'options' => [
         // list of options compatible with addOptions
     ],
     'subcommands' => [
         // list of subcommands to add.
     ]
];

Properties detail

[]

''

[]

[]

true

[]

[]

'cake'