php中yii的controller,Controller, yii\console\Controller

ansiFormat()

公共 方法

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

例如：

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

$string

要格式化的字符串

bindActionParams()

公共 方法

将参数绑定到动作。

当 yii\base\Action 开始使用给定的参数运行时，此方法被调用。

此方法首先将参数与操作可用的 options绑定。

然后验证给定的参数。

public $action, $params)

$action

要用参数绑定的动作

$params

要绑定到动作的参数

return

可以运行动作的有效参数。

confirm()

公共 方法

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

典型用法如下所示：

if ($this->confirm("Are you sure?")) {

echo "user typed yes\n";

} else {

echo "user typed no\n";

}

public $message, $default=false)

$message

在等待用户输入之前回显

$default

如果未进行选择，则返回此值。

return

用户是否确认。

如果 $interactive 是 false 则返回 true。

getActionArgsHelp()

公共 方法

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

返回的值应该是一个数组。键是参数名称，值是

相应的帮助信息。每个值必须是以下结构的数组：

required: boolean，是否需要此参数。

type: string，此参数的 PHP 类型。

default: string，此参数的默认值

comment: string，这个参数的注释

默认实现将返回从与动作方法对应的参数的文档注释中

提取的帮助信息。

getActionHelp()

公共 方法

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

return

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

getActionHelpSummary()

公共 方法

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

return

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

getActionMethodReflection()

受保护 方法

getActionOptionsHelp()

公共 方法

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

返回的值应该是一个数组。键是选项名称，值是

相应的帮助信息。每个值必须是以下结构的数组：

type: string，此参数的 PHP 类型。

default: string，此参数的默认值

comment: string，这个参数的注释

默认实现将返回从与动作方法对应的属性的文档注释中

提取的帮助信息。

getHelp()

公共 方法

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

您可以重写此方法以返回自定义帮助。

默认实现返回从 PHPDoc 注释中检索的帮助信息。

getHelpSummary()

公共 方法

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

您可以重写此方法以返回自定义摘要。

默认实现返回 PHPDoc 注释的第一行。

getOptionValues()

公共 方法

返回与动作 ID 的选项对应的属性

子类可以重写此方法以指定可能的属性。

$actionID

当前请求的动作 id

return

属性对应于动作的选项

getPassedOptionValues()

公共 方法

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

getPassedOptions()

公共 方法

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

return

执行期间传递的选项的名称

isColorEnabled()

公共 方法

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

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

才启用 ANSI 颜色

public $stream= \STDOUT)

$stream

The stream to check.

return

Whether to enable ANSI style in output.

optionAliases()

公共 方法

(自版本 2.0.8 可用)

返回选项别名。

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

return

选项别名对操作有效，

其中键是选项的别名，值是选项名。

options()

公共 方法

返回操作的有效选项的动作(id)

选项要求存在一个名为选项名的

公共成员变量。

子类可以重写此方法以指定可能的选项。

请注意，通过选项设置的值不可用

直到调用 beforeAction()。

public $actionID)

$actionID

当前请求的动作 id

return

对操作有效的选项名称

parseDocCommentDetail()

受保护 方法

返回 docblock 的完整描述。

parseDocCommentSummary()

受保护 方法

返回 docblock 的第一行。

parseDocCommentTags()

受保护 方法

将注释块解析为标记。

$reflection

注释块

return

解析的标记

prompt()

公共 方法

提示用户输入并验证它。

public $text, $options= [])

$text

提示字符串

$options

验证输入的选项：

required：是否需要

default：如果用户未插入输入，则为默认值

pattern：用于验证用户输入的正则表达式模式

validator：用于验证输入的可调用函数。该函数必须接受两个参数：$input：用于验证的用户输入

$error：如果验证失败，则通过引用传递的错误值。

如何将提示方法与验证器函数一起使用的示例。

$code = $this->prompt('Enter 4-Chars-Pin', ['required' => true, 'validator' => function($input, &$error){

if (strlen($input) !== 4) {

$error = 'The Pin must be exactly 4 chars!';

return false;

}

return true;

}]);

return

用户输入

runAction()

公共 方法

使用指定的动作 ID 和参数运行动作。

如果动作 ID 为空，则该方法将使用 $defaultAction。

public $id, $params= [])

$id

要执行的动作的 ID。

$params

要传递给动作的参数(名称-值 对)。

return

动作执行的状态。0 表示正常，其他值表示异常。

select()

公共 方法

为用户提供可供选择的选项。给予 '?' 作为输入将显示

可供选择的选项列表及其解释。

public $prompt, $options= [])

$prompt

提示消息

$options

可供选择的选项的键值数组

return

用户选择的选项字符

stderr()

公共 方法

将字符串打印到 STDERR。

你可以选择使用 ANSI 代码格式化字符串，

通过使用 yii\helpers\Console 中定义的常量传递其他参数。

例如：

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

$string

要打印的字符串

return

打印的字节数或 false 在错误时

stdout()

公共 方法

将字符串打印到 STDOUT。

你可以选择使用 ANSI 代码格式化字符串，通过

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

例如：

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

$string

要打印的字符串

return

打印的字节数或 false 在错误时