(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
getopt — 從命令行參數列表中獲取選項
$short_options, array $long_options = [], int &$rest_index = null): array|false解析傳入腳本的選項。
short_options-) 開(kāi)頭。
比如，一個(gè)選項字符串 "x" 識別了一個(gè)選項
-x。
只允許 a-z、A-Z 和 0-9。
long_options--) 傳入到腳本的選項。
例如，長(cháng)選項元素 "opt" 識別了一個(gè)選項
--opt。
rest_indexrest_index
參數，那么參數解析停止時(shí)的索引，將被賦值給此變量。
short_options 可能包含了以下元素：
注意: 選項的值不接受空格（
" "）作為分隔符。
long_options 數組可能包含了以下元素：
注意:
short_options和long_options的格式幾乎是一樣的，唯一的不同之處是long_options需要是選項的數組（每個(gè)元素為一個(gè)選項），而short_options需要一個(gè)字符串（每個(gè)字符是個(gè)選項）。
此函數會(huì )返回選項/參數對， 或者在失敗時(shí)返回 false。
注意:
選項的解析會(huì )終止于找到的第一個(gè)非選項，之后的任何東西都會(huì )被丟棄。
| 版本 | 說(shuō)明 |
|---|---|
| 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
以上例程會(huì )輸出：
array(2) {
["f"]=>
string(5) "value"
["h"]=>
bool(false)
}
示例 #2 getopt() 例子：引入長(cháng)選項
<?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
以上例程會(huì )輸出：
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() 例子：傳遞同一多個(gè)選項
<?php
// Script example.php
$options = getopt("abc");
var_dump($options);
?>
shell> php example.php -aaac
以上例程會(huì )輸出：
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
以上例程會(huì )輸出：
array(1) {
[0]=>
string(4) "test"
}