php-toolkit/pflag 是一个PHP编写的,通用的命令行标志(选项和参数)解析库。
功能说明
命令行选项:
命令行参数:
安装composer 安装 composer require toolkit/pflag Flags 使用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();// (可选的)可以添加一些自定义设置$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); 解析命令行输入最后调用 // ...if (!$fs->parse($flags)) { // on render help return;}vdump($fs->getOpts(), $fs->getArgs()); 显示帮助 当输入 $ 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值很简单,使用方法
选项数据 $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视频教程】
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] 对于选项
对于参数
数组定义项 常量 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 :
以上就是你知道这个PHP命令行选项解析库(pflag)吗?的详细内容,更多请关注模板之家(www.mb5.com.cn)其它相关文章! |