类 ConsoleInputArgument
一个表示命令行中使用的单个参数的对象。ConsoleOptionParser 在您使用 addArgument() 时创建这些对象。
属性摘要
-
$_choices protected
list<string>此参数的有效选项数组。
-
$_default protected
string|null此参数的默认值。
-
$_help protected
string帮助字符串
-
$_name protected
string参数的名称。
-
$_required protected
bool此选项是否必需？
方法摘要
-
__construct() public
创建一个新的输入参数
-
defaultValue() public
获取此参数的默认值
-
help() public
生成此参数的帮助信息。
-
isEqualTo() public
检查此参数是否等于另一个参数。
-
isRequired() public
检查此参数是否为必需参数
-
name() public
获取名称属性的值。
-
usage() public
获取此参数的使用值
-
validChoice() public
检查 $value 是否为此参数的有效选项。
-
xml() public
将此参数的 XML 表示追加到传入的 SimpleXml 对象中。
方法详情
__construct() ¶ public
__construct(array<string, mixed>|string $name, string $help = '', bool $required = false, list<string> $choices = [], string|null $default = null)创建一个新的输入参数
参数
-
array<string, mixed>|string$name 选项的长名称，或包含所有属性的数组。
-
string$help optional 此选项的帮助文本
-
bool$required optional 此参数是否必需。缺少必需的参数将触发异常
-
list<string>$choices optional 此选项的有效选项。
-
string|null$default optional 此参数的默认值。
help() ¶ public
help(int $width = 0): string生成此参数的帮助信息。
参数
-
int$width optional 用于设置选项名称的宽度。
返回值
stringisEqualTo() ¶ public
isEqualTo(Cake\Console\ConsoleInputArgument $argument): bool检查此参数是否等于另一个参数。
参数
-
Cake\Console\ConsoleInputArgument$argument 要比较的 ConsoleInputArgument。
返回值
boolvalidChoice() ¶ public
validChoice(string $value): true检查 $value 是否为此参数的有效选项。
参数
-
string$value 要验证的选项。
返回值
true抛出
Cake\Console\Exception\ConsoleExceptionxml() ¶ public
xml(SimpleXMLElement $parent): SimpleXMLElement将此参数的 XML 表示追加到传入的 SimpleXml 对象中。
参数
-
SimpleXMLElement$parent 父元素。
返回值
SimpleXMLElement