如何理解PHP命令行選項(xiàng)解析庫(kù)pflag

這篇文章主要講解了“如何理解PHP命令行選項(xiàng)解析庫(kù)pflag”，文中的講解內(nèi)容簡(jiǎn)單清晰，易于學(xué)習(xí)與理解，下面請(qǐng)大家跟著小編的思路慢慢深入，一起來(lái)研究和學(xué)習(xí)“如何理解PHP命令行選項(xiàng)解析庫(kù)pflag”吧！

成都創(chuàng)新互聯(lián)主要從事網(wǎng)站建設(shè)、成都網(wǎng)站制作、網(wǎng)頁(yè)設(shè)計(jì)、企業(yè)做網(wǎng)站、公司建網(wǎng)站等業(yè)務(wù)。立足成都服務(wù)尉犁,10余年網(wǎng)站建設(shè)經(jīng)驗(yàn),價(jià)格優(yōu)惠、服務(wù)專業(yè),歡迎來(lái)電咨詢建站服務(wù):18980820575

php-toolkit/pflag 是一個(gè)PHP編寫的，通用的命令行標(biāo)志(選項(xiàng)和參數(shù))解析庫(kù)。

Github 倉(cāng)庫(kù): php-toolkit/pflag(https://github.com/php-toolkit/pflag)

功能說明

通用的命令行選項(xiàng)和參數(shù)解析器
支持設(shè)置值數(shù)據(jù)類型(int,string,bool,array)，將自動(dòng)格式化輸入值
支持為選項(xiàng)/參數(shù)設(shè)置默認(rèn)值
支持為一個(gè)選項(xiàng)設(shè)置多個(gè)短名稱
支持從環(huán)境變量讀取標(biāo)志值
支持設(shè)置選項(xiàng)/參數(shù)為必須的(required)
支持設(shè)置驗(yàn)證器以檢查輸入值
支持自動(dòng)渲染漂亮的幫助信息。

命令行選項(xiàng):

選項(xiàng)以 - 或者 -- 開頭的，且首字符必須是字母
以 -- 開頭的為長(zhǎng)選項(xiàng). eg: --long --long value
以 - 開頭的為短選項(xiàng) -s -a value
支持定義數(shù)組選項(xiàng)

eg: --tag php --tag go 將會(huì)得到 $tag = [php, go]

命令行參數(shù):

不能滿足選項(xiàng)的都認(rèn)作參數(shù)
支持綁定命名參數(shù)
支持定義數(shù)組參數(shù)

安裝

composer 安裝

composer require toolkit/pflag

Flags 使用

Flags - 是一個(gè)命令行標(biāo)志（選項(xiàng)和參數(shù)）解析器和管理器。

示例代碼請(qǐng)參見 example/flags-demo.php

創(chuàng)建解析器

創(chuàng)建和初始化解析器

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();// （可選的）可以添加一些自定義設(shè)置$fs->setScriptFile($scriptFile);/** @see Flags::$settings */$fs->setSettings([
    'descNlOnOptLen' => 26]);// ...

定義選項(xiàng)

定義選項(xiàng) - 定義好支持的選項(xiàng)設(shè)置，解析時(shí)將會(huì)根據(jù)定義來(lái)解析輸入

添加選項(xiàng)定義的示例:

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);// - 使用字符串規(guī)則快速添加選項(xiàng)定義$fs->addOptByRule('name,n', 'string;this is a string option;true');// -- 一次添加多個(gè)選項(xiàng)$fs->addOptsByRules([
    'tag,t' => 'strings;array option, allow set multi times',
    'f'     => 'bool;this is an bool option',]);// - 使用數(shù)組定義/** @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 對(duì)象$opt = Option::new('str1', "this is  string option, \ndesc has multi line, \nhaha...");$opt->setDefault('defVal');$fs->addOption($opt);

定義參數(shù)

定義參數(shù) - 定義好支持的選項(xiàng)設(shè)置，解析時(shí)將會(huì)根據(jù)定義來(lái)解析輸入

添加參數(shù)定義的示例:

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);// - 使用字符串規(guī)則快速添加定義$fs->addArgByRule('intArg2', 'int;this is a int arg and with default value;no;89');// - 使用 Argument 對(duì)象$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);

解析命令行輸入

最后調(diào)用 parse() 解析命令行輸入數(shù)據(jù)

// ...if (!$fs->parse($flags)) {
    // on render help
    return;}vdump($fs->getOpts(), $fs->getArgs());

顯示幫助

當(dāng)輸入 -h 或 --help 會(huì)自動(dòng)渲染幫助信息。

$ php example/flags-demo.php --help

Output:

如何理解PHP命令行選項(xiàng)解析庫(kù)pflag

運(yùn)行示例:

$ php example/flags-demo.php --name inhere --age 99 --tag go -t php -t java -d one -f arg0 80 arr0 arr1

輸出結(jié)果:

# 選項(xiàng)數(shù)據(jù)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)}# 參數(shù)數(shù)據(jù) 
array(3) {
  [0]=> string(4) "arg0"
  [1]=> int(80)
  [2]=> array(2) {
    [0]=> string(4) "arr0"
    [1]=> string(4) "arr1"
  }}

獲取輸入值

獲取flag值很簡(jiǎn)單，使用方法 getOpt(string $name) getArg($nameOrIndex) 即可.

TIP: 將通過定義的數(shù)據(jù)類型自動(dòng)格式化輸入值

選項(xiàng)數(shù)據(jù)

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

參數(shù)數(shù)據(jù)

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

擴(kuò)展：規(guī)則定義

選項(xiàng)參數(shù)規(guī)則。使用規(guī)則可以快速定義一個(gè)選項(xiàng)或參數(shù)。【推薦：PHP視頻教程】

string 字符串規(guī)則以分號(hào) ; 分割每個(gè)部分 (完整規(guī)則：type;desc;required;default;shorts).
array 規(guī)則按 SFlags::DEFINE_ITEM 設(shè)置定義
支持的類型常量請(qǐng)看 FlagType::*

use Toolkit\PFlag\FlagType;$rules = [
     // v: 只有值，作為名稱并使用默認(rèn)類型 FlagType::STRING
     // k-v: 鍵是名稱，值可以是字符串|數(shù)組
     '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]

對(duì)于選項(xiàng)

選項(xiàng)允許設(shè)置短名稱 shorts

TIP: 例如 long,a,b - long 是選項(xiàng)名稱. 剩余的 a,b 都是它的短選項(xiàng)名.

對(duì)于參數(shù)

參數(shù)沒有別名或者短名稱
數(shù)組參數(shù)只允許定義在最后

數(shù)組定義項(xiàng)

常量 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];

自定義設(shè)置

解析設(shè)置

    // -------------------- 選項(xiàng)解析設(shè)置 --------------------

    /**
     * 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;

    // -------------------- 參數(shù)解析設(shè)置 --------------------

    /**
     * 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;

渲染幫助設(shè)置

support some settings for render help

    // -------------------- settings for built-in render help --------------------

    /**
     * 自動(dòng)渲染幫助信息當(dāng)輸入 '-h', '--help' 選項(xiàng)時(shí)
     *
     * @var bool
     */
    protected $autoRenderHelp = true;

    /**
     * 在渲染的幫助信息上顯示數(shù)據(jù)類型
     *
     * if False:
     *
     * -o, --opt    Option desc
     *
     * if True:
     *
     * -o, --opt STRING   Option desc
     *
     * @var bool
     */
    protected $showTypeOnHelp = true;

    /**
     * 將在打印幫助消息之前調(diào)用它
     *
     * @var callable
     */
    private $beforePrintHelp;

自定義幫助消息渲染:

$fs->setHelpRenderer(function (\Toolkit\PFlag\FlagsParser $fs) {
    // render help messages});

單元測(cè)試

phpunit --debug

test with coverage:

phpdbg -qrr $(which phpunit) --coverage-text

使用pflag的項(xiàng)目

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 倉(cāng)庫(kù): php-toolkit/pflag(https://github.com/php-toolkit/pflag)

感謝各位的閱讀，以上就是“如何理解PHP命令行選項(xiàng)解析庫(kù)pflag”的內(nèi)容了，經(jīng)過本文的學(xué)習(xí)后，相信大家對(duì)如何理解PHP命令行選項(xiàng)解析庫(kù)pflag這一問題有了更深刻的體會(huì)，具體使用情況還需要大家實(shí)踐驗(yàn)證。這里是創(chuàng)新互聯(lián)，小編將為大家推送更多相關(guān)知識(shí)點(diǎn)的文章，歡迎關(guān)注！

當(dāng)前標(biāo)題：如何理解PHP命令行選項(xiàng)解析庫(kù)pflag
當(dāng)前鏈接：http://muchs.cn/article48/ihceep.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供靜態(tài)網(wǎng)站、網(wǎng)站建設(shè)、關(guān)鍵詞優(yōu)化、網(wǎng)站策劃、手機(jī)網(wǎng)站建設(shè)、定制網(wǎng)站

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來(lái)源：創(chuàng)新互聯(lián)

猜你還喜歡下面的內(nèi)容