你知道這個PHP命令列選項解析庫(pflag)嗎？

#                                                                                

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 值
支援定義陣列選項
• eg:
  • -- tag php --tag go 將會得到$tag = [php, go]

命令列參數 :

不能滿足選項的都認定參數
• 支援綁定命名參數
• 支援定義陣列參數

##安裝

composer 安裝

---

composer require toolkit/pflag

#Flags 使用

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:

執行範例:

$ 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影片教學

】

• 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中文網其他相關文章！