php-toolkit/pflag는 PHP로 작성된 일반 명령줄 플래그(옵션 및 매개변수) 구문 분석 라이브러리입니다. php-toolkit/pflag 是一个PHP编写的，通用的命令行标志(选项和参数)解析库。
Github 仓库: php-toolkit/pflag(https://github.com/php-toolkit/pflag)
int,string,bool,array)，将自动格式化输入值required)命令行选项:
- 或者 -- 开头的，且首字符必须是字母-- 开头的为长选项. eg: --long --long value
- 开头的为短选项 -s -a value
--tag php --tag go 将会得到 $tag = [php, go]
命令行参数:
composer 安装
composer require toolkit/pflag
Flags - 是一个命令行标志（选项和参数）解析器和管理器。
示例代码请参见 example/이 PHP 명령줄 옵션 구문 분석 라이브러리(pflag)에 대해 알고 계십니까?.php
创建和初始化解析器
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);最后调用 parse() 解析命令行输入数据
// ...if (!$fs->parse($flags)) {
// on render help
return;}vdump($fs->getOpts(), $fs->getArgs());显示帮助
当输入 -h 或 --help 会自动渲染帮助信息。
$ php example/이 PHP 명령줄 옵션 구문 분석 라이브러리(pflag)에 대해 알고 계십니까?.php --help
Output:
%EC%97%90%20%EB%8C%80%ED%95%B4%20%EC%95%8C%EA%B3%A0%20%EA%B3%84%EC%8B%AD%EB%8B%88%EA%B9%8C?.png?raw=true)
运行示例:
$ php example/이 PHP 명령줄 옵션 구문 분석 라이브러리(pflag)에 대해 알고 계십니까?.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视频教程】
; 分割每个部分 (完整规则：type;desc;required;default;shorts).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
Github 저장소: php-toolkit/pflag(https://github.com/php-toolkit/pflag)
int, string, bool, array) 지원- 또는 --로 시작하는 옵션, 그리고 첫 번째 문자는 문자여야 합니다.--로 시작하는 문자는 긴 옵션입니다. 예: --long --long value
-로 시작하는 것은 짧은 옵션 -s -a value
--tag php --tag go는 $tag = [php, go]를 얻습니다.composer 설치
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];
🎜샘플 코드는 example/이 PHP 명령줄 옵션 구문 분석 라이브러리(pflag)에 대해 알고 계십니까?.php를 참조하세요🎜🎜🎜🎜파서 만들기🎜🎜파서 만들기 및 초기화🎜
// -------------------- 选项解析设置 -------------------- /** * 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;
// -------------------- 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});parse()를 호출하여 명령줄 입력 데이터를 구문 분석합니다.🎜phpunit --debug
-h 또는 --help를 입력하면 자동으로 도움말 정보가 렌더링됩니다. 🎜phpdbg -qrr $(which phpunit) --coverage-text
🎜🎜예제 실행:🎜rrreee🎜출력 결과:🎜rrreee🎜🎜🎜🎜입력 값 가져오기🎜🎜플래그 값 가져오기는 매우 간단합니다. getOpt( string $name) getArg($nameOrIndex) 그게 전부입니다.🎜🎜TIP: 입력 값은 정의된 데이터 유형을 통해 자동으로 형식화됩니다🎜🎜옵션 데이터🎜rrreee🎜매개변수 데이터🎜rrreee🎜🎜🎜🎜확장: 규칙 정의🎜🎜옵션 매개변수 규칙. 규칙을 사용하여 옵션이나 매개변수를 빠르게 정의하세요. [권장: PHP 동영상 튜토리얼]🎜
;로 구분합니다(전체 규칙: type;desc;required;default;shorts).SFlags::DEFINE_ITEM에 따라 설정됩니다.FlagType::*
shorts
🎜팁을 설정할 수 있습니다. 예:🎜매개변수의 경우 🎜long, a, b-long은 옵션 이름입니다. 나머지a,b는 짧은 옵션 이름입니다. 🎜
플래그::DEFINE_ITEM:🎜rrreee🎜🎜🎜🎜사용자 정의 설정🎜🎜🎜🎜구문 분석 설정🎜rrreee🎜🎜🎜렌더링 도움말 설정🎜🎜렌더 도움말에 대한 일부 설정 지원 🎜rrreee🎜맞춤형 도움말 메시지 렌더링:🎜$fs->setHelpRenderer(function (\Toolkit\PFlag\FlagsParser $fs) {
// render help messages});phpunit --debug
test with coverage:
phpdbg -qrr $(which phpunit) --coverage-text
Check out these projects, which use github.com/php-toolkit/pflag :
Github 仓库: php-toolkit/pflag(https://github.com/php-toolkit/pflag)
위 내용은 이 PHP 명령줄 옵션 구문 분석 라이브러리(pflag)에 대해 알고 계십니까?의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!
![[웹 프런트엔드] Node.js 빠른 시작](https://img.php.cn/upload/course/000/000/067/662b5d34ba7c0227.png)
