PHPコマンドラインオプション解析ライブラリ（pflag）についてご存知ですか？

                                                                                                               

php-toolkit/pflag は、PHP で書かれた一般的なコマンド ライン フラグ (オプションとパラメーター) 解析ライブラリです。

Github リポジトリ: php-toolkit/pflag(https://github.com/php-toolkit/pflag)

関数の説明

• 共通のコマンド ライン オプションとパラメーター パーサー
• 値のデータ型 (int、string、bool、array) の設定をサポートし、入力値は自動的にフォーマットされます
• オプション/パラメーターのデフォルト値の設定のサポート
• 1 つのオプションに対する複数の短縮名の設定のサポート
• 環境変数からのフラグ値の読み取りのサポート
• サポート 必要に応じてオプション/パラメータを設定します (required)
• 入力値をチェックするバリデータの設定をサポートします
• 美しいヘルプ情報の自動レンダリングをサポートします。

コマンド ライン オプション:

• - または -- で始まるオプション、および最初の文字は文字
• である必要があります。-- で始まるものは長いオプションです。例: --long --long value
• - で始まるものは短いオプションです -s -a value
• 配列オプションの定義をサポートします
  • 例: -- tag php --tag go は $tag = [php, go]

コマンド ライン パラメーター## を取得します。 # :

#オプションを満たさないものはすべてパラメータとして認識されます

• 名前付きパラメータのバインドをサポート
• 配列パラメータの定義をサポート

インストール

composer インストール

composer require toolkit/pflag

---

フラグは フラグを使用します - ですコマンド ライン フラグ (オプションと引数) パーサーとマネージャー。

サンプル コードについては、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

出力:

例の実行:

$ 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"
  }}

---

入力値の取得

フラグ値の取得は非常に簡単です。メソッドは getOpt(string $name)

getArg($nameOrIndex) です。 ) つまり、はいです。ヒント: 入力値は、定義されたデータ型によって自動的にフォーマットされます

オプション データ

$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 ;必須;default;shorts

).
• 配列ルールは SFlags::DEFINE_ITEM に従って設定されます。サポートされる型定数については、FlagType:: **
を参照してください。
• <pre class="brush:php;toolbar:false">use Toolkit\PFlag\FlagType;$rules = [      // v: 只有值，作为名称并使用默认类型 FlagType::STRING      // k-v: 键是名称，值可以是字符串|数组      'long,s',      // name =&gt; rule      'long,a,b' =&gt; 'int;an int option', // long is option name, a and b is shorts.      'f'      =&gt; FlagType::BOOL,      'str1'   =&gt; ['type' =&gt; 'int', 'desc' =&gt; 'an string option'],      'tags'   =&gt; 'array; an array option', // can also: ints, strings      'name'   =&gt; 'type;the description message;required;default', // with desc, default, required]</pre>
オプションについて
オプションでは短い名前を設定できます

shorts

ヒント: たとえば、
• 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;

レンダリング ヘルプ設定

レンダリング ヘルプの一部の設定をサポート

    // -------------------- 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 中国語 Web サイトの他の関連記事を参照してください。