PHP Flag
Generic PHP command line flags parse library
Features
- Generic CLI options and arguments parser.
- Support set value data type(
int,string,bool,array), will auto format input value. - Support set default value for option/argument.
- Support read flag value from ENV var.
- Support set option/argument is required.
- Support set validator for check input value.
- Support auto generate help message.
Arguments:
- Support binding named arguemnt
- Support define array argument
Options:
- Support long option. eg:
--long--long value - Support short option
-s -a value, allow set multi short names. - Support define array option
- eg:
--tag php --tag gowill gettag: [php, go]
- eg:
Install
composer
composer require toolkit/pflag
Flags Usage
Flags - is an cli flags(options&argument) parser and manager.
example codes please see example/flags-demo.php
Create Flags
use Toolkit\PFlag\Flags;
require dirname(__DIR__) . '/test/bootstrap.php';
$flags = $_SERVER['argv'];
// NOTICE: must shift first element.
$scriptFile = array_shift($flags);
$fs = Flags::new();
// can with some config
$fs->setScriptFile($scriptFile);
/** @see Flags::$settings */
$fs->setSettings([
'descNlOnOptLen' => 26
]);
// ...
Define options
use Toolkit\PFlag\Flag\Option;
use Toolkit\PFlag\FlagType;
use Toolkit\PFlag\Validator\EnumValidator;
// add options
// - quick add
$fs->addOpt('age', 'a', 'this is a int option', FlagType::INT);
// - use string rule
$fs->addOptByRule('name,n', 'string;this is a string option;true');
// -- add multi option at once.
$fs->addOptsByRules([
'tag,t' => 'strings;array option, allow set multi times',
'f' => 'bool;this is an bool option',
]);
// - use array rule
/** @see Flags::DEFINE_ITEM for array rule */
$fs->addOptByRule('name-is-very-lang', [
'type' => FlagType::STRING,
'desc' => 'option name is to lang, desc will print on newline',
'shorts' => ['d','e','f'],
// TIP: add validator limit input value.
'validator' => EnumValidator::new(['one', 'two', 'three']),
]);
// - use Option
$opt = Option::new('str1', "this is string option, \ndesc has multi line, \nhaha...");
$opt->setDefault('defVal');
$fs->addOption($opt);
Define Arguments
use Toolkit\PFlag\Flag\Argument;
use Toolkit\PFlag\FlagType;
// add arguments
// - quick add
$fs->addArg('strArg1', 'the is string arg and is required', 'string', true);
// - use string rule
$fs->addArgByRule('intArg2', 'int;this is a int arg and with default value;no;89');
// - use Argument object
$arg = Argument::new('arrArg');
// OR $arg->setType(FlagType::ARRAY);
$arg->setType(FlagType::STRINGS);
$arg->setDesc("this is an array arg,\n allow multi value,\n must define at last");
$fs->addArgument($arg);
Parse Input
use Toolkit\PFlag\Flags;
use Toolkit\PFlag\FlagType;
// ...
if (!$fs->parse($flags)) {
// on render help
return;
}
vdump($fs->getOpts(), $fs->getArgs());
Show help
$ php example/flags-demo.php --help
Output:
Run demo:
$ php example/flags-demo.php --name inhere --age 99 --tag go -t php -t java -d one -f arg0 80 arr0 arr1
Output:
array(6) {
["str1"]=> string(6) "defVal"
["name"]=> string(6) "inhere"
["age"]=> int(99)
["tag"]=> array(3) {
[0]=> string(2) "go"
[1]=> string(3) "php"
[2]=> string(4) "java"
}
["name-is-very-lang"]=> string(3) "one"
["f"]=> bool(true)
}
array(3) {
[0]=> string(4) "arg0"
[1]=> int(80)
[2]=> array(2) {
[0]=> string(4) "arr0"
[1]=> string(4) "arr1"
}
}
SFlags Usage
SFlags - is an simple flags(options&argument) parser and manager.
Examples
use Toolkit\PFlag\SFlags;
$flags = ['--name', 'inhere', '--age', '99', '--tag', 'php', '-t', 'go', '--tag', 'java', '-f', 'arg0'];
$optRules = [
'name', // string
'age' => 'int;an int option;required', // set required
'tag,t' => FlagType::ARRAY,
'f' => FlagType::BOOL,
];
$argRules = [
// some argument rules
];
$fs->setOptRules($optRules);
$fs->setArgRules($argRules);
$fs->parse($rawFlags);
// or use
// $fs->parseDefined($flags, $optRules, $argRules);
vdump($fs->getOpts(), $fs->getRawArgs());
Output:
array(3) {
["name"]=> string(6) "inhere"
["tag"]=> array(3) {
[0]=> string(3) "php"
[1]=> string(2) "go"
[2]=> string(4) "java"
}
["f"]=> bool(true)
}
array(1) {
[0]=> string(4) "arg0"
}
Parse CLI Input
write the codes to an php file(see example/sflags-demo.php)
use Toolkit\PFlag\SFlags;
$rawFlags = $_SERVER['argv'];
// NOTICE: must shift first element.
$scriptFile = array_shift($rawFlags);
$optRules = [
// some option rules
'name', // string
'age' => 'int;an int option;required', // set required
'tag,t' => FlagType::ARRAY,
'f' => FlagType::BOOL,
];
$argRules = [
// some argument rules
'string',
// set name
'arrArg' => 'array',
];
$fs = SFlags::new();
$fs->parseDefined($rawFlags, $optRules, $argRules);
Run demo:
php example/sflags-demo.php --name inhere --age 99 --tag go -t php -t java -f arg0 arr0 arr1
Output:
array(4) {
["name"]=> string(6) "inhere"
["age"]=> int(99)
["tag"]=> array(3) {
[0]=> string(2) "go"
[1]=> string(3) "php"
[2]=> string(4) "java"
}
["f"]=> bool(true)
}
array(2) {
[0]=> string(4) "arg0"
[1]=> array(2) {
[0]=> string(4) "arr0"
[1]=> string(4) "arr1"
}
}
Show help
$ php example/sflags-demo.php --help
Get Value
Options
$force = $fs->getOpt('f'); // bool(true)
$age = $fs->getOpt('age'); // int(99)
$name = $fs->getOpt('name'); // string(inhere)
$tags = $fs->getOpt('tags'); // array{"php", "go", "java"}
Arguments
$arg0 = $fs->getArg(0); // string(arg0)
// get an array arg
$arrArg = $fs->getArg(1); // array{"arr0", "arr1"}
// get value by name
$arrArg = $fs->getArg('arrArg'); // array{"arr0", "arr1"}
Flag Rule
The options/arguments rules
- string value is rule(
type;desc;required;default;shorts). - array is define item
SFlags::DEFINE_ITEM - supportted type see
FlagType::*
$rules = [
// v: only value, as name and use default type FlagType::STRING
// k-v: key is name, value can be string|array
'long,s',
// name => rule
'long,s' => 'int',
'f' => 'bool',
'long' => FlagType::STRING,
'tags' => 'array', // can also: ints, strings
'name' => 'type;the description message;required;default', // with desc, default, required
]
For options
- option allow set shorts
TIP: name
long,s- first is the option name. remaining is short names.
For arguments
- arguemnt no alias/shorts
- array value only allow defined last
Definition item
The const Flags::DEFINE_ITEM:
public const DEFINE_ITEM = [
'name' => '',
'desc' => '',
'type' => FlagType::STRING,
'helpType' => '', // use for render help
// 'index' => 0, // only for argument
'required' => false,
'default' => null,
'shorts' => [], // only for option
// value validator
'validator' => null,
// 'category' => null
];
Costom settings
Settings for parse
// -------------------- settings for parse option --------------------
/**
* Stop parse option on found first argument.
*
* - Useful for support multi commands. eg: `top --opt ... sub --opt ...`
*
* @var bool
*/
protected $stopOnFistArg = true;
/**
* Skip on found undefined option.
*
* - FALSE will throw FlagException error.
* - TRUE will skip it and collect as raw arg, then continue parse next.
*
* @var bool
*/
protected $skipOnUndefined = false;
// -------------------- settings for parse argument --------------------
/**
* Whether auto bind remaining args after option parsed
*
* @var bool
*/
protected $autoBindArgs = true;
/**
* Strict match args number.
* if exist unbind args, will throw FlagException
*
* @var bool
*/
protected $strictMatchArgs = false;
Setting for render help
support some settings for render help
// -------------------- settings for built-in render help --------------------
/**
* Auto render help on provide '-h', '--help'
*
* @var bool
*/
protected $autoRenderHelp = true;
/**
* Show flag data type on render help.
*
* if False:
*
* -o, --opt Option desc
*
* if True:
*
* -o, --opt STRING Option desc
*
* @var bool
*/
protected $showTypeOnHelp = true;
/**
* Will call it on before print help message
*
* @var callable
*/
private $beforePrintHelp;
- custom help message renderer
$fs->setHelpRenderer(function (\Toolkit\PFlag\FlagsParser $fs) {
// render help messages
});
Unit tests
phpunit --debug
test with coverage:
phpdbg -qrr $(which phpunit) --coverage-text
Project use
Check out these projects, which use https://github.com/php-toolkit/pflag :
- inhere/console Full-featured php command line application library.
- kite Kite is a tool for help development.
- More, please see Packagist
4 Sep 8, 2021
1.8k Dec 30, 2022
2 Nov 12, 2021
2 Oct 22, 2021
76 Dec 30, 2022
35 Oct 4, 2022
102 Dec 31, 2022
18 Nov 1, 2019
336 Jan 7, 2023
324 Dec 8, 2022
5 Oct 7, 2022
32 Dec 26, 2022
745 Dec 30, 2022
33 Nov 16, 2022
8 Nov 3, 2022
2k Jan 4, 2023