PHP getopt 信息/选项函数
-
定义和用法
getopt - 从命令行参数列表中获取选项 -
版本支持
PHP4 PHP5 PHP7 支持 支持 支持 7.1.0 添加 optind 参数。
5.3.0 支持 "=" 作为 参数和值的分隔符。
5.3.0 增加了可选值的支持(用"::"指定)。
5.3.0 参数 longopts 在所有系统平台上均可用。
5.3.0 此函数不再依赖于操作系统,现在也能够在 Windows 上运行。
-
语法
getopt( string $options [, array $longopts [, int &$optind ]] )
getopt() 解析传入脚本的选项。 -
参数
参数 必需的 描述 options 是 该字符串中的每个字符会被当做选项字符,匹配传入脚本的选项以单个连字符(-)开头。 比如,一个选项字符串 "x" 识别了一个选项 -x。 只允许 a-z、A-Z 和 0-9。 options 可能包含了以下元素: - 单独的字符(不接受值)
- 后面跟随冒号的字符(此选项需要值)
- 后面跟随两个冒号的字符(此选项的值可选)
选项的值不接受空格(" ")作为分隔符。
options 和 longopts 的格式几乎是一样的,唯一的不同之处是 longopts 需要是选项的数组(每个元素为一个选项),而 options 需要一个字符串(每个字符是个选项)。
longopts 否 选项数组。此数组中的每个元素会被作为选项字符串,匹配了以两个连字符(--)传入到脚本的选项。 例如,长选项元素 "opt" 识别了一个选项 --opt。 optind 否 如果存在optind参数,则参数解析停止的索引将被写入此变量。 -
返回值
此函数会返回选项/参数对, 或者在失败时返回 FALSE。选项的解析会终止于找到的第一个非选项,之后的任何东西都会被丢弃。
-
示例
// Script example.php $options = getopt("f:hp:"); var_dump($options);
CLI 方式运行:shell> php example.php -fvalue -h
输出:array(2) { ["f"]=> string(5) "value" ["h"]=> bool(false) }
-
相关页面
预定义变量$argv