类参数
提供与命令选项和参数交互的接口。
命名空间： Cake\Console
属性概述
方法概述
-
__construct() 公共的
构造函数
-
assertArgumentExists() 受保护的
-
getArgument() 公共的
按名称返回位置参数值，如果不存在则返回 null
-
getArgumentAt() 公共的
按索引获取位置参数。
-
getArguments() 公共的
获取所有位置参数。
-
getBooleanOption() 公共的
获取布尔选项的值，如果未设置则返回 null。
-
getMultipleOption() 公共的
获取多个选项的值，如果未设置则返回 null。
-
getOption() 公共的
获取非多个选项的值，如果未设置则返回 null。
-
getOptions() 公共的
获取所有选项的数组
-
hasArgument() 公共的
检查按名称是否存在位置参数
-
hasArgumentAt() 公共的
检查按索引是否存在位置参数
-
hasOption() 公共的
检查是否定义了选项且不为 null。
方法详情
__construct() ¶ 公共的
__construct(array<int, string> $args, array<string, list<string>|string|bool|null> $options, array<int, string> $argNames)构造函数
参数
-
array<int, string>$args 位置参数
-
array<string, list<string>|string|bool|null>$options 命名参数
-
array<int, string>$argNames 参数名称列表。预期顺序与 $args 相同。
getArgument() ¶ 公共的
getArgument(string $name): string|null按名称返回位置参数值，如果不存在则返回 null
参数
-
string$name 要检查的参数名称。
返回
string|nullgetArgumentAt() ¶ 公共的
getArgumentAt(int $index): string|null按索引获取位置参数。
参数
-
int$index 要访问的参数索引。
返回
string|nullgetBooleanOption() ¶ 公共的
getBooleanOption(string $name): bool|null获取布尔选项的值，如果未设置则返回 null。
参数
-
string$name
返回
bool|nullgetMultipleOption() ¶ 公共的
getMultipleOption(string $name): list<string>|null获取多个选项的值，如果未设置则返回 null。
参数
-
string$name
返回
list<string>|nullgetOption() ¶ 公共的
getOption(string $name): string|bool|null获取非多个选项的值，如果未设置则返回 null。
参数
-
string$name 要检查的选项的名称。
返回
string|bool|nullgetOptions() ¶ 公共的
getOptions(): array<string, list<string>|string|bool|null>获取所有选项的数组
返回
array<string, list<string>|string|bool|null>hasOption() ¶ 公共的
hasOption(string $name): bool检查是否定义了选项且不为 null。
参数
-
string$name 要检查的选项的名称。
返回
bool