本文主要讲解“如何理解PHP命令行选项解析库pflag”。本文内容简单明了,易学易懂。请跟随边肖的思路,一起学习学习“如何理解PHP命令行选项解析库pflag”。
Php-toolkit/pflag是一个由Php编写的通用命令行标志(选项和参数)解析库。
Github仓库: PHP-toolkit/pflag(https://github.com/PHP-toolkit/pflag)。
00-1010常规命令行选项和参数解析器。
设置值数据类型(int、string、bool、array),输入值会自动格式化。
支持设置选项/参数的默认值。
支持为一个选项设置多个简称。
支持从环境变量中读取标志值。
支持根据需要设置选项/参数。
支持设置验证器来检查输入值。
支持自动呈现漂亮的帮助信息。
命令行选项:
选项以-或-开头,第一个字符必须是字母。
long选项以-eg :-long-long值开始。
短选项-s -a值以-开头。
支持定义数组选项。
Eg: - tag php - tag go将获得$tag=[php,go]。
命令行参数:
任何不能满足选项的东西都被视为参数。
支持绑定命名参数。
支持定义数组参数。
功能说明
composer 安装
composerrtoolkit/pflag
安装
flags-是命令行标志(选项和参数)的解析器和管理器。
有关代码,请参见示例/flags-demo.php。
00-1010创建并初始化分析器。
useToolkit \ PFlag \ Flagsrequired dirname(_ _ DIR _ _)。/test/bootstrap . PHP ';$ flags=$ _ SERVER[' argv '];//notice : mustsshift first element。$ script file=array _ shift($ flags);$ fs=标志:3360 new();//(可选)
可以添加一些自定义设置$fs->setScriptFile($scriptFile);/** @see Flags::$settings */$fs->setSettings([
'descNlOnOptLen' => 26]);// ...
定义选项
定义选项 - 定义好支持的选项设置,解析时将会根据定义来解析输入
添加选项定义的示例:
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);// - 使用字符串规则快速添加选项定义$fs->addOptByRule('name,n', 'string;this is a string option;true');// -- 一次添加多个选项$fs->addOptsByRules([ 'tag,t' => 'strings;array option, allow set multi times', 'f' => 'bool;this is an bool option',]);// - 使用数组定义/** @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']),]);// - 使用 Option 对象$opt = Option::new('str1', "this is string option, \ndesc has multi line, \nhaha...");$opt->setDefault('defVal');$fs->addOption($opt);
定义参数
定义参数 - 定义好支持的选项设置,解析时将会根据定义来解析输入
添加参数定义的示例:
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);// - 使用字符串规则快速添加定义$fs->addArgByRule('intArg2', 'int;this is a int arg and with default value;no;89');// - 使用 Argument 对象$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()
解析命令行输入数据
// ...if (!$fs->parse($flags)) { // on render help return;}vdump($fs->getOpts(), $fs->getArgs());
显示帮助
当输入 -h
或 --help
会自动渲染帮助信息。
$ php example/flags-demo.php --help
Output:
运行示例:
$ php example/flags-demo.php --name inhere --age 99 --tag go -t php -t java -d one -f arg0 80 arr0 arr1
输出结果:
# 选项数据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" }}
获取输入值
获取flag值很简单,使用方法 getOpt(string $name)
getArg($nameOrIndex)
即可.
TIP: 将通过定义的数据类型自动格式化输入值
选项数据
$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"}
参数数据
$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"}
扩展:规则定义
选项参数规则。使用规则可以快速定义一个选项或参数。【推荐:PHP视频教程】
-
string 字符串规则以分号
;
分割每个部分 (完整规则:type;desc;required;default;shorts
). -
array 规则按
SFlags::DEFINE_ITEM
设置定义 -
支持的类型常量请看
FlagType::*
use Toolkit\PFlag\FlagType;$rules = [ // v: 只有值,作为名称并使用默认类型 FlagType::STRING // k-v: 键是名称,值可以是字符串|数组 'long,s', // name => rule 'long,a,b' => 'int;an int option', // long is option name, a and b is shorts. 'f' => FlagType::BOOL, 'str1' => ['type' => 'int', 'desc' => 'an string option'], 'tags' => 'array; an array option', // can also: ints, strings 'name' => 'type;the description message;required;default', // with desc, default, required]
对于选项
-
选项允许设置短名称
shorts
TIP: 例如
long,a,b
-long
是选项名称. 剩余的a,b
都是它的短选项名.
对于参数
-
参数没有别名或者短名称
-
数组参数只允许定义在最后
数组定义项
常量 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];
自定义设置
解析设置
// -------------------- 选项解析设置 -------------------- /** * 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; // -------------------- 参数解析设置 -------------------- /** * 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;
渲染帮助设置
support some settings for render help
// -------------------- settings for built-in render help -------------------- /** * 自动渲染帮助信息当输入 '-h', '--help' 选项时 * * @var bool */ protected $autoRenderHelp = true; /** * 在渲染的帮助信息上显示数据类型 * * if False: * * -o, --opt Option desc * * if True: * * -o, --opt STRING Option desc * * @var bool */ protected $showTypeOnHelp = true; /** * 将在打印帮助消息之前调用它 * * @var callable */ private $beforePrintHelp;
自定义帮助消息渲染:
$fs->setHelpRenderer(function (\Toolkit\PFlag\FlagsParser $fs) { // render help messages});
单元测试
phpunit --debug
test with coverage:
phpdbg -qrr $(which phpunit) --coverage-text
使用pflag的项目
Check out these projects, which use 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
Github 仓库: php-toolkit/pflag(https://github.com/php-toolkit/pflag)
感谢各位的阅读,以上就是“如何理解PHP命令行选项解析库pflag”的内容了,经过本文的学习后,相信大家对如何理解PHP命令行选项解析库pflag这一问题有了更深刻的体会,具体使用情况还需要大家实践验证。这里是,小编将为大家推送更多相关知识点的文章,欢迎关注!
内容来源网络,如有侵权,联系删除,本文地址:https://www.230890.com/zhan/39944.html