array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'zh', ), 'this' => array ( 0 => 'function.getopt.php', 1 => 'getopt', ), 'up' => array ( 0 => 'ref.info.php', 1 => 'PHP 选项/信息 函数', ), 'prev' => array ( 0 => 'function.getmyuid.php', 1 => 'getmyuid', ), 'next' => array ( 0 => 'function.getrusage.php', 1 => 'getrusage', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'zh', 'path' => 'reference/info/functions/getopt.xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); ?>
(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
getopt — 从命令行参数列表中获取选项
解析传入脚本的选项。
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
需要一个字符串(每个字符是个选项)。
版本 | 说明 |
---|---|
7.1.0 |
添加 rest_index 参数。
|
示例 #1 getopt() 示例:基本用法
<?php
// Script example.php
$options = getopt("f:hp:");
var_dump($options);
?>
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
$rest_index = null;
$opts = getopt('a:b:', [], $rest_index);
$pos_args = array_slice($argv, $rest_index);
var_dump($pos_args);
shell> php example.php -a 1 -b 2 -- test
以上示例会输出:
array(1) { [0]=> string(4) "test" }