类 ConsoleInputOption
表示命令行中使用的单个选项的对象。 ConsoleOptionParser 在使用 addOption() 时创建这些对象。
属性摘要
-
$_boolean protected
bool该选项是否为布尔选项。 布尔选项不消耗参数。
-
$_choices protected
list<string>该选项的选择数组。
-
$_default protected
string|bool|null该选项的默认值
-
$_help protected
string该选项的帮助文本。
-
$_multiple protected
bool该选项是否可以接受多个值定义。
-
$_name protected
string选项的名称
-
$_short protected
string选项的简短 (1 个字符) 别名。
-
$prompt protected
string|null提示字符串
-
$required protected
bool该选项是否为必需选项。
方法摘要
-
__construct() public
创建一个新的输入选项
-
acceptsMultiple() public
检查该选项是否接受多个值。
-
choices() public
获取该选项具有的选择列表。
-
defaultValue() public
获取该选项的默认值
-
help() public
生成该选项的帮助信息。
-
isBoolean() public
检查该选项是否为布尔选项
-
isRequired() public
检查该选项是否为必需选项
-
name() public
获取名称属性的值。
-
prompt() public
获取提示字符串
-
short() public
获取短属性的值。
-
usage() public
获取该选项的用法值
-
validChoice() public
检查值是否为该选项的有效选择。
-
xml() public
将选项的 XML 附加到父级。
方法详细说明
__construct() ¶ public
__construct(string $name, string $short = '', string $help = '', bool $isBoolean = false, string|bool|null $default = null, list<string> $choices = [], bool $multiple = false, bool $required = false, string|null $prompt = null)创建一个新的输入选项
参数
-
string$name 选项的长名称，或包含所有属性的数组。
-
string$short optional 该选项的简短别名
-
string$help optional 该选项的帮助文本
-
bool$isBoolean optional 该选项是否为布尔选项。 布尔选项不消耗额外的标记
-
string|bool|null$default optional 该选项的默认值。
-
list<string>$choices optional 该选项的有效选择。
-
bool$multiple optional 该选项是否可以接受多个值定义。
-
bool$required optional 该选项是否为必需选项。
-
string|null$prompt optional 提示字符串。
抛出
Cake\Console\Exception\ConsoleExceptionhelp() ¶ public
help(int $width = 0): string生成该选项的帮助信息。
参数
-
int$width optional 使选项名称的宽度。
返回值
stringvalidChoice() ¶ public
validChoice(string|bool $value): true检查值是否为该选项的有效选择。
参数
-
string|bool$value 要验证的选择。
返回值
true抛出
Cake\Console\Exception\ConsoleExceptionxml() ¶ public
xml(SimpleXMLElement $parent): SimpleXMLElement将选项的 XML 附加到父级。
参数
-
SimpleXMLElement$parent 父元素。
返回值
SimpleXMLElement