getopt
(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
getopt — 從命令列參數列表中獲取選項
說明
getopt(string
$short_options, array $long_options = [], int &$rest_index = null): array|false解析傳入指令碼的選項。
參數
-
short_options -
該字串中的每個字元會被當做選項字元，匹配傳入指令碼的選項以單個連字元 (
-) 開頭。 比如，一個選項字串"x"識別了一個選項-x。 只允許 a-z、A-Z 和 0-9。 -
long_options -
選項陣列。此陣列中的每個元素會被作為選項字串，匹配了以兩個連字元
(
--) 傳入到指令碼的選項。 例如，長選項元素"opt"識別了一個選項--opt。 -
rest_index -
如果傳遞了
rest_index參數，那麼參數解析停止時的索引，將被賦值給此變數。
short_options 可能包含了以下元素：
- 單獨的字元（不接受值）
- 後面跟隨冒號的字元（此選項需要值）
- 後面跟隨兩個冒號的字元（此選項的值可選）
注意: 選項的值不接受空格（
" "）作為分隔符。
long_options 陣列可能包含了以下元素：
- 字串（參數不接受任何值）
- 後面跟隨冒號的字串（此選項需要值）
- 後面跟隨兩個冒號的字串（此選項的值可選）
注意:
short_options和long_options的格式幾乎是一樣的，唯一的不同之處是long_options需要是選項的陣列（每個元素為一個選項），而short_options需要一個字串（每個字元是個選項）。
返回值
此函式會返回選項/參數對， 或者在失敗時返回 false。
注意:
選項的解析會終止於找到的第一個非選項，之後的任何東西都會被丟棄。
更新日誌
| 版本 | 說明 |
|---|---|
| 7.1.0 |
新增 rest_index 參數。
|
範例
示例 #1 getopt() 例子：基本用法
<?php
// Script example.php
$rest_index = null;
$opts = getopt('a:b:', [], $rest_index);
$pos_args = array_slice($argv, $rest_index);
var_dump($pos_args);
shell> php example.php -fvalue -h
以上例程會輸出：
array(2) {
["f"]=>
string(5) "value"
["h"]=>
bool(false)
}
示例 #2 getopt() 例子：引入長選項
<?php
// Script example.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);
?>
shell> php example.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)
}
示例 #3 getopt() 例子：傳遞同一多個選項
<?php
// Script example.php
$options = getopt("abc");
var_dump($options);
?>
shell> php example.php -aaac
以上例程會輸出：
array(2) {
["a"]=>
array(3) {
[0]=>
bool(false)
[1]=>
bool(false)
[2]=>
bool(false)
}
["c"]=>
bool(false)
}
示例 #4 getopt() 例子：使用 rest_index
<?php
// Script example.php
$optind = null;
$opts = getopt('a:b:', [], $optind);
$pos_args = array_slice($argv, $optind);
var_dump($pos_args);
shell> php example.php -a 1 -b 2 -- test
以上例程會輸出：
array(1) {
[0]=>
string(4) "test"
}