| blob | 3dbe20be725d3e9deb4a82cd2622b2aa915d77c6 |
1 <sect1 id="zend.console.getopt.configuration">
2 <title> 配置 Zend_Console_Getopt</title>
4 <sect2 id="zend.console.getopt.configuration.addrules">
5 <title> 添加选项规则 </title>
6 <para>
7 使用<code>addRules()</code>方法，可以添加更多除了在<code>Zend_Console_Getopt</code>构造器中指定的选项规则。<code>addRules()</code> 的参数和给这个类的构造器的第一个参数相同。它可以是符合短语法选项规范的字符串，也可以是符合长选项语法的联合数组。关于选项规范语法的细节参见<link linkend="zend.console.getopt.rules"> 声明 Getopt 规则 </link>。
8 </para>
9 <example id="zend.console.getopt.configuration.addrules.example">
10 <title> 使用 addRules()</title>
11 <programlisting role="php"><![CDATA[
12 $opts = new Zend_Console_Getopt('abp:');
13 $opts->addRules(
14 array(
15 'verbose|v' => 'Print verbose output'
16 )
17 );
18 ]]>
19 </programlisting>
20 </example>
21 <para>
22 上述例子示例添加带有 "<code>-v</code>" 别名的 "<code>--verbose</code>" 选项给在定义在调用构造器的一组选项。注意你可以在<code>Zend_Console_Getopt</code>的同一实例中混合使用短格式选项和长格式选项。
23 </para>
24 </sect2>
26 <sect2 id="zend.console.getopt.configuration.addhelp">
27 <title> 添加帮助信息 </title>
28 <para>
29 除了当声明选项规则为长（语法）格式时指定帮助字符串（帮助信息），也可以用<code>setHelp()</code>方法来联系帮助字符串和选项规则。<code>setHelp()</code>方法的参数时一个联合数组，它的键是一个flag，值是一个相应的帮助字符串。
30 </para>
31 <example id="zend.console.getopt.configuration.addhelp.example">
32 <title> 使用 setHelp()</title>
33 <programlisting role="php"><![CDATA[
34 $opts = new Zend_Console_Getopt('abp:');
35 $opts->setHelp(
36 array(
37 'a' => 'apple option, with no parameter',
38 'b' => 'banana option, with required integer parameter',
39 'p' => 'pear option, with optional string parameter'
40 )
41 );
42 ]]>
43 </programlisting>
44 </example>
45 <para>
46 如果被声明的选项带有别名，可使用任何一个别名来作为联合数组的键。
47 </para>
48 <para>
49 如果使用短语法声明选项，<code>setHelp()</code>方法是定义帮助信息的唯一办法。
50 </para>
51 </sect2>
53 <sect2 id="zend.console.getopt.configuration.addaliases">
54 <title> 添加选项别名 </title>
55 <para>
56 你可以使用<code>setAliases</code>方法为选项声明别名。参数是一个联合数组，它的键为一个先前声明的字符串，值是一个相应于那个 flag 的新的别名。这些别名和已存在的别名合并。换句话说，早先声明的别名仍然有效。
57 </para>
58 <para>
59 一个别名只能声明一次。如果企图重新定义一个别名，<code>Zend_Console_Getopt_Exception</code> 将被抛出。
60 </para>
61 <example id="zend.console.getopt.configuration.addaliases.example">
62 <title> 使用 setAliases()</title>
63 <programlisting role="php"><![CDATA[
64 $opts = new Zend_Console_Getopt('abp:');
65 $opts->setAliases(
66 array(
67 'a' => 'apple',
68 'a' => 'apfel',
69 'p' => 'pear'
70 )
71 );
72 ]]>
73 </programlisting>
74 </example>
75 <para>
76 在上面的例子中，在声明这些别名后，"<code>-a</code>"、 "<code>--apple</code>" 和 "<code>--apfel</code>" 互为别名。"<code>-p</code>" 和 "<code>--pear</code>" 互为别名。
77 </para>
78 <para>
79 如果使用短语法声明选项，<code>setAliases()</code>方法是定义帮助信息的唯一办法。
80 </para>
81 </sect2>
83 <sect2 id="zend.console.getopt.configuration.addargs">
84 <title> 添加参数列表 </title>
85 <para>
86 缺省地，<code>Zend_Console_Getopt</code> 使用 <code>$_SERVER['argv']</code> 作为用来解析的命令行参数数组。你可以另外指定参数数组作为第二个构造器参数。最后，你可以用 <code>addArguments()</code> 方法追加更多的参数给这些已经使用的参数，或者你可以使用 <code>setArguments()</code> 方法替换当前的参数数组。对于这两种情况，这些方法的参数是简单的字符串数组。前者追加数组到当前参数，后者替换当前参数的数组。
87 </para>
88 <example id="zend.console.getopt.configuration.addargs.example">
89 <title> 使用 addArguments() 和 setArguments()</title>
90 <programlisting role="php"><![CDATA[
91 // 缺省地，构造器使用 $_SERVER['argv']
92 $opts = new Zend_Console_Getopt('abp:');
94 // 追加数组给当前参数
95 $opts->addArguments(array('-a', '-p', 'p_parameter', 'non_option_arg'));
97 // 替换当前的参数
98 $opts->setArguments(array('-a', '-p', 'p_parameter', 'non_option_arg'));
99 ]]>
100 </programlisting>
101 </example>
102 </sect2>
104 <sect2 id="zend.console.getopt.configuration.config">
105 <title> 添加配置 </title>
106 <para>
107 <code>Zend_Console_Getopt</code> 构造器的第三个参数是个影响返回的对象实例行为的配置选项数组。也可以使用 <code>setOptions()</code> 方法指定配置选项， 或者用 <code>setOption()</code> 方法设置一个独立的选项。
108 </para>
109 <note>
110 <title> 阐明术语 "option" </title>
111 <para>
112 <code>Zend_Console_Getopt</code>类的配置使用术语 "option" 来匹配在Zend Framework 其它地方使用的术语。这些和<code>Zend_Console_Getopt</code> 类解析的命令行选项不是一回事。
113 </para>
114 </note>
115 <para>
116 当前支持的选项在类中有常量定义。它们的常量标识符（在括号中的文字）列表如下：
117 </para>
118 <itemizedlist>
119 <listitem>
120 <para>
121 <code>Zend_Console_Getopt::CONFIG_DASHDASH</code> ("dashDash")，如果为 true，允许特殊 flag "<code>--</code>" 表示 flag 的结尾。带有双短横线的符号不被翻译为选项，即使参数以一个短横线开头。这个配置选项缺省为 true。
122 </para>
123 </listitem>
124 <listitem>
125 <para>
126 <code>Zend_Console_Getopt::CONFIG_IGNORECASE</code> ("ignoreCase")，如果为 true，如果它们不同，使 flags 互为别名。这样，"<code>-a</code>" 和 "<code>-A</code>" 将被认为是同义 flags。这个配置选项缺省为 false。
127 </para>
128 </listitem>
129 <listitem>
130 <para>
131 <code>Zend_Console_Getopt::CONFIG_RULEMODE</code>("ruleMode") 可以有 <code>Zend_Console_Getopt::MODE_ZEND</code> ("zend") 和 <code>Zend_Console_Getopt::MODE_GNU</code> ("gnu") 的值。使用这个选项不是必须的除非你用另外的语法形式扩展这个类。这两个方法在 <code>Zend_Console_Getopt</code> 类中明确地支持。如果指定器是字符串， 这个类就假定为 <code>MODE_GNU</code> ，否则它就假定为 <code>MODE_ZEND</code> 。但如果你扩展这个类并添加更多语法形式， 你需要用这个选项来指定模式。
132 </para>
133 </listitem>
134 </itemizedlist>
135 <para>
136 更多的选项可以将被添加为这个类的增强。
137 </para>
138 <para>
139 <code>setOption()</code> 方法的两个参数是配置选项名称和选项值。
140 </para>
141 <example id="zend.console.getopt.configuration.config.example.setoption">
142 <title> 使用 setOption()</title>
143 <programlisting role="php"><![CDATA[
144 $opts = new Zend_Console_Getopt('abp:');
145 $opts->setOption('ignoreCase', true);
146 ]]>
147 </programlisting>
148 </example>
149 <para>
150 <code>setOptions()</code> 方法的参数是一个联合数组。这个数组的键是配置选项名称，（数组的）值是配置（选项）的值。这也是用于类构造器的数组格式。你指定的配置的值和当前配置合并，不需要列出所有的选项。
151 </para>
152 <example id="zend.console.getopt.configuration.config.example.setoptions">
153 <title> 使用 setOptions()</title>
154 <programlisting role="php"><![CDATA[
155 $opts = new Zend_Console_Getopt('abp:');
156 $opts->setOptions(
157 array(
158 'ignoreCase' => true,
159 'dashDash' => false
160 )
161 );
162 ]]>
163 </programlisting>
164 </example>
165 </sect2>
167 </sect1>