Class yii\console\Controller

使用 ANSI 代码格式化字符串。

你可以使用 yii\helpers\Console 中定义的常量传递其他参数。

例如：

echo $this->ansiFormat('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);

将参数绑定到动作。 当 yii\base\Action 开始使用给定的参数运行时，此方法被调用。 此方法首先将参数与操作可用的 options绑定。 然后验证给定的参数。

要求用户通过键入 y 或 n 来确认。

典型用法如下所示：

if ($this->confirm("Are you sure?")) {
    echo "user typed yes\n";
} else {
    echo "user typed no\n";
}

返回动作的匿名参数的帮助信息。

返回的值应该是一个数组。键是参数名称，值是 相应的帮助信息。每个值必须是以下结构的数组：

• required: boolean，是否需要此参数。
• type: string，此参数的 PHP 类型。
• default: string，此参数的默认值
• comment: string，这个参数的注释

默认实现将返回从与动作方法对应的参数的文档注释中 提取的帮助信息。

返回指定动作的详细帮助信息。

返回描述指定动作的一行简短摘要。

返回动作选项的帮助信息。

返回的值应该是一个数组。键是选项名称，值是 相应的帮助信息。每个值必须是以下结构的数组：

• type: string，此参数的 PHP 类型。
• default: string，此参数的默认值
• comment: string，这个参数的注释

默认实现将返回从与动作方法对应的属性的文档注释中 提取的帮助信息。

返回此控制器的帮助信息。

您可以重写此方法以返回自定义帮助。 默认实现返回从 PHPDoc 注释中检索的帮助信息。

返回描述此控制器的一行简短摘要。

您可以重写此方法以返回自定义摘要。 默认实现返回 PHPDoc 注释的第一行。

返回与动作 ID 的选项对应的属性 子类可以重写此方法以指定可能的属性。

返回与传递的选项对应的属性。

返回执行期间传递的有效选项的名称。

返回一个指示是否启用 ANSI 颜色的值。

仅当 $color 设置为 true 或者没有设置并且终端支持 ANSI 颜色时 才启用 ANSI 颜色

返回选项别名。 子类可以重写此方法以指定别名选项。

参见 options().

返回操作的有效选项的动作（id） 选项要求存在一个名为选项名的 公共成员变量。 子类可以重写此方法以指定可能的选项。

请注意，通过选项设置的值不可用 直到调用 beforeAction()。

返回 docblock 的完整描述。

返回 docblock 的第一行。

将注释块解析为标记。

提示用户输入并验证它。

使用指定的动作 ID 和参数运行动作。 如果动作 ID 为空，则该方法将使用 $defaultAction。

参见 createAction().

为用户提供可供选择的选项。给予 '?' 作为输入将显示 可供选择的选项列表及其解释。

将字符串打印到 STDERR。

你可以选择使用 ANSI 代码格式化字符串， 通过使用 yii\helpers\Console 中定义的常量传递其他参数。

例如：

$this->stderr('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);

将字符串打印到 STDOUT。

你可以选择使用 ANSI 代码格式化字符串，通过 使用 yii\helpers\Console 中定义的常量传递其他参数。

例如：

$this->stdout('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);