没有命名空间的类 yii yii\base yii\behaviors yii\caching yii\captcha yii\console yii\console\controllers yii\console\widgets yii\data yii\db yii\db\conditions yii\db\cubrid yii\db\cubrid\conditions yii\db\mssql yii\db\mssql\conditions yii\db\mysql yii\db\oci yii\db\oci\conditions yii\db\pgsql yii\db\sqlite yii\db\sqlite\conditions yii\di yii\filters yii\filters\auth yii\grid yii\helpers yii\i18n yii\log yii\mail yii\mutex yii\rbac yii\rest yii\test yii\validators yii\web yii\widgets

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/yiichina/yii2/blob/api/framework/console/controllers/HelpController.php

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

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

此命令可在命令行中使用如下：

yii help [command name]

在上述命令中，如果未提供命令名称， 将显示所有可用的命令。

公共属性

隐藏继承的属性

属性类型描述被定义在
$action yii\base\Action The action that is currently being executed. yii\base\Controller
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$color boolean 是否在输出中启用 ANSI 颜色。 如果未设置，则仅为支持 ANSI 颜色的终端启用 ANSI 颜色。 yii\console\Controller
$commands array 所有可用的命令名。 yii\console\controllers\HelpController
$defaultAction string The ID of the action that is used when the action ID is not specified in the request. yii\base\Controller
$help boolean 是否显示有关当前命令的帮助信息。 yii\console\Controller
$helpSummary string yii\console\Controller
$id string The ID of this controller. yii\base\Controller
$interactive boolean 是否以交互方式运行命令。 yii\console\Controller
$layout null|string|false The name of the layout to be applied to this controller's views. yii\base\Controller
$module yii\base\Module The module that this controller belongs to. yii\base\Controller
$modules yii\base\Module[] All ancestor modules that this controller is located within. yii\base\Controller
$passedOptionValues array 与传递的选项对应的属性 yii\console\Controller
$passedOptions array 执行期间传递的选项的名称 yii\console\Controller
$route string The route (module ID, controller ID and action ID) of the current request. yii\base\Controller
$uniqueId string The controller ID that is prefixed with the module ID (if any). yii\base\Controller
$view yii\base\View|yii\web\View The view object that can be used to render views or view files. yii\base\Controller
$viewPath string The directory containing the view files for this controller. yii\base\Controller

公共方法

隐藏继承的方法

方法描述被定义在
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() yii\base\Controller
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
actionIndex() 显示可用的命令或有关特定命令的 详细信息。 yii\console\controllers\HelpController
actionList() 以计算机可读的格式列出所有可用的控制器和动作。 这用于完成 shell。 yii\console\controllers\HelpController
actionListActionOptions() 以机器可读格式列出 $action 的所有可用选项。 这用于完成 shell。 yii\console\controllers\HelpController
actionUsage() 显示 $action 的使用信息。 yii\console\controllers\HelpController
actions() Declares external actions for the controller. yii\base\Controller
afterAction() This method is invoked right after an action is executed. yii\base\Controller
ansiFormat() 使用 ANSI 代码格式化字符串。 yii\console\Controller
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
beforeAction() This method is invoked right before an action is executed. yii\base\Controller
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
bindActionParams() 将参数绑定到动作。 当 yii\base\Action 开始使用给定的参数运行时，此方法被调用。 此方法首先将参数与操作可用的 options绑定。 然后验证给定的参数。 yii\console\Controller
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
className() Returns the fully qualified name of this class. yii\base\BaseObject
confirm() 要求用户通过键入 y 或 n 来确认。 yii\console\Controller
createAction() Creates an action based on the given action ID. yii\base\Controller
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
findLayoutFile() Finds the applicable layout file. 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() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getCommands() 返回所有可用的命令名。 yii\console\controllers\HelpController
getHelp() 返回此控制器的帮助信息。 yii\console\Controller
getHelpSummary() 返回描述此控制器的一行简短摘要。 yii\console\Controller
getModules() Returns all ancestor modules of this controller. yii\base\Controller
getOptionValues() 返回与动作 ID 的选项对应的属性 子类可以重写此方法以指定可能的属性。 yii\console\Controller
getPassedOptionValues() 返回与传递的选项对应的属性。 yii\console\Controller
getPassedOptions() 返回执行期间传递的有效选项的名称。 yii\console\Controller
getRoute() Returns the route of the current request. yii\base\Controller
getUniqueId() Returns the unique ID of the controller. yii\base\Controller
getView() Returns the view object that can be used to render views or view files. yii\base\Controller
getViewPath() Returns the directory containing view files for this controller. yii\base\Controller
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() Initializes the object. yii\base\BaseObject
isColorEnabled() 返回一个指示是否启用 ANSI 颜色的值。 yii\console\Controller
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
optionAliases() 返回选项别名。 子类可以重写此方法以指定别名选项。 yii\console\Controller
options() 返回操作的有效选项的动作（id） 选项要求存在一个名为选项名的 公共成员变量。 子类可以重写此方法以指定可能的选项。 yii\console\Controller
prompt() 提示用户输入并验证它。 yii\console\Controller
render() Renders a view and applies layout if available. yii\base\Controller
renderContent() Renders a static string by applying a layout. yii\base\Controller
renderFile() Renders a view file. yii\base\Controller
renderPartial() Renders a view without applying layout. yii\base\Controller
run() Runs a request specified in terms of a route. yii\base\Controller
runAction() 使用指定的动作 ID 和参数运行动作。 如果动作 ID 为空，则该方法将使用 $defaultAction。 yii\console\Controller
select() 为用户提供可供选择的选项。给予 '?' 作为输入将显示 可供选择的选项列表及其解释。 yii\console\Controller
setView() Sets the view object to be used by this controller. yii\base\Controller
setViewPath() Sets the directory that contains the view files. yii\base\Controller
stderr() 将字符串打印到 STDERR。 yii\console\Controller
stdout() 将字符串打印到 STDOUT。 yii\console\Controller
trigger() Triggers an event. yii\base\Component

受保护的方法

隐藏继承的方法

方法描述被定义在
formatOptionAliases() yii\console\controllers\HelpController
formatOptionHelp() 为参数或选项生成格式正确的字符串。 yii\console\controllers\HelpController
getActionMethodReflection() yii\console\Controller
getCommandDescriptions() 返回命令数组及其说明。 yii\console\controllers\HelpController
getCommandHelp() 显示命令的整体信息。 yii\console\controllers\HelpController
getDefaultHelp() 显示所有可用命令。 yii\console\controllers\HelpController
getDefaultHelpHeader() 返回默认帮助标题。 yii\console\controllers\HelpController
getModuleCommands() 返回指定模块的可用命令。 yii\console\controllers\HelpController
getScriptName() yii\console\controllers\HelpController
getSubCommandHelp() 显示命令操作的详细信息。 yii\console\controllers\HelpController
parseDocCommentDetail() 返回 docblock 的完整描述。 yii\console\Controller
parseDocCommentSummary() 返回 docblock 的第一行。 yii\console\Controller
parseDocCommentTags() 将注释块解析为标记。 yii\console\Controller
validateControllerClass() 验证给定的类是否是有效的控制台控制器类。 yii\console\controllers\HelpController

Events

隐藏继承的事件

事件类型描述被定义在
EVENT_AFTER_ACTION yii\base\ActionEvent An event raised right after executing a controller action. yii\base\Controller
EVENT_BEFORE_ACTION yii\base\ActionEvent An event raised right before executing a controller action. yii\base\Controller

常量

隐藏继承的常量

常量值描述被定义在
EXIT_CODE_ERROR 1 Deprecated 自 2.0.13。使用 \yii\console\controllers\ExitCode::UNSPECIFIED_ERROR 替代。 yii\console\Controller
EXIT_CODE_NORMAL 0 Deprecated 自 2.0.13。使用 \yii\console\controllers\ExitCode::OK 替代。 yii\console\Controller

属性详情

$commands 公共 只读 属性

所有可用的命令名。

public array getCommands ( )

方法详情

actionIndex() 公共 方法

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

public integer actionIndex($command = null)
$command string

要显示帮助的命令的名称。 如果未提供，将显示所有可用的命令。
return integer

退出状态
throws yii\console\Exception

如果帮助命令未知
actionList() 公共 方法 （自版本 2.0.11 可用）

以计算机可读的格式列出所有可用的控制器和动作。 这用于完成 shell。

public void actionList()
actionListActionOptions() 公共 方法 （自版本 2.0.11 可用）

以机器可读格式列出 $action 的所有可用选项。 这用于完成 shell。

public void actionListActionOptions($action)
$action string

动作的路由
actionUsage() 公共 方法 （自版本 2.0.11 可用）

显示 $action 的使用信息。

public void actionUsage($action)
$action string

动作路由
formatOptionAliases() 受保护 方法 （自版本 2.0.8 可用）

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

控制器实例
$option string

选项名称
return string

别名参数或选项的格式化字符串。
formatOptionHelp() 受保护 方法

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

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

参数或选项的名称
$required boolean

参数是否必需
$type string

选项或参数的类型
$defaultValue mixed

选项或参数的默认值
$comment string

关于选项或参数的注释
return string

参数或选项的格式化字符串
getActions() 公共 方法

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

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

控制器实例
return array

所有可用的动作 IDs.
getCommandDescriptions() 受保护 方法

返回命令数组及其说明。

protected array getCommandDescriptions()
return array

所有可用命令作为键，其描述为值。
getCommandHelp() 受保护 方法

显示命令的整体信息。

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

控制器实例
getCommands() 公共 方法

返回所有可用的命令名。

public array getCommands()
return array

所有可用的命令名。
getDefaultHelp() 受保护 方法

显示所有可用命令。

protected void getDefaultHelp()
getDefaultHelpHeader() 受保护 方法 （自版本 2.0.11 可用）

返回默认帮助标题。

protected string getDefaultHelpHeader()
return string

默认帮助标题。
getModuleCommands() 受保护 方法

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

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

模块实例
return array

可用的命令名称
getScriptName() 受保护 方法

protected string getScriptName()
return string

当前运行的 cli 脚本的名称。
getSubCommandHelp() 受保护 方法

显示命令操作的详细信息。

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

控制器实例
$actionID string

动作 ID
throws yii\console\Exception

如果动作不存在
validateControllerClass() 受保护 方法

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

protected boolean validateControllerClass($controllerClass)
$controllerClass string