mirror of
https://github.com/kamilwylegala/cakephp2-php8.git
synced 2025-02-07 12:36:25 +00:00
Adding docs about how options work.
This commit is contained in:
parent
3b9921a390
commit
b392f300ba
1 changed files with 17 additions and 6 deletions
|
@ -37,20 +37,31 @@ class ConsoleOptionParser {
|
||||||
protected $_args = array();
|
protected $_args = array();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Construct an OptionParser for a given ARGV array.
|
* Construct an OptionParser so you can define its behavior
|
||||||
*
|
*
|
||||||
* ### Positional arguments
|
* ### Options
|
||||||
*
|
|
||||||
* ### Switches
|
|
||||||
*
|
*
|
||||||
* Named arguments come in two forms, long and short. Long arguments are preceeded
|
* Named arguments come in two forms, long and short. Long arguments are preceeded
|
||||||
* by two - and give a more verbose option name. i.e. `--version`. Short arguments are
|
* by two - and give a more verbose option name. i.e. `--version`. Short arguments are
|
||||||
* preceeded by one - and are only one character long. They usually match with a long option,
|
* preceeded by one - and are only one character long. They usually match with a long option,
|
||||||
* and provide a more terse alternative.
|
* and provide a more terse alternative.
|
||||||
*
|
*
|
||||||
* #### Using switches
|
* #### Using Options
|
||||||
*
|
*
|
||||||
* Switches can be defined with both long and short forms.
|
* Options can be defined with both long and short forms. By using `$parser->addOption()`
|
||||||
|
* you can define new options. The name of the option is used as its long form, and you
|
||||||
|
* can supply an additional short form, with the `short` option.
|
||||||
|
*
|
||||||
|
* Calling options can be done using syntax similar to most *nix command line tools. Long options
|
||||||
|
* cane either include an `=` or leave it out.
|
||||||
|
*
|
||||||
|
* `cake myshell command --connection default --name=something`
|
||||||
|
*
|
||||||
|
* Short options can be defined singally or in groups.
|
||||||
|
*
|
||||||
|
* `cake myshell command -cn`
|
||||||
|
*
|
||||||
|
* ### Positional arguments
|
||||||
*
|
*
|
||||||
* ### Providing Help text
|
* ### Providing Help text
|
||||||
*
|
*
|
||||||
|
|
Loading…
Add table
Reference in a new issue