Class yii\console\controllers\HelpController

继承yii\console\controllers\HelpController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable, yii\base\ViewContextInterface
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/console/controllers/HelpController.php

提供有关控制台命令的帮助信息.

此命令显示应用程序中的可用命令列表或有关使用特定命令的详细说明.

可以在命令行上按以下方式使用此命令行:

yii help [command name]

在上面, 如果未提供命令名称, 则将显示所有可用命令.

公共属性

隐藏继承的属性

属性类型描述定义在
$action yii\base\Action|null 当前正在执行的动作. yii\base\Controller
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. 该属性是只读的. yii\base\Component
$color boolean|null 是否在输出中启用 ANSI 颜色. yii\console\Controller
$commands array 所有可用的命令名称. 该属性是只读的. yii\console\controllers\HelpController
$defaultAction string 在请求中未指定动作ID时使用的动作ID. yii\base\Controller
$help boolean 是否显示有关当前命令的帮助信息. yii\console\Controller
$helpSummary string 该属性是只读的. yii\console\Controller
$id string 该控制器的ID. yii\base\Controller
$interactive boolean 是否以交互方式运行命令. yii\console\Controller
$layout null|string|false 要应用于此控制器的视图的布局的名称. yii\base\Controller
$module yii\base\Module 该控制器所属的模块. yii\base\Controller
$modules yii\base\Module[] 该控制器所在的所有祖先模块. 该属性是只读的. yii\base\Controller
$passedOptionValues array 与传递的选项相对应的属性. 该属性是只读的. yii\console\Controller
$passedOptions array 执行期间传递的选项名称. 该属性是只读的. yii\console\Controller
$request yii\console\Request yii\console\Controller
$response yii\console\Response yii\console\Controller
$route string 当前请求的路由(模块ID, 控制器ID和动作ID). 该属性是只读的. yii\base\Controller
$silentExitOnException boolean|null 如果为true, 脚本在出现异常的情况下以ExitCode::OK结尾; 如果为false, ExitCode::UNSPECIFIED_ERROR. yii\console\Controller
$uniqueId string 以模块ID(如果有)为前缀的控制器ID. 该属性是只读的. yii\base\Controller
$view yii\base\View|yii\web\View 可用于渲染视图或视图文件的视图对象. yii\base\Controller
$viewPath string 包含此控制器的视图文件的目录. yii\base\Controller

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的指定的方法. yii\base\Component
__clone() 在通过克隆现有对象创建对象之后调用此方法. yii\base\Component
__construct() 构造函数. yii\base\Controller
__get() 返回组件属性的值. yii\base\Component
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\Component
__set() 设置组件属性的值. yii\base\Component
__unset() 将组件属性设置为null. yii\base\Component
actionIndex() 显示可用命令或有关特定命令的详细信息. yii\console\controllers\HelpController
actionList() 以机器可读的格式列出所有可用的控制器和动作. yii\console\controllers\HelpController
actionListActionOptions() 以机器可读格式列出 $action 的所有可用选项. yii\console\controllers\HelpController
actionUsage() 显示 $action 的用法信息. yii\console\controllers\HelpController
actions() 为控制器声明外部动作. yii\base\Controller
afterAction() 执行动作后立即调用该方法. yii\base\Controller
ansiFormat() 使用 ANSI 代码格式化字符串. yii\console\Controller
attachBehavior() 将行为附加到此组件. yii\base\Component
attachBehaviors() 将行为列表附加到组件. yii\base\Component
beforeAction() 在执行动作之前立即调用该方法. yii\console\Controller
behaviors() 返回此组件应该具有的行为列表. yii\base\Component
bindActionParams() 将参数绑定到动作. yii\console\Controller
canGetProperty() 返回一个值, 指示属性是否可读取. yii\base\Component
canSetProperty() 返回一个值, 指示属性是否可设置. yii\base\Component
className() 返回此类的完全限定名称. yii\base\BaseObject
confirm() 要求用户输入yn进行确认. yii\console\Controller
createAction() 根据给定的动作ID创建一个动作. yii\base\Controller
detachBehavior() 从组件中分离一个行为. yii\base\Component
detachBehaviors() 分离组件中的所有行为. yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件. yii\base\Component
findLayoutFile() 查找适用的布局文件. yii\base\Controller
getActionArgsHelp() 返回动作的匿名参数的帮助信息. yii\console\Controller
getActionHelp() 返回指定动作的详细帮助信息. yii\console\Controller
getActionHelpSummary() 返回描述指定动作的单行简单摘要. yii\console\Controller
getActionOptionsHelp() 返回动作选项的帮助信息. yii\console\Controller
getActions() 返回指定控制器的所有可用动作. yii\console\controllers\HelpController
getBehavior() 返回指定的行为对象. yii\base\Component
getBehaviors() 返回附加到此组件的所有行为. yii\base\Component
getCommands() 返回所有可用的命令名称. yii\console\controllers\HelpController
getHelp() 返回此控制器的帮助信息. yii\console\Controller
getHelpSummary() 返回描述此控制器的单行简单摘要. yii\console\Controller
getModules() 返回此控制器的所有祖先模块. yii\base\Controller
getOptionValues() 返回与动作id的选项相对应的属性. yii\console\Controller
getPassedOptionValues() 返回与传递的选项相对应的属性. yii\console\Controller
getPassedOptions() 返回执行期间传递的选项的名称. yii\console\Controller
getRoute() 返回当前请求的路由. yii\base\Controller
getUniqueId() 返回控制器的唯一ID. yii\base\Controller
getView() 返回可用于渲染视图或视图文件的视图对象. yii\base\Controller
getViewPath() 返回包含此控制器的视图文件的目录. yii\base\Controller
hasEventHandlers() 返回一个值, 指示是否有任何处理程序附加到指定的事件. yii\base\Component
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\Component
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\Component
init() 初始化对象. yii\base\Controller
isColorEnabled() 返回一个值, 该值指示是否启用 ANSI 颜色. yii\console\Controller
off() 从该组件分离现有的事件处理程序. yii\base\Component
on() 将事件处理程序附加到事件. yii\base\Component
optionAliases() 返回选项别名. yii\console\Controller
options() 返回动作的有效操作选项. yii\console\Controller
prompt() 提示用户输入并验证输入. yii\console\Controller
render() 渲染视图并应用布局(如果可用). yii\base\Controller
renderContent() 通过应用布局渲染静态字符串. yii\base\Controller
renderFile() 渲染视图文件. yii\base\Controller
renderPartial() 渲染视图而不使用布局. yii\base\Controller
run() 运行根据路由指定的请求. yii\base\Controller
runAction() 使用指定的动作id和参数运行一个动作. yii\console\Controller
select() 给用户一个选择的选项. yii\console\Controller
setView() 设置此控制器使用的视图对象. yii\base\Controller
setViewPath() 设置包含视图文件的目录. yii\base\Controller
stderr() 将字符串打印到 STDERR. yii\console\Controller
stdout() 将字符串打印到 STDOUT. yii\console\Controller
trigger() 触发事件. yii\base\Component

事件

隐藏继承的事件

事件类型描述定义在
EVENT_AFTER_ACTION yii\base\ActionEvent 执行控制器动作后立即触发的事件. yii\base\Controller
EVENT_BEFORE_ACTION yii\base\ActionEvent 在执行控制器动作之前触发的事件. yii\base\Controller

常量

隐藏继承的常量

常量描述定义在
EXIT_CODE_ERROR 1 Deprecated since 2.0.13. 改用 yii\console\ExitCode::UNSPECIFIED_ERROR. yii\console\Controller
EXIT_CODE_NORMAL 0 Deprecated since 2.0.13. 改用 yii\console\ExitCode::OK. yii\console\Controller

属性详情

$commands public 属性

所有可用的命令名称. 该属性是只读的.

public array $commands null

方法详情

actionIndex() public 方法

显示可用命令或有关特定命令的详细信息.

public integer actionIndex ( $command null )
$command string

显示帮助的命令名称. 如果未提供, 将显示所有可用命令.

return integer

退出状态.

throws yii\console\Exception

如果帮助命令未知.

actionList() public 方法 (可用自版本: 2.0.11)

以机器可读的格式列出所有可用的控制器和动作.

这用于 shell 完成.

public void actionList ( )
actionListActionOptions() public 方法 (可用自版本: 2.0.11)

以机器可读格式列出 $action 的所有可用选项.

这用于 shell 完成.

public void actionListActionOptions ( $action )
$action string

动作的路由.

actionUsage() public 方法 (可用自版本: 2.0.11)

显示 $action 的用法信息.

public void actionUsage ( $action )
$action string

动作的路由.

formatOptionAliases() protected 方法 (可用自版本: 2.0.8)

protected string formatOptionAliases ( $controller, $option )
$controller yii\console\Controller

控制器实例

$option string

选项名称.

return string

别名参数或选项的格式化字符串.

formatOptionHelp() protected 方法

为参数或选项生成格式正确的字符串.

protected string formatOptionHelp ( $name, $required, $type, $defaultValue, $comment )
$name string

参数或选项的名称.

$required boolean

是否需要参数.

$type string

选项或参数的类型.

$defaultValue mixed

选项或参数的默认值.

$comment string

关于选项或参数的注释.

return string

参数或选项的格式化字符串.

getActions() public 方法

返回指定控制器的所有可用动作.

public array getActions ( $controller )
$controller yii\console\Controller

控制器实例.

return array

所有可用的动作ID.

getCommandDescriptions() protected 方法

返回命令及其说明的数组.

protected array getCommandDescriptions ( )
return array

所有可用的命令均作为键, 其说明为值.

getCommandHelp() protected 方法

显示命令的整体信息.

protected void getCommandHelp ( $controller )
$controller yii\console\Controller

控制器实例.

getCommands() public 方法

返回所有可用的命令名称.

public array getCommands ( )
return array

所有可用的命令名称.

getDefaultHelp() protected 方法

显示所有可用命令.

protected void getDefaultHelp ( )
getDefaultHelpHeader() protected 方法 (可用自版本: 2.0.11)

返回默认帮助标题.

protected string getDefaultHelpHeader ( )
return string

默认帮助标题.

getModuleCommands() protected 方法

返回指定模块的可用命令.

protected array getModuleCommands ( $module )
$module yii\base\Module

模块实例.

return array

可用命令名称.

getScriptName() protected 方法

protected string getScriptName ( )
return string

当前正在允许的 cli 脚本的名称.

getSubCommandHelp() protected 方法

显示命令动作的详细信息.

protected void getSubCommandHelp ( $controller, $actionID )
$controller yii\console\Controller

控制器实例.

$actionID string

动作 ID.

throws yii\console\Exception

如果动作不存在.

validateControllerClass() protected 方法

验证给定的类是否为有效的控制台控制器类.

protected boolean validateControllerClass ( $controllerClass )
$controllerClass string