PHP8 getopt — 從命令行參數(shù)列表中獲取選項

2023-09-16 11:13 更新

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

getopt — 從命令行參數(shù)列表中獲取選項

說明

getopt(string $short_options, array $long_options = [], int &$rest_index = null): array|false

解析傳入腳本的選項。

參數(shù)

short_options
該字符串中的每個字符會被當做選項字符，匹配傳入腳本的選項以單個連字符 (-) 開頭。 比如，一個選項字符串 "x" 識別了一個選項 -x。 只允許 a-z、A-Z 和 0-9。
long_options
選項數(shù)組。此數(shù)組中的每個元素會被作為選項字符串，匹配了以兩個連字符 (--) 傳入到腳本的選項。 例如，長選項元素 "opt" 識別了一個選項 --opt。
rest_index
如果傳遞了 rest_index 參數(shù)，那么參數(shù)解析停止時的索引，將被賦值給此變量。

short_options 可能包含了以下元素：

  • 單獨的字符（不接受值）
  • 后面跟隨冒號的字符（此選項需要值）
  • 后面跟隨兩個冒號的字符（此選項的值可選）

選項的值是字符串后的第一個參數(shù)。如果需要一個值，它不介意值之前是否有前置的空格，參見以下內(nèi)容。

注意: 選項的值不接受空格（" "）作為分隔符。

long_options 數(shù)組可能包含了以下元素：

  • 字符串（參數(shù)不接受任何值）
  • 后面跟隨冒號的字符串（此選項需要值）
  • 后面跟隨兩個冒號的字符串（此選項的值可選）
注意:short_options 和 long_options 的格式幾乎是一樣的，唯一的不同之處是 long_options 需要是選項的數(shù)組（每個元素為一個選項），而 short_options 需要一個字符串（每個字符是個選項）。

返回值

此函數(shù)會返回選項/參數(shù)對， 或者在失敗時返回 false。

注意:選項的解析會終止于找到的第一個非選項，之后的任何東西都會被丟棄。

更新日志

版本 說明
7.1.0 添加 rest_index 參數(shù)。

示例

示例 #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"
}

參見

  • $argv


以上內(nèi)容是否對您有幫助：
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號