-
Notifications
You must be signed in to change notification settings - Fork 105
/
getopt.xml
311 lines (303 loc) · 7.83 KB
/
getopt.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4d02fe98ddc684a0d82a3921ef189a71b98f4f04 Maintainer: daijie Status: ready -->
<refentry xml:id="function.getopt" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>getopt</refname>
<refpurpose>从命令行参数列表中获取选项</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>getopt</methodname>
<methodparam><type>string</type><parameter>short_options</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>long_options</parameter><initializer>[]</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">rest_index</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
解析传入脚本的选项。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>short_options</parameter></term>
<listitem>
<simpara>
该字符串中的每个字符会被当做选项字符,匹配传入脚本的选项以单个连字符 (<literal>-</literal>) 开头。
</simpara>
<simpara>
比如,一个选项字符串 <literal>"x"</literal> 识别了一个选项
<literal>-x</literal>。
</simpara>
<simpara>
只允许 a-z、A-Z 和 0-9。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>long_options</parameter></term>
<listitem>
<simpara>
选项数组。此数组中的每个元素会被作为选项字符串,匹配了以两个连字符
(<literal>--</literal>) 传入到脚本的选项。
</simpara>
<simpara>
例如,长选项元素 <literal>"opt"</literal> 识别了一个选项
<literal>--opt</literal>。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rest_index</parameter></term>
<listitem>
<simpara>
如果传递了 <parameter>rest_index</parameter>
参数,那么参数解析停止时的索引,将被赋值给此变量。
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
<parameter>short_options</parameter> 可能包含了以下元素:
<simplelist>
<member>单独的字符(不接受值)</member>
<member>后面跟随冒号的字符(此选项需要值)</member>
<member>后面跟随两个冒号的字符(此选项的值可选)</member>
</simplelist>
选项的值是字符串后的第一个参数。如果需要一个值,它不介意值之前是否有前置的空格,参见以下内容。
<note>
<simpara>
选项的值不接受空格(<literal>" "</literal>)作为分隔符。
</simpara>
</note>
</para>
<para>
<parameter>long_options</parameter> 数组可能包含了以下元素:
<simplelist>
<member>字符串(参数不接受任何值)</member>
<member>后面跟随冒号的字符串(此选项需要值)</member>
<member>后面跟随两个冒号的字符串(此选项的值可选)</member>
</simplelist>
</para>
<note>
<para>
<parameter>short_options</parameter> 和 <parameter>long_options</parameter> 的格式几乎是一样的,唯一的不同之处是
<parameter>long_options</parameter> 需要是选项的数组(每个元素为一个选项),而 <parameter>short_options</parameter>
需要一个字符串(每个字符是个选项)。
</para>
</note>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
此函数会返回选项/参数对,&return.falseforfailure;。
</para>
<note>
<para>
选项的解析会终止于找到的第一个非选项,之后的任何东西都会被丢弃。
</para>
</note>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>7.1.0</entry>
<entry>
添加 <parameter>rest_index</parameter> 参数。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example xml:id="getopt.examples-1">
<title><function>getopt</function> 示例:基本用法</title>
<programlisting role="php">
<![CDATA[
<?php
// Script example.php
$options = getopt("f:hp:");
var_dump($options);
?>
]]>
</programlisting>
<programlisting role="shell">
<![CDATA[
shell> php example.php -fvalue -h
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(2) {
["f"]=>
string(5) "value"
["h"]=>
bool(false)
}
]]>
</screen>
</example>
</para>
<para>
<example xml:id="getopt.examples-2">
<title><function>getopt</function> 示例:引入长选项</title>
<programlisting role="php">
<![CDATA[
<?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);
?>
]]>
</programlisting>
<programlisting role="shell">
<![CDATA[
shell> php example.php -f "value for f" -v -a --required value --optional="optional value" --option
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
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)
}
]]>
</screen>
</example>
</para>
<para>
<example xml:id="getopt.examples-3">
<title><function>getopt</function> 示例:传递同一多个选项</title>
<programlisting role="php">
<![CDATA[
<?php
// Script example.php
$options = getopt("abc");
var_dump($options);
?>
]]>
</programlisting>
<programlisting role="shell">
<![CDATA[
shell> php example.php -aaac
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(2) {
["a"]=>
array(3) {
[0]=>
bool(false)
[1]=>
bool(false)
[2]=>
bool(false)
}
["c"]=>
bool(false)
}
]]>
</screen>
</example>
</para>
<para>
<example xml:id="getopt.examples-4">
<title><function>getopt</function> 示例:使用 <parameter>rest_index</parameter></title>
<programlisting role="php">
<![CDATA[
<?php
// Script example.php
$rest_index = null;
$opts = getopt('a:b:', [], $rest_index);
$pos_args = array_slice($argv, $rest_index);
var_dump($pos_args);
]]>
</programlisting>
<programlisting role="shell">
<![CDATA[
shell> php example.php -a 1 -b 2 -- test
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(1) {
[0]=>
string(4) "test"
}
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link linkend="reserved.variables.argv"><varname>$argv</varname></link></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->