(PHP 4 >= 4.3.0, PHP 5)
getopt — 從命令行參數列表中獲取選項
說明
array getopt ( string$options
[, array $longopts
] )
解析傳入腳本的選項。
參數
options
該字符串中的每個字符會被當做選項字符,匹配傳入腳本的選項以單個連字符(-)開頭。
比如,一個選項字符串 "x" 識別了一個選項 -x。
只允許 a-z、A-Z 和 0-9。
longopts
選項數組。此數組中的每個元素會被作為選項字符串,匹配了以兩個連字符(--)傳入到腳本的選項。
例如,長選項元素 "opt" 識別了一個選項 --opt。
options
可能包含了以下元素:
單獨的字符(不接受值)
后面跟隨冒號的字符(此選項需要值)
后面跟隨兩個冒號的字符(此選項的值可選)
選項的值是字符串后的第一個參數。它不介意值之前是否有空格。
Note: 選項的值不接受空格(" ")作為分隔符。
Note:
options
和 longopts
的格式幾乎是一樣的,唯一的不同之處是 longopts
需要是選項的數組(每個元素為一個選項),而 options
需要一個字符串(每個字符是個選項)。
返回值
此函數會返回選項/參數對,失敗時返回 FALSE
。
Note:
選項的解析會終止于找到的第一個非選項,之后的任何東西都會被丟棄。
更新日志
版本
說明
5.3.0
支持 "=" 作為 參數和值的分隔符。
5.3.0
增加了可選值的支持(用"::"指定)。
5.3.0
參數 longopts
在所有系統平臺上均可用。
5.3.0
此函數不再依賴于操作系統,現在也能夠在 Windows 上運行。
范例
Example #1 getopt() 例子
<?php
$options = getopt("f:hp:");
var_dump($options);
?>
通過 php script.php -fvalue -h 運行以上腳本會輸出:
array(2) { ["f"]=> string(5) "value" ["h"]=> bool(false) }
Example #2 getopt() 例子#2
<?php
$shortopts = "";
$shortopts .= "f:"; // Required value
$shortopts .= "v::"; // Optional value
$shortopts .= "abc"; // These options do not accept values
$longopts = array(
"required:", // Required value
"optional::", // Optional value
"option", // No value
"opt", // No value
);
$options = getopt($shortopts, $longopts);
var_dump($options);
?>
通過 php script.php -f "value for f" -v -a --required value --optional="optional value" --option 運行以上腳本會輸出:
array(6) { ["f"]=> string(11) "value for f" ["v"]=> bool(false) ["a"]=> bool(false) ["required"]=> string(5) "value" ["optional"]=> string(14) "optional value" ["option"]=> bool(false) }
Example #3 getopt() 例子#3
傳遞同一多個選項
<?php
$options = getopt("abc");
var_dump($options);
?>
使用 php script.php -aaac 運行以上腳本會輸出:
array(2) { ["a"]=> array(3) { [0]=> bool(false) [1]=> bool(false) [2]=> bool(false) } ["c"]=> bool(false) }
參見
$argv