@@ -38,6 +38,8 @@ Generic PHP command line flags parse library
38
38
composer require toolkit/pflag
39
39
```
40
40
41
+ -----------
42
+
41
43
## Flags Usage
42
44
43
45
Flags - is an cli flags(options&argument) parser and manager.
@@ -62,6 +64,8 @@ $fs->setScriptFile($scriptFile);
62
64
$fs->setSettings([
63
65
'descNlOnOptLen' => 26
64
66
]);
67
+
68
+ // ...
65
69
```
66
70
67
71
### Define options
@@ -109,13 +113,16 @@ use Toolkit\PFlag\FlagType;
109
113
// add arguments
110
114
// - quick add
111
115
$fs->addArg('strArg1', 'the is string arg and is required', 'string', true);
116
+
112
117
// - use string rule
113
118
$fs->addArgByRule('intArg2', 'int;this is a int arg and with default value;no;89');
119
+
114
120
// - use Argument object
115
121
$arg = Argument::new('arrArg');
116
122
// OR $arg->setType(FlagType::ARRAY);
117
123
$arg->setType(FlagType::STRINGS);
118
124
$arg->setDesc("this is an array arg,\n allow multi value,\n must define at last");
125
+
119
126
$fs->addArgument($arg);
120
127
```
121
128
@@ -176,24 +183,12 @@ array(3) {
176
183
}
177
184
```
178
185
186
+ -----------
187
+
179
188
## SFlags Usage
180
189
181
190
SFlags - is an simple flags(options&argument) parser and manager.
182
191
183
- > ` SFlags ` only support add option/argument by rule string or define array.
184
-
185
- ### Methods
186
-
187
- Options:
188
-
189
- - ` setOptRules(array $rules) `
190
- - ` addOptRule(string $name, string|array $rule) `
191
-
192
- Arguments:
193
-
194
- - ` setArgRules(array $rules) `
195
- - ` addArgRule(string $name, string|array $rule) `
196
-
197
192
### Examples
198
193
199
194
``` php
@@ -300,6 +295,8 @@ array(2) {
300
295
$ php example/sflags-demo.php --help
301
296
```
302
297
298
+ -----------
299
+
303
300
## Get Value
304
301
305
302
** Options**
@@ -321,6 +318,8 @@ $arrArg = $fs->getArg(1); // array{"arr0", "arr1"}
321
318
$arrArg = $fs->getArg('arrArg'); // array{"arr0", "arr1"}
322
319
```
323
320
321
+ -----------
322
+
324
323
## Flag Rule
325
324
326
325
The options/arguments rules
@@ -374,6 +373,8 @@ public const DEFINE_ITEM = [
374
373
];
375
374
```
376
375
376
+ -----------
377
+
377
378
## Costom settings
378
379
379
380
### Settings for parse
@@ -466,6 +467,8 @@ $fs->setHelpRenderer(function (\Toolkit\PFlag\FlagsParser $fs) {
466
467
});
467
468
```
468
469
470
+ -----------
471
+
469
472
## Unit tests
470
473
471
474
``` bash
@@ -478,6 +481,14 @@ test with coverage:
478
481
phpdbg -qrr $( which phpunit) --coverage-text
479
482
```
480
483
484
+ ## Project use
485
+
486
+ Check out these projects, which use https://github.com/php-toolkit/pflag :
487
+
488
+ - [ inhere/console] ( https://github.com/inhere/console ) Full-featured php command line application library.
489
+ - [ kite] ( https://github.com/inhere/kite ) Kite is a tool for help development.
490
+ - More, please see [ Packagist] ( https://packagist.org/packages/toolkit/pflag )
491
+
481
492
## License
482
493
483
494
[ MIT] ( LICENSE )
0 commit comments