編碼的世界 / 優質文選 / 文明

php cli模式下獲取參數的方法


2021年7月05日
-   

php在cli模式下接收參數有兩種方法
1.使用argv數組 2.使用getopt方法
1.使用argv數組
例如:需要執行一個php,並傳遞三個參數(type=news, is_hot=1, limit=5)
創建test.php
<?php
print_r($argv);
?>

在命令行執行
php test.php news 1 5

輸出:
Array
(
[0] => test.php
[1] => news
[2] => 1
[3] => 5
)

可以看到argv[0]為當前執行的php文件名稱,而argv[1]~argv[3]則是傳遞的參數的值 argv[1]等於type的值 argv[2]等於is_hot的值 argv[3]等於limit的值 這樣可以根據argv數組來獲取傳遞的參數進行後續的處理操作。
缺點: 使用argv數組,可以按順序獲取傳遞的參數。但獲取後,需要做一個對應處理,上例中需要把argv[1]對應type參數,argv[2]對應is_hot參數,argv[3]對應limit參數。而如果在傳遞的過程中,參數順序寫錯,則會導致程序出錯。
例如:
<?php
$param = array();
$param['type'] = $argv[1];
$param['is_hot'] = $argv[2];
$param['limit'] = $argv[3];
print_r($param);
?>

執行
php test.php news 1 5

輸出:
Array
(
[type] => news
[is_hot] => 1
[limit] => 5
)

而傳遞順序不同,獲取到的參數數值會不同,導致後續程序出錯
執行
php test.php 1 5 news

輸出:
Array
(
[type] => 1
[is_hot] => 5
[limit] => news
)

因此在使用argv數組傳遞參數時,需要注意參數傳遞的順序。
2.使用getopt方法
getopt 從命令行參數列表中獲取選項
array getopt ( string $options [, array $longopts ] )

參數: options 該字符串中的每個字符會被當做選項字符,匹配傳入腳本的選項以單個連字符(-)開頭。 比如,一個選項字符串 “x” 識別了一個選項 -x。 只允許 a-z、A-Z 和 0-9。
longopts 選項數組。此數組中的每個元素會被作為選項字符串,匹配了以兩個連字符(–)傳入到腳本的選項。 例如,長選項元素 “opt” 識別了一個選項 –opt。
options 可能包含了以下元素: 單獨的字符(不接受值) 後面跟隨冒號的字符(此選項需要值) 後面跟隨兩個冒號的字符(此選項的值可選) 選項的值是字符串後的第一個參數。它不介意值之前是否有空格。
options 和 longopts 的格式幾乎是一樣的,唯一的不同之處是 longopts 需要是選項的數組(每個元素為一個選項),而 options 需要一個字符串(每個字符是個選項)。 傳值的分隔符可以使用空格或=。 可選項的值不接受空格作為分隔符,只能使用=作為分隔符。
返回值 此函數會返回選項/參數對,失敗時返回 FALSE。 選項的解析會終止於找到的第一個非選項,之後的任何東西都會被丟棄。
1.使用options實例
a,b,c 為需要值 d 為可選值 e 為不接受值
<?php
$param = getopt('a:b:c:d::e');
print_r($param);
?>

執行
php test.php -a 1 -b 2 -c 3 -d=4 -e 5

輸出:
Array
(
[a] => 1
=> 2
[c] => 3
[d] => 4
[e] =>
)

2.使用longopts實例
type,is_hot 為需要值 limit 為可選值 expire 為不接受值
<?php
$longopt = array(
'type:',
'is_hot:',
'limit::',
'expire'
);
$param = getopt('', $longopt);
print_r($param);
?>

執行
php test.php type news is_hot 1 limit=10 expire=100

輸出:
Array
(
[type] => news
[is_hot] => 1
[limit] => 10
[expire] =>
)

3.找到第一非選項,後面忽略實例
<?php
$longopt = array(
'type:',
'is_hot:',
'limit::',
'expire'
);
$param = getopt('', $longopt);
print_r($param);
?>

執行
php test.php type news is_hots 1 limit=10 expire=100

輸出:
Array
(
[type] => news
)

因為is_hots不是選項值(定義的是is_hot),所以從這裏開始之後的參數,都被丟棄。 總結: 使用argv數組傳參數,方法簡單,實現方便。參數的順序不能錯,參數獲取後需要做對應處理。 使用getopt方法,可使用參數名,參數順序可隨意,比較規範。(建議使用)

熱門文章