如何取得PHP命令列參數

本篇文章為大家介紹一下取得PHP命令列參數的方法。有一定的參考價值，有需要的朋友可以參考一下，希望對大家有幫助。

如何取得PHP命令列參數

使用 PHP 開發的同學多少都會接觸過 CLI 命令列。常常會有一些定時任務或一些腳本直接使用命令列處理會更加的方便，有些時候我們會需要像網頁的 GET 、 POST 一樣為這些命令列腳本提供參數。例如在針對某些日期做統計的腳本，就需要傳遞一個日期給它，這樣我們就統計指定日期的一些資料。這類需求應該非常常見，那麼，我們都是如何來接收這些命令列的參數的呢？今天，就來介紹一下這方面的內容。

$argv 得到所有空格分隔的參數列表

這個變數估計是大家用得比較多的一個接參變數了。它是 PHP 為我們準備的固定變量，目的就是要取得傳遞給腳本的參數數組。

print_r($argv);
// php 如何获取PHP命令行参数.php --a=1 -b=2 -c=3 -d=4 --e=5 ccc ddd 
// Array
// (
//     [0] => 如何获取PHP命令行参数.php
//     [1] => --a=1
//     [2] => -b=2
//     [3] => -c=3
//     [4] => -d=4
//     [5] => --e=5
//     [6] => ccc
//     [7] => ddd
// )

這個陣列是以參數間隔的空格分隔的。第1個元素是目前運行的腳本檔名，也就是說，不管有沒有參數，這個變數一定會有一個 $argv[0] 表示的是目前的腳本檔名。

在日常的開發需求中，其實使用這個變數就已經夠用了。但這明顯不會是我們今天的主題，大家注意到上面的程式碼中我們有很多參數是-x=xxx 的形式，這種形式的參數是不是和Linux 的命令選項非常像，沒錯，這就是我們今天要重點介紹的：從命令列參數清單中取得選項。

getopt() 從命令列參數清單中取得選項

其實就是這樣一個簡單的函數，我們就可以像 Linux 的命令選項一樣取得指定的命令值。而且不是像 $argv 按空格進行分隔，命令選項函數會將這些命令選項封裝成數組，組成以選項名為鍵，以等號後面的內容為值的數組，更加方便我們的使用。

// php 如何获取PHP命令行参数.php --a=1 -b=2 -c=3 -d=4 --e=5 ccc ddd 
print_r(getopt('a:b:c:d:e:f:'));
// Array
// (
//     [b] => 2
//     [c] => 3
//     [d] => 4
// )

是不是很神奇，而且非常直覺吧，我們直接就拿到了 b 、 c 、d 的內容並且是格式非常清晰的鍵值數組形式。有同學要問了，a 和 e 呢？還有後面的 ccc 、 ddd 呢？

首先要說明的是，ccc 和ddd 不是標準的選項參數，也就是說，這個函數接收的內容是以- 開頭的選項，所以ccc 和ddd 不會在這裡輸出，並且需要注意的是，非選項參數會中斷選項參數的獲取，在ccc 之後如果繼續添加- 開頭的選項也是無法獲取到的，這個我們後面還會看到。而 -- 開頭的選項參數呢？我們直接看下面的長選項功能。

長選項

// php 如何获取PHP命令行参数.php --a=1 -b=2 -c=3 -d=4 --e=5 ccc ddd 
print_r(getopt('', ['a:','b:','c:','d:','e:','f:']));
// Array
// (
//     [a] => 1
//     [e] => 5
// )

沒錯，getopt() 函數的第二個參數就是定義這種-- 開頭的長選項的，而且需要注意的是，第一個參數是字串類型，第二個長選項參數是陣列類型的。那我們把它們結合起來，就當然可以取得到全部的參數資訊啦！

// php 如何获取PHP命令行参数.php --a=1 -b=2 -c=3 -d=4 --e=5 ccc ddd 
print_r(getopt('a:b:c:d:e:f:', ['a:','b:','c:','d:','e:','f:']));
// Array
// (
//     [a] => 1
//     [b] => 2
//     [c] => 3
//     [d] => 4
//     [e] => 5
// )

OK，參數選項取得沒問題了吧，細心的同學一定又發現了一個問題，這個 getopt() 函數的參數中定義的選項名稱後面為啥都要加個冒號？這就牽涉到我們的冒號規則了，請直接往下看。

冒號規則

getopt() 的前兩個參數都支援一套關於選項取得的規則：

• 單獨的字元（不接受值）

• 後面跟著冒號的字元（此選項需要值）

• #後面跟隨兩個冒號的字元（此選項的值可選）

我們還是直接透過程式碼來看一下。

// 一
// php 如何获取PHP命令行参数.php --a=1 -b=2 -c=3 -d=4 --e=5 ccc ddd 
print_r(getopt('abcdef'));
// Array
// (
//     [b] => 
//     [c] => 
//     [d] => 
// )

// 二
// php 如何获取PHP命令行参数.php -f
print_r(getopt('f::'));
// Array
// (
//     [f] => 
// )
print_r(getopt('f:'));
// Array
// (
// )

// 三
// php 如何获取PHP命令行参数.php -f 22
print_r(getopt('f::'));
// Array
// (
//     [f] => 
// )
print_r(getopt('f:'));
// Array
// (
//     [f] => 22
// )

// 四
// php 如何获取PHP命令行参数.php -f=22
print_r(getopt('f::'));
// Array
// (
//     [f] => 22
// )
print_r(getopt('f:'));
// Array
// (
//     [f] => 22
// )

這一段比較長，我們一塊一塊來看。首先是不帶冒號的 abcdef 寫法，傳回的陣列中都包含鍵，但沒有值，對應上面的規則就是不接受這些參數選項的值，你傳了這些參數選項也是只有鍵名而內容是空的。

第二段是定義了一個參數，但是不給值，這時，雙冒號 :: 會有鍵名，而單冒號 : 則什麼都沒有。

第三段是空格形式的選項值，雙冒號 :: 有鍵名但沒有值，單冒號 : 鍵值正常。

第四段是等號 = 形式的選項值，單雙冒號都正常接收到鍵值。

選項參數中斷

上文中我們提到參數中斷的問題，就是在選項參數之後如果有一個非選項參數的參數出現，getopt() 就無法再取得到這個非選項參數後面的所有內容了。

// php 如何获取PHP命令行参数.php -f=22 aa -b=33
// 选项的解析会终止于找到的第一个非选项，之后的任何东西都会被丢弃。
// Array
// (
//     [f] => 22
// )

透過這個測驗可以清楚的看出後面的 b 選項無法取得。這時，如果我們想知道選項參數在什麼地方或因為哪個參數而中斷的話，就可以使用 getopt() 函數的第三個參數了。

// php 如何获取PHP命令行参数.php -f=22 aa -b=33
$optind = null;
getopt('f:b:', [], $optind);
echo $optind, PHP_EOL; // 返回中断位置的索引值，2
echo $argv[$optind], PHP_EOL; // 等同于 $argv 的索引顺序，aa

注释已经写得很清晰了，第三个参数会回调一个参数选项中断位置的索引，并且这个索引是和 $argv 的索引顺序位置一致的。

总结

说实话，在没看文档前真的只知道有一个 $argv 变量可以用来获取命令行脚本的参数，通过这次学习才发现原来还有一个这么强大的选项参数函数。学习的过程非常简单，如何运用到真实的项目中才是关键所在，加油学习，努力实践吧！

测试代码：

https://github.com/zhangyue0503/dev-blog/blob/master/php/202006/source/%E5%A6%82%E4%BD%95%E8%8E%B7%E5%8F%96PHP%E5%91%BD%E4%BB%A4%E8%A1%8C%E5%8F%82%E6%95%B0.php

推荐学习：php视频教程

以上是如何取得PHP命令列參數的詳細內容。更多資訊請關注PHP中文網其他相關文章！