0 关注者

类 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 string|null|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\base\Request|array|string 请求。 yii\base\Controller
$response yii\base\Response|array|string 响应。 yii\base\Controller
$route string 当前请求的路由(模块 ID、控制器 ID 和操作 ID)。 yii\base\Controller
$silentExitOnException boolean|null 如果为 true - 脚本在出现异常时以 `ExitCode::OK` 结束。 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() 要求用户通过输入 y 或 n 来确认。 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() 返回操作(id)的有效选项名称。选项需要存在一个名称为选项名称的公共成员变量。 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 自 2.0.13 版起已弃用。请改用 yii\console\ExitCode::UNSPECIFIED_ERROR yii\console\Controller
EXIT_CODE_NORMAL 0 自 2.0.13 版起已弃用。请改用 yii\console\ExitCode::OK yii\console\Controller

属性详细信息

隐藏继承的属性

$commands 公共属性

所有可用的命令名称。

public array $commands null

方法详细信息

隐藏继承的方法

__call() 公共方法

定义于: yii\base\Component::__call()

调用不是类方法的命名方法。

此方法将检查是否有任何附加的行为具有指定名称的方法,并在可用时执行该方法。

不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时会隐式调用。

public mixed __call ( $name, $params )
$name string

方法名称

$params array

方法参数

返回值 mixed

方法返回值

抛出 yii\base\UnknownMethodException

当调用未知方法时

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() 公共方法

定义于: yii\base\Component::__clone()

此方法在通过克隆现有对象创建对象后调用。

它会移除所有行为,因为它们已附加到旧对象。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() 公共方法
public void __construct ( $id, $module, $config = [] )
$id string

此控制器的 ID。

$module yii\base\Module

此控制器所属的模块。

$config array

将用于初始化对象属性的名称-值对。

                public function __construct($id, $module, $config = [])
{
    $this->id = $id;
    $this->module = $module;
    parent::__construct($config);
}

            
__get() 公共方法

定义于: yii\base\Component::__get()

返回组件属性的值。

此方法将按以下顺序检查并相应地采取操作

  • 通过 getter 定义的属性:返回 getter 结果
  • 行为的属性:返回行为属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $value = $component->property; 时会隐式调用。

另见 __set().

public mixed __get ( $name )
$name string

属性名称

返回值 mixed

属性值或行为属性的值

抛出 yii\base\UnknownPropertyException

如果属性未定义

抛出 yii\base\InvalidCallException

如果属性是只写的。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() 公共方法

定义于: yii\base\Component::__isset()

检查属性是否已设置,即定义且不为 null。

此方法将按以下顺序检查并相应地采取操作

  • 通过 setter 定义的属性:返回属性是否已设置
  • 行为的属性:返回属性是否已设置
  • 对于不存在的属性返回 false

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 isset($component->property) 时会隐式调用。

另见 https://php.ac.cn/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

属性名称或事件名称

返回值 boolean

指定的属性是否已设置

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() 公共方法

定义于: yii\base\Component::__set()

设置组件属性的值。

此方法将按以下顺序检查并相应地采取操作

  • 通过 setter 定义的属性:设置属性值
  • 以“on xyz”格式的事件:将处理程序附加到事件“xyz”
  • 以“as xyz”格式的行为:附加名为“xyz”的行为
  • 行为的属性:设置行为属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $component->property = $value; 时会隐式调用。

另见 __get().

public void __set ( $name, $value )
$name string

属性名称或事件名称

$value mixed

属性值

抛出 yii\base\UnknownPropertyException

如果属性未定义

抛出 yii\base\InvalidCallException

如果属性是只读的。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() 公共方法

定义于: yii\base\Component::__unset()

将组件属性设置为 null。

此方法将按以下顺序检查并相应地采取操作

  • 由 setter 定义的属性: 将属性值设置为 null
  • 行为的属性: 将属性值设置为 null

不要直接调用此方法,因为它是一个 PHP 魔术方法,将在执行 unset($component->property) 时隐式调用。

另请参见 https://php.ac.cn/manual/en/function.unset.php.

public void __unset ( $name )
$name string

属性名称

抛出 yii\base\InvalidCallException

如果属性是只读的。

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
actionIndex() 公共方法

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

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

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

返回值 integer

退出状态

抛出 yii\console\Exception

如果帮助命令未知

                public function actionIndex($command = null)
{
    if ($command !== null) {
        $result = Yii::$app->createController($command);
        if ($result === false) {
            $name = $this->ansiFormat($command, Console::FG_YELLOW);
            throw new Exception("No help for unknown command \"$name\".");
        }
        list($controller, $actionID) = $result;
        $actions = $this->getActions($controller);
        if ($actionID !== '' || count($actions) === 1 && $actions[0] === $controller->defaultAction) {
            $this->getSubCommandHelp($controller, $actionID);
        } else {
            $this->getCommandHelp($controller);
        }
    } else {
        $this->getDefaultHelp();
    }
}

            
actionList() 公共方法 (自版本 2.0.11 起可用)

以机器可读格式列出所有可用控制器和操作。

这用于 shell 自动补全。

public void actionList ( )

                public function actionList()
{
    foreach ($this->getCommandDescriptions() as $command => $description) {
        $result = Yii::$app->createController($command);
        /** @var $controller Controller */
        list($controller, $actionID) = $result;
        $actions = $this->getActions($controller);
        $prefix = $controller->getUniqueId();
        if ($controller->createAction($controller->defaultAction) !== null) {
            $this->stdout("$prefix\n");
        }
        foreach ($actions as $action) {
            $this->stdout("$prefix/$action\n");
        }
    }
}

            
actionListActionOptions() 公共方法 (自版本 2.0.11 起可用)

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

这用于 shell 自动补全。

public void actionListActionOptions ( $action )
$action string

路由到操作

                public function actionListActionOptions($action)
{
    $result = Yii::$app->createController($action);
    if ($result === false || !($result[0] instanceof Controller)) {
        return;
    }
    /** @var Controller $controller */
    list($controller, $actionID) = $result;
    $action = $controller->createAction($actionID);
    if ($action === null) {
        return;
    }
    foreach ($controller->getActionArgsHelp($action) as $argument => $help) {
        $description = preg_replace('~\R~', '', addcslashes($help['comment'], ':')) ?: $argument;
        $this->stdout($argument . ':' . $description . "\n");
    }
    $this->stdout("\n");
    foreach ($controller->getActionOptionsHelp($action) as $argument => $help) {
        $description = preg_replace('~\R~', '', addcslashes($help['comment'], ':'));
        $this->stdout('--' . $argument . ($description ? ':' . $description : '') . "\n");
    }
}

            
actionUsage() 公共方法 (自版本 2.0.11 起可用)

显示 $action 的用法信息。

public void actionUsage ( $action )
$action string

路由到操作

                public function actionUsage($action)
{
    $result = Yii::$app->createController($action);
    if ($result === false || !($result[0] instanceof Controller)) {
        return;
    }
    /** @var Controller $controller */
    list($controller, $actionID) = $result;
    $action = $controller->createAction($actionID);
    if ($action === null) {
        return;
    }
    $scriptName = $this->getScriptName();
    if ($action->id === $controller->defaultAction) {
        $this->stdout($scriptName . ' ' . $this->ansiFormat($controller->getUniqueId(), Console::FG_YELLOW));
    } else {
        $this->stdout($scriptName . ' ' . $this->ansiFormat($action->getUniqueId(), Console::FG_YELLOW));
    }
    foreach ($controller->getActionArgsHelp($action) as $name => $arg) {
        if ($arg['required']) {
            $this->stdout(' <' . $name . '>', Console::FG_CYAN);
        } else {
            $this->stdout(' [' . $name . ']', Console::FG_CYAN);
        }
    }
    $this->stdout("\n");
}

            
actions() 公共方法

定义于: yii\base\Controller::actions()

声明控制器的外部操作。

此方法旨在被覆盖以声明控制器的外部操作。它应该返回一个数组,数组键是操作 ID,数组值是相应的操作类名或操作配置数组。例如,

return [
    'action1' => 'app\components\Action1',
    'action2' => [
        'class' => 'app\components\Action2',
        'property1' => 'value1',
        'property2' => 'value2',
    ],
];

Yii::createObject() 将稍后用于使用此处提供的配置创建请求的操作。

public array actions ( )

                public function actions()
{
    return [];
}

            
afterAction() 公共方法

定义于: yii\base\Controller::afterAction()

此方法在执行操作后立即调用。

该方法将触发 EVENT_AFTER_ACTION 事件。该方法的返回值将用作操作返回值。

如果您覆盖此方法,您的代码应如下所示

public function afterAction($action, $result)
{
    $result = parent::afterAction($action, $result);
    // your custom code here
    return $result;
}
public mixed afterAction ( $action, $result )
$action yii\base\Action

刚刚执行的操作。

$result mixed

操作返回结果。

返回值 mixed

处理后的操作结果。

                public function afterAction($action, $result)
{
    $event = new ActionEvent($action);
    $event->result = $result;
    $this->trigger(self::EVENT_AFTER_ACTION, $event);
    return $event->result;
}

            
ansiFormat() 公共方法

定义于: yii\console\Controller::ansiFormat()

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

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

示例

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

要格式化的字符串

                public function ansiFormat($string)
{
    if ($this->isColorEnabled()) {
        $args = func_get_args();
        array_shift($args);
        $string = Console::ansiFormat($string, $args);
    }
    return $string;
}

            
attachBehavior() 公共方法

定义于: yii\base\Component::attachBehavior()

将行为附加到此组件。

此方法将根据给定的配置创建行为对象。之后,行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。

另请参见 detachBehavior().

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行为的名称。

$behavior string|array|yii\base\Behavior

行为配置。可以是以下之一

返回值 yii\base\Behavior

行为对象

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() 公共方法

定义于: yii\base\Component::attachBehaviors()

将行为列表附加到组件。

每个行为都由其名称索引,并且应该是 yii\base\Behavior 对象,指定行为类的字符串,或者用于创建行为的配置数组。

另请参见 attachBehavior().

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到组件的行为列表

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
beforeAction() 公共方法

定义于: yii\console\Controller::beforeAction()

此方法在执行操作之前立即调用。

该方法将触发 EVENT_BEFORE_ACTION 事件。该方法的返回值将确定操作是否应该继续运行。

如果操作不应该运行,则应该在 beforeAction 代码中处理请求,方法是提供必要的输出或重定向请求。否则,响应将为空。

如果您覆盖此方法,您的代码应如下所示

public function beforeAction($action)
{
    // your custom code here, if you want the code to run before action filters,
    // which are triggered on the [[EVENT_BEFORE_ACTION]] event, e.g. PageCache or AccessControl

    if (!parent::beforeAction($action)) {
        return false;
    }

    // other custom code here

    return true; // or false to not run the action
}
public boolean beforeAction ( $action )
$action yii\base\Action

要执行的操作。

返回值 boolean

操作是否应该继续运行。

                public function beforeAction($action)
{
    $silentExit = $this->silentExitOnException !== null ? $this->silentExitOnException : YII_ENV_TEST;
    Yii::$app->errorHandler->silentExitOnException = $silentExit;
    return parent::beforeAction($action);
}

            
behaviors() 公共方法

定义于: yii\base\Component::behaviors()

返回此组件应该表现为的行为列表。

子类可以重写此方法来指定它们想要表现出的行为。

此方法的返回值应为行为对象或配置的数组,这些对象或配置以行为名称为索引。行为配置可以是指定行为类的字符串,也可以是以下结构的数组

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

请注意,行为类必须扩展自 yii\base\Behavior。行为可以使用名称或匿名方式附加。当使用名称作为数组键时,可以使用此名称稍后使用 getBehavior() 获取行为,或使用 detachBehavior() 卸载行为。匿名行为无法检索或卸载。

在此方法中声明的行为将自动附加到组件(按需)。

public array behaviors ( )
返回值 array

行为配置。

                public function behaviors()
{
    return [];
}

            
bindActionParams() public method

定义于: yii\console\Controller::bindActionParams()

将参数绑定到操作。

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

public array bindActionParams ( $action, $params )
$action yii\base\Action

要与参数绑定的操作

$params array

要绑定到操作的参数

返回值 array

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

抛出 yii\console\Exception

如果存在未知选项或缺少参数

                public function bindActionParams($action, $params)
{
    if ($action instanceof InlineAction) {
        $method = new \ReflectionMethod($this, $action->actionMethod);
    } else {
        $method = new \ReflectionMethod($action, 'run');
    }
    $args = [];
    $missing = [];
    $actionParams = [];
    $requestedParams = [];
    foreach ($method->getParameters() as $i => $param) {
        $name = $param->getName();
        $key = null;
        if (array_key_exists($i, $params)) {
            $key = $i;
        } elseif (array_key_exists($name, $params)) {
            $key = $name;
        }
        if ($key !== null) {
            if (PHP_VERSION_ID >= 80000) {
                $isArray = ($type = $param->getType()) instanceof \ReflectionNamedType && $type->getName() === 'array';
            } else {
                $isArray = $param->isArray();
            }
            if ($isArray) {
                $params[$key] = $params[$key] === '' ? [] : preg_split('/\s*,\s*/', $params[$key]);
            }
            $args[] = $actionParams[$key] = $params[$key];
            unset($params[$key]);
        } elseif (
            PHP_VERSION_ID >= 70100
            && ($type = $param->getType()) !== null
            && $type instanceof \ReflectionNamedType
            && !$type->isBuiltin()
        ) {
            try {
                $this->bindInjectedParams($type, $name, $args, $requestedParams);
            } catch (\yii\base\Exception $e) {
                throw new Exception($e->getMessage());
            }
        } elseif ($param->isDefaultValueAvailable()) {
            $args[] = $actionParams[$i] = $param->getDefaultValue();
        } else {
            $missing[] = $name;
        }
    }
    if (!empty($missing)) {
        throw new Exception(Yii::t('yii', 'Missing required arguments: {params}', ['params' => implode(', ', $missing)]));
    }
    // We use a different array here, specifically one that doesn't contain service instances but descriptions instead.
    if (\Yii::$app->requestedParams === null) {
        \Yii::$app->requestedParams = array_merge($actionParams, $requestedParams);
    }
    return array_merge($args, $params);
}

            
bindInjectedParams() protected method (available since version 2.0.36)

定义于: yii\base\Controller::bindInjectedParams()

根据操作方法签名中的类型和名称填充参数。

protected void bindInjectedParams ( ReflectionType $type, $name, &$args, &$requestedParams )
$type ReflectionType

操作参数的反射类型。

$name string

参数的名称。

$args array

操作的参数数组,此函数可能会向其中追加项目。

$requestedParams array

包含请求参数的数组,此函数可能会写入其中的特定键。

抛出 yii\base\ErrorException

当我们无法加载所需的服務時。

抛出 yii\base\InvalidConfigException

在 DI 配置中出现错误时抛出。

抛出 yii\di\NotInstantiableException

在没有容器中适当定义的情况下,定义无法解析为具体类(例如接口类型提示)时抛出。

                final protected function bindInjectedParams(\ReflectionType $type, $name, &$args, &$requestedParams)
{
    // Since it is not a builtin type it must be DI injection.
    $typeName = $type->getName();
    if (($component = $this->module->get($name, false)) instanceof $typeName) {
        $args[] = $component;
        $requestedParams[$name] = 'Component: ' . get_class($component) . " \$$name";
    } elseif ($this->module->has($typeName) && ($service = $this->module->get($typeName)) instanceof $typeName) {
        $args[] = $service;
        $requestedParams[$name] = 'Module ' . get_class($this->module) . " DI: $typeName \$$name";
    } elseif (\Yii::$container->has($typeName) && ($service = \Yii::$container->get($typeName)) instanceof $typeName) {
        $args[] = $service;
        $requestedParams[$name] = "Container DI: $typeName \$$name";
    } elseif ($type->allowsNull()) {
        $args[] = null;
        $requestedParams[$name] = "Unavailable service: $name";
    } else {
        throw new Exception('Could not load required service: ' . $name);
    }
}

            
canGetProperty() public method

定义于: yii\base\Component::canGetProperty()

返回一个值,指示是否可以读取属性。

如果可以读取属性

  • 该类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
  • 该类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可读属性(当 $checkBehaviors 为 true 时)。

另请参阅 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否可以读取

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() public method

定义于: yii\base\Component::canSetProperty()

返回一个值,指示是否可以设置属性。

如果可以写入属性

  • 该类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
  • 该类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可写属性(当 $checkBehaviors 为 true 时)。

另请参阅 canGetProperty()

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否可以写入

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() public static method
自 2.0.14 起弃用。在 PHP >=5.5 上,使用 ::class 代替。

定义于: yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回值 string

此类的完全限定名称。

                public static function className()
{
    return get_called_class();
}

            
confirm() public method

定义于: yii\console\Controller::confirm()

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

典型的用法如下

if ($this->confirm("Are you sure?")) {
    echo "user typed yes\n";
} else {
    echo "user typed no\n";
}
public boolean confirm ( $message, $default false )
$message string

在等待用户输入之前回显出来

$default boolean

如果没有进行选择,则返回此值。

返回值 boolean

用户是否确认。如果 $interactive 为 false,则返回 true。

                public function confirm($message, $default = false)
{
    if ($this->interactive) {
        return Console::confirm($message, $default);
    }
    return true;
}

            
createAction() public method

定义于: yii\base\Controller::createAction()

根据给定的操作 ID 创建操作。

该方法首先检查操作 ID 是否已在 actions() 中声明。如果是,它将使用其中声明的配置来创建操作对象。如果不是,它将查找名称格式为 actionXyz 的控制器方法,其中 xyz 是操作 ID。如果找到,将创建一个表示该方法的 yii\base\InlineAction 并返回。

public yii\base\Action|null createAction ( $id )
$id string

操作 ID。

返回值 yii\base\Action|null

新创建的操作实例。如果 ID 未解析为任何操作,则为 null。

                public function createAction($id)
{
    if ($id === '') {
        $id = $this->defaultAction;
    }
    $actionMap = $this->actions();
    if (isset($actionMap[$id])) {
        return Yii::createObject($actionMap[$id], [$id, $this]);
    }
    if (preg_match('/^(?:[a-z0-9_]+-)*[a-z0-9_]+$/', $id)) {
        $methodName = 'action' . str_replace(' ', '', ucwords(str_replace('-', ' ', $id)));
        if (method_exists($this, $methodName)) {
            $method = new \ReflectionMethod($this, $methodName);
            if ($method->isPublic() && $method->getName() === $methodName) {
                return new InlineAction($id, $this, $methodName);
            }
        }
    }
    return null;
}

            
detachBehavior() public method

定义于: yii\base\Component::detachBehavior()

从组件中分离行为。

行为的 yii\base\Behavior::detach() 方法将被调用。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行为的名称。

返回值 yii\base\Behavior|null

分离的行为。如果行为不存在,则为 null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() 公共方法

定义于: yii\base\Component::detachBehaviors()

从组件中分离所有行为。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() 公共方法

定义于: yii\base\Component::ensureBehaviors()

确保在 behaviors() 中声明的行为附加到此组件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
findLayoutFile() 公共方法

定义于: yii\base\Controller::findLayoutFile()

查找适用的布局文件。

public string|boolean findLayoutFile ( $view )
$view yii\base\View

要渲染布局文件的视图对象。

返回值 string|boolean

布局文件路径,如果不需要布局,则为 false。有关如何指定此参数的详细信息,请参阅 render()

抛出 yii\base\InvalidArgumentException

如果使用无效的路径别名来指定布局。

                public function findLayoutFile($view)
{
    $module = $this->module;
    $layout = null;
    if (is_string($this->layout)) {
        $layout = $this->layout;
    } elseif ($this->layout === null) {
        while ($module !== null && $module->layout === null) {
            $module = $module->module;
        }
        if ($module !== null && is_string($module->layout)) {
            $layout = $module->layout;
        }
    }
    if ($layout === null) {
        return false;
    }
    if (strncmp($layout, '@', 1) === 0) {
        $file = Yii::getAlias($layout);
    } elseif (strncmp($layout, '/', 1) === 0) {
        $file = Yii::$app->getLayoutPath() . DIRECTORY_SEPARATOR . substr($layout, 1);
    } else {
        $file = $module->getLayoutPath() . DIRECTORY_SEPARATOR . $layout;
    }
    if (pathinfo($file, PATHINFO_EXTENSION) !== '') {
        return $file;
    }
    $path = $file . '.' . $view->defaultExtension;
    if ($view->defaultExtension !== 'php' && !is_file($path)) {
        $path = $file . '.php';
    }
    return $path;
}

            
formatOptionAliases() 受保护方法 (自版本 2.0.8 起可用)

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

控制器实例

$option string

选项名称

返回值 string

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

                protected function formatOptionAliases($controller, $option)
{
    foreach ($controller->optionAliases() as $name => $value) {
        if (Inflector::camel2id($value, '-', true) === $option) {
            return ', -' . $name;
        }
    }
    return '';
}

            
formatOptionHelp() 受保护方法

为参数或选项生成格式良好的字符串。

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

参数或选项的名称

$required boolean

参数是否必需

$type string

选项或参数的类型

$defaultValue mixed

选项或参数的默认值

$comment string

关于选项或参数的注释

返回值 string

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

                protected function formatOptionHelp($name, $required, $type, $defaultValue, $comment)
{
    $comment = trim((string)$comment);
    $type = trim((string)$type);
    if (strncmp($type, 'bool', 4) === 0) {
        $type = 'boolean, 0 or 1';
    }
    if ($defaultValue !== null && !is_array($defaultValue)) {
        if ($type === null) {
            $type = gettype($defaultValue);
        }
        if (is_bool($defaultValue)) {
            // show as integer to avoid confusion
            $defaultValue = (int) $defaultValue;
        }
        if (is_string($defaultValue)) {
            $defaultValue = "'" . $defaultValue . "'";
        } else {
            $defaultValue = var_export($defaultValue, true);
        }
        $doc = "$type (defaults to $defaultValue)";
    } else {
        $doc = $type;
    }
    if ($doc === '') {
        $doc = $comment;
    } elseif ($comment !== '') {
        $doc .= "\n" . preg_replace('/^/m', '  ', $comment);
    }
    $name = $required ? "$name (required)" : $name;
    return $doc === '' ? $name : "$name: $doc";
}

            
getActionArgsHelp() 公共方法

定义于: yii\console\Controller::getActionArgsHelp()

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

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

  • required: bool, 此参数是否必需
  • type: string|null, 此参数的 PHP 类型(s)
  • default: mixed, 此参数的默认值
  • comment: string, 此参数的描述

默认实现将返回从与操作方法相对应的参数的 Reflection 或 DocBlock 中提取的帮助信息。

public array getActionArgsHelp ( $action )
$action yii\base\Action

操作实例

返回值 array

操作参数的帮助信息

                public function getActionArgsHelp($action)
{
    $method = $this->getActionMethodReflection($action);
    $tags = $this->parseDocCommentTags($method);
    $tags['param'] = isset($tags['param']) ? (array) $tags['param'] : [];
    $phpDocParams = [];
    foreach ($tags['param'] as $i => $tag) {
        if (preg_match('/^(?<type>\S+)(\s+\$(?<name>\w+))?(?<comment>.*)/us', $tag, $matches) === 1) {
            $key = empty($matches['name']) ? $i : $matches['name'];
            $phpDocParams[$key] = ['type' => $matches['type'], 'comment' => $matches['comment']];
        }
    }
    unset($tags);
    $args = [];
    /** @var \ReflectionParameter $parameter */
    foreach ($method->getParameters() as $i => $parameter) {
        $type = null;
        $comment = '';
        if (PHP_MAJOR_VERSION > 5 && $parameter->hasType()) {
            $reflectionType = $parameter->getType();
            if (PHP_VERSION_ID >= 70100) {
                $types = method_exists($reflectionType, 'getTypes') ? $reflectionType->getTypes() : [$reflectionType];
                foreach ($types as $key => $reflectionType) {
                    $types[$key] = $reflectionType->getName();
                }
                $type = implode('|', $types);
            } else {
                $type = (string) $reflectionType;
            }
        }
        // find PhpDoc tag by property name or position
        $key = isset($phpDocParams[$parameter->name]) ? $parameter->name : (isset($phpDocParams[$i]) ? $i : null);
        if ($key !== null) {
            $comment = $phpDocParams[$key]['comment'];
            if ($type === null && !empty($phpDocParams[$key]['type'])) {
                $type = $phpDocParams[$key]['type'];
            }
        }
        // if type still not detected, then using type of default value
        if ($type === null && $parameter->isDefaultValueAvailable() && $parameter->getDefaultValue() !== null) {
            $type = gettype($parameter->getDefaultValue());
        }
        $args[$parameter->name] = [
            'required' => !$parameter->isOptional(),
            'type' => $type,
            'default' => $parameter->isDefaultValueAvailable() ? $parameter->getDefaultValue() : null,
            'comment' => $comment,
        ];
    }
    return $args;
}

            
getActionHelp() 公共方法

定义于: yii\console\Controller::getActionHelp()

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

public string getActionHelp ( $action )
$action yii\base\Action

要获取帮助的操作

返回值 string

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

                public function getActionHelp($action)
{
    return $this->parseDocCommentDetail($this->getActionMethodReflection($action));
}

            
getActionHelpSummary() 公共方法

定义于: yii\console\Controller::getActionHelpSummary()

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

public string getActionHelpSummary ( $action )
$action yii\base\Action

要获取摘要的操作

返回值 string

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

                public function getActionHelpSummary($action)
{
    if ($action === null) {
        return $this->ansiFormat(Yii::t('yii', 'Action not found.'), Console::FG_RED);
    }
    return $this->parseDocCommentSummary($this->getActionMethodReflection($action));
}

            
getActionMethodReflection() 受保护方法
protected ReflectionFunctionAbstract getActionMethodReflection ( $action )
$action yii\base\Action

                protected function getActionMethodReflection($action)
{
    if (!isset($this->_reflections[$action->id])) {
        if ($action instanceof InlineAction) {
            $this->_reflections[$action->id] = new \ReflectionMethod($this, $action->actionMethod);
        } else {
            $this->_reflections[$action->id] = new \ReflectionMethod($action, 'run');
        }
    }
    return $this->_reflections[$action->id];
}

            
getActionOptionsHelp() 公共方法

定义于: yii\console\Controller::getActionOptionsHelp()

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

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

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

默认实现将返回从与操作选项相对应的属性的文档注释中提取的帮助信息。

public array getActionOptionsHelp ( $action )
$action yii\base\Action
返回值 array

操作选项的帮助信息

                public function getActionOptionsHelp($action)
{
    $optionNames = $this->options($action->id);
    if (empty($optionNames)) {
        return [];
    }
    $class = new \ReflectionClass($this);
    $options = [];
    foreach ($class->getProperties() as $property) {
        $name = $property->getName();
        if (!in_array($name, $optionNames, true)) {
            continue;
        }
        $defaultValue = $property->getValue($this);
        $tags = $this->parseDocCommentTags($property);
        // Display camelCase options in kebab-case
        $name = Inflector::camel2id($name, '-', true);
        if (isset($tags['var']) || isset($tags['property'])) {
            $doc = isset($tags['var']) ? $tags['var'] : $tags['property'];
            if (is_array($doc)) {
                $doc = reset($doc);
            }
            if (preg_match('/^(\S+)(.*)/s', $doc, $matches)) {
                $type = $matches[1];
                $comment = $matches[2];
            } else {
                $type = null;
                $comment = $doc;
            }
            $options[$name] = [
                'type' => $type,
                'default' => $defaultValue,
                'comment' => $comment,
            ];
        } else {
            $options[$name] = [
                'type' => null,
                'default' => $defaultValue,
                'comment' => '',
            ];
        }
    }
    return $options;
}

            
getActions() 公共方法

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

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

控制器实例

返回值 array

所有可用的操作 ID。

                public function getActions($controller)
{
    $actions = array_keys($controller->actions());
    $class = new \ReflectionClass($controller);
    foreach ($class->getMethods() as $method) {
        $name = $method->getName();
        if ($name !== 'actions' && $method->isPublic() && !$method->isStatic() && strncmp($name, 'action', 6) === 0) {
            $actions[] = $this->camel2id(substr($name, 6));
        }
    }
    sort($actions);
    return array_unique($actions);
}

            
getBehavior() 公共方法

定义于: yii\base\Component::getBehavior()

返回命名的行为对象。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行为名称

返回值 yii\base\Behavior|null

行为对象,如果行为不存在,则为 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() public method

定义于: yii\base\Component::getBehaviors()

返回附加到此组件的所有行为。

public yii\base\Behavior[] getBehaviors ( )
返回值 yii\base\Behavior[]

附加到此组件的行为列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getCommandDescriptions() protected method

返回命令及其描述的数组。

protected array getCommandDescriptions ( )
返回值 array

所有可用命令,以键值对形式存储,键为命令名称,值为命令描述。

                protected function getCommandDescriptions()
{
    $descriptions = [];
    foreach ($this->getCommands() as $command) {
        $result = Yii::$app->createController($command);
        /** @var Controller $controller */
        list($controller, $actionID) = $result;
        $descriptions[$command] = $controller->getHelpSummary();
    }
    return $descriptions;
}

            
getCommandHelp() protected method

显示命令的总体信息。

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

控制器实例

                protected function getCommandHelp($controller)
{
    $controller->color = $this->color;
    $this->stdout("\nDESCRIPTION\n", Console::BOLD);
    $comment = $controller->getHelp();
    if ($comment !== '') {
        $this->stdout("\n$comment\n\n");
    }
    $actions = $this->getActions($controller);
    if (!empty($actions)) {
        $this->stdout("\nSUB-COMMANDS\n\n", Console::BOLD);
        $prefix = $controller->getUniqueId();
        $maxlen = 5;
        foreach ($actions as $action) {
            $len = strlen($prefix . '/' . $action) + 2 + ($action === $controller->defaultAction ? 10 : 0);
            $maxlen = max($maxlen, $len);
        }
        foreach ($actions as $action) {
            $this->stdout('- ' . $this->ansiFormat($prefix . '/' . $action, Console::FG_YELLOW));
            $len = strlen($prefix . '/' . $action) + 2;
            if ($action === $controller->defaultAction) {
                $this->stdout(' (default)', Console::FG_GREEN);
                $len += 10;
            }
            $summary = $controller->getActionHelpSummary($controller->createAction($action));
            if ($summary !== '') {
                $this->stdout(str_repeat(' ', $maxlen - $len + 2) . Console::wrapText($summary, $maxlen + 2));
            }
            $this->stdout("\n");
        }
        $scriptName = $this->getScriptName();
        $this->stdout("\nTo see the detailed information about individual sub-commands, enter:\n");
        $this->stdout("\n  $scriptName " . $this->ansiFormat('help', Console::FG_YELLOW) . ' '
            . $this->ansiFormat('<sub-command>', Console::FG_CYAN) . "\n\n");
    }
}

            
getCommands() public method

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

public array getCommands ( )
返回值 array

所有可用的命令名称

                public function getCommands()
{
    $commands = $this->getModuleCommands(Yii::$app);
    sort($commands);
    return array_filter(array_unique($commands), function ($command) {
        $result = Yii::$app->createController($command);
        if ($result === false || !$result[0] instanceof Controller) {
            return false;
        }
        list($controller, $actionID) = $result;
        $actions = $this->getActions($controller);
        return $actions !== [];
    });
}

            
getDefaultHelp() protected method

显示所有可用命令。

protected void getDefaultHelp ( )

                protected function getDefaultHelp()
{
    $commands = $this->getCommandDescriptions();
    $this->stdout($this->getDefaultHelpHeader());
    if (empty($commands)) {
        $this->stdout("\nNo commands are found.\n\n", Console::BOLD);
        return;
    }
    $this->stdout("\nThe following commands are available:\n\n", Console::BOLD);
    $maxLength = 0;
    foreach ($commands as $command => $description) {
        $result = Yii::$app->createController($command);
        /** @var $controller Controller */
        list($controller, $actionID) = $result;
        $actions = $this->getActions($controller);
        $prefix = $controller->getUniqueId();
        foreach ($actions as $action) {
            $string = $prefix . '/' . $action;
            if ($action === $controller->defaultAction) {
                $string .= ' (default)';
            }
            $maxLength = max($maxLength, strlen($string));
        }
    }
    foreach ($commands as $command => $description) {
        $result = Yii::$app->createController($command);
        list($controller, $actionID) = $result;
        $actions = $this->getActions($controller);
        $this->stdout('- ' . $this->ansiFormat($command, Console::FG_YELLOW));
        $this->stdout(str_repeat(' ', $maxLength + 4 - strlen($command)));
        $this->stdout(Console::wrapText($description, $maxLength + 4 + 2), Console::BOLD);
        $this->stdout("\n");
        $prefix = $controller->getUniqueId();
        foreach ($actions as $action) {
            $string = '  ' . $prefix . '/' . $action;
            $this->stdout('  ' . $this->ansiFormat($string, Console::FG_GREEN));
            if ($action === $controller->defaultAction) {
                $string .= ' (default)';
                $this->stdout(' (default)', Console::FG_YELLOW);
            }
            $summary = $controller->getActionHelpSummary($controller->createAction($action));
            if ($summary !== '') {
                $this->stdout(str_repeat(' ', $maxLength + 4 - strlen($string)));
                $this->stdout(Console::wrapText($summary, $maxLength + 4 + 2));
            }
            $this->stdout("\n");
        }
        $this->stdout("\n");
    }
    $scriptName = $this->getScriptName();
    $this->stdout("\nTo see the help of each command, enter:\n", Console::BOLD);
    $this->stdout("\n  $scriptName " . $this->ansiFormat('help', Console::FG_YELLOW) . ' '
        . $this->ansiFormat('<command-name>', Console::FG_CYAN) . "\n\n");
}

            
getDefaultHelpHeader() protected method (available since version 2.0.11)

返回默认帮助标题。

protected string getDefaultHelpHeader ( )
返回值 string

默认帮助头。

                protected function getDefaultHelpHeader()
{
    return "\nThis is Yii version " . \Yii::getVersion() . ".\n";
}

            
getHelp() public method

定义于: yii\console\Controller::getHelp()

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

您可以覆盖此方法以返回自定义帮助。默认实现返回从 PHPDoc 注释中获取的帮助信息。

public string getHelp ( )

                public function getHelp()
{
    return $this->parseDocCommentDetail(new \ReflectionClass($this));
}

            
getHelpSummary() public method

定义于: yii\console\Controller::getHelpSummary()

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

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

public string getHelpSummary ( )

                public function getHelpSummary()
{
    return $this->parseDocCommentSummary(new \ReflectionClass($this));
}

            
getModuleCommands() protected method

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

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

模块实例

返回值 array

可用的命令名称

                protected function getModuleCommands($module)
{
    $prefix = $module instanceof Application ? '' : $module->getUniqueId() . '/';
    $commands = [];
    foreach (array_keys($module->controllerMap) as $id) {
        $commands[] = $prefix . $id;
    }
    foreach ($module->getModules() as $id => $child) {
        if (($child = $module->getModule($id)) === null) {
            continue;
        }
        foreach ($this->getModuleCommands($child) as $command) {
            $commands[] = $command;
        }
    }
    $controllerPath = $module->getControllerPath();
    if (is_dir($controllerPath)) {
        $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($controllerPath, \RecursiveDirectoryIterator::KEY_AS_PATHNAME));
        $iterator = new \RegexIterator($iterator, '/.*Controller\.php$/', \RecursiveRegexIterator::GET_MATCH);
        foreach ($iterator as $matches) {
            $file = $matches[0];
            $relativePath = str_replace($controllerPath, '', $file);
            $class = strtr($relativePath, [
                '/' => '\\',
                '.php' => '',
            ]);
            $controllerClass = $module->controllerNamespace . $class;
            if ($this->validateControllerClass($controllerClass)) {
                $dir = ltrim(pathinfo($relativePath, PATHINFO_DIRNAME), '\\/');
                $command = Inflector::camel2id(substr(basename($file), 0, -14), '-', true);
                if (!empty($dir)) {
                    $command = $dir . '/' . $command;
                }
                $commands[] = $prefix . $command;
            }
        }
    }
    return $commands;
}

            
getModules() public method

定义于: yii\base\Controller::getModules()

返回此控制器的所有祖先模块。

数组中的第一个模块是最外层的(即应用程序实例),而最后一个是最内层的。

public yii\base\Module[] getModules ( )
返回值 yii\base\Module[]

此控制器所在的祖先模块。

                public function getModules()
{
    $modules = [$this->module];
    $module = $this->module;
    while ($module->module !== null) {
        array_unshift($modules, $module->module);
        $module = $module->module;
    }
    return $modules;
}

            
getOptionValues() public method

定义于: yii\console\Controller::getOptionValues()

返回与操作 ID 相对应的属性。子类可以覆盖此方法来指定可能的属性。

public array getOptionValues ( $actionID )
$actionID string

当前请求的动作 ID

返回值 array

与该动作选项相对应的属性

                public function getOptionValues($actionID)
{
    // $actionId might be used in subclasses to provide properties specific to action id
    $properties = [];
    foreach ($this->options($this->action->id) as $property) {
        $properties[$property] = $this->$property;
    }
    return $properties;
}

            
getPassedOptionValues() public method

定义于: yii\console\Controller::getPassedOptionValues()

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

public array getPassedOptionValues ( )
返回值 array

与传递的选项相对应的属性

                public function getPassedOptionValues()
{
    $properties = [];
    foreach ($this->_passedOptions as $property) {
        $properties[$property] = $this->$property;
    }
    return $properties;
}

            
getPassedOptions() public method

定义于: yii\console\Controller::getPassedOptions()

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

public array getPassedOptions ( )
返回值 array

执行过程中传递的选项名称

                public function getPassedOptions()
{
    return $this->_passedOptions;
}

            
getRoute() public method

定义于: yii\base\Controller::getRoute()

返回当前请求的路由。

public string getRoute ( )
返回值 string

当前请求的路由(模块 ID、控制器 ID 和操作 ID)。

                public function getRoute()
{
    return $this->action !== null ? $this->action->getUniqueId() : $this->getUniqueId();
}

            
getScriptName() protected method

protected string getScriptName ( )
返回值 string

当前运行的 CLI 脚本名称。

                protected function getScriptName()
{
    return basename(Yii::$app->request->scriptFile);
}

            
getSubCommandHelp() protected method

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

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

控制器实例

$actionID string

操作 ID

抛出 yii\console\Exception

如果操作不存在

                protected function getSubCommandHelp($controller, $actionID)
{
    $action = $controller->createAction($actionID);
    if ($action === null) {
        $name = $this->ansiFormat(rtrim($controller->getUniqueId() . '/' . $actionID, '/'), Console::FG_YELLOW);
        throw new Exception("No help for unknown sub-command \"$name\".");
    }
    $description = $controller->getActionHelp($action);
    if ($description !== '') {
        $this->stdout("\nDESCRIPTION\n", Console::BOLD);
        $this->stdout("\n$description\n\n");
    }
    $this->stdout("\nUSAGE\n\n", Console::BOLD);
    $scriptName = $this->getScriptName();
    if ($action->id === $controller->defaultAction) {
        $this->stdout($scriptName . ' ' . $this->ansiFormat($controller->getUniqueId(), Console::FG_YELLOW));
    } else {
        $this->stdout($scriptName . ' ' . $this->ansiFormat($action->getUniqueId(), Console::FG_YELLOW));
    }
    $args = $controller->getActionArgsHelp($action);
    foreach ($args as $name => $arg) {
        if ($arg['required']) {
            $this->stdout(' <' . $name . '>', Console::FG_CYAN);
        } else {
            $this->stdout(' [' . $name . ']', Console::FG_CYAN);
        }
    }
    $options = $controller->getActionOptionsHelp($action);
    $options[\yii\console\Application::OPTION_APPCONFIG] = [
        'type' => 'string',
        'default' => null,
        'comment' => "custom application configuration file path.\nIf not set, default application configuration is used.",
    ];
    ksort($options);
    if (!empty($options)) {
        $this->stdout(' [...options...]', Console::FG_RED);
    }
    $this->stdout("\n\n");
    if (!empty($args)) {
        foreach ($args as $name => $arg) {
            $this->stdout($this->formatOptionHelp(
                '- ' . $this->ansiFormat($name, Console::FG_CYAN),
                $arg['required'],
                $arg['type'],
                $arg['default'],
                $arg['comment']
            ) . "\n\n");
        }
    }
    if (!empty($options)) {
        $this->stdout("\nOPTIONS\n\n", Console::BOLD);
        foreach ($options as $name => $option) {
            $this->stdout($this->formatOptionHelp(
                $this->ansiFormat(
                    '--' . $name . $this->formatOptionAliases($controller, $name),
                    Console::FG_RED,
                    empty($option['required']) ? Console::FG_RED : Console::BOLD
                ),
                !empty($option['required']),
                $option['type'],
                $option['default'],
                $option['comment']
            ) . "\n\n");
        }
    }
}

            
getUniqueId() public method

Defined in: yii\base\Controller::getUniqueId()

返回控制器的唯一 ID。

public string getUniqueId ( )
返回值 string

控制器 ID,以模块 ID(如果有)为前缀。

                public function getUniqueId()
{
    return $this->module instanceof Application ? $this->id : $this->module->getUniqueId() . '/' . $this->id;
}

            
getView() public method

Defined in: yii\base\Controller::getView()

返回可用于渲染视图或视图文件的视图对象。

render()renderPartial()renderFile() 方法将使用此视图对象来实现实际的视图渲染。如果未设置,它将默认为“view”应用程序组件。

public yii\base\View|yii\web\View getView ( )
返回值 yii\base\View|yii\web\View

可用于渲染视图或视图文件的视图对象。

                public function getView()
{
    if ($this->_view === null) {
        $this->_view = Yii::$app->getView();
    }
    return $this->_view;
}

            
getViewPath() public method

Defined in: yii\base\Controller::getViewPath()

返回包含此控制器视图文件的目录。

默认实现返回 $module$viewPath 目录下名为控制器 $id 的目录。

public string getViewPath ( )
返回值 string

包含此控制器视图文件的目录。

                public function getViewPath()
{
    if ($this->_viewPath === null) {
        $this->_viewPath = $this->module->getViewPath() . DIRECTORY_SEPARATOR . $this->id;
    }
    return $this->_viewPath;
}

            
hasEventHandlers() public method

Defined in: yii\base\Component::hasEventHandlers()

返回一个值,指示是否有任何处理程序附加到命名的事件。

public boolean hasEventHandlers ( $name )
$name string

事件名称

返回值 boolean

事件是否已附加任何处理程序。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public method

Defined in: yii\base\Component::hasMethod()

返回一个值,指示是否定义了方法。

方法定义如果

  • 该类具有具有指定名称的方法
  • 附加的行为具有具有给定名称的方法(当 $checkBehaviors 为 true 时)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

属性名称

$checkBehaviors boolean

是否将行为的方法视为此组件的方法

返回值 boolean

该方法是否已定义

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public method

Defined in: yii\base\Component::hasProperty()

返回一个值,指示是否为此组件定义了属性。

属性定义如果

  • 该类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
  • 该类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的属性(当 $checkBehaviors 为 true 时)。

另请参阅

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

该属性是否已定义

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() public method (available since version 2.0.36)

Defined in: yii\base\Controller::init()

初始化对象。

此方法在对象使用给定配置初始化后在构造函数结束时调用。

public void init ( )

                public function init()
{
    parent::init();
    $this->request = Instance::ensure($this->request, Request::className());
    $this->response = Instance::ensure($this->response, Response::className());
}

            
isColorEnabled() public method

Defined in: yii\console\Controller::isColorEnabled()

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

仅当 $color 设置为 true 或未设置且终端支持 ANSI 颜色时,才会启用 ANSI 颜色。

public boolean isColorEnabled ( $stream = \STDOUT )
$stream resource

要检查的流。

返回值 boolean

是否在输出中启用 ANSI 样式。

                public function isColorEnabled($stream = \STDOUT)
{
    return $this->color === null ? Console::streamSupportsAnsiColors($stream) : $this->color;
}

            
off() public method

Defined in: yii\base\Component::off()

从该组件中分离现有的事件处理程序。

此方法与 on() 相反。

注意:如果传递事件名称的通配符模式,则只会删除使用此通配符注册的处理程序,而使用与此通配符匹配的普通名称注册的处理程序将保留。

另请参阅 on()

public boolean off ( $name, $handler null )
$name string

事件名称

$handler callable|null

要删除的事件处理程序。如果为 null,将删除附加到命名事件的所有处理程序。

返回值 boolean

如果找到处理程序并分离

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() public method

Defined in: yii\base\Component::on()

将事件处理程序附加到事件。

事件处理程序必须是有效的 PHP 回调。以下是一些示例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件处理程序必须使用以下签名定义,

function ($event)

其中$event是一个yii\base\Event对象,其中包含与事件相关的参数。

从 2.0.14 开始,您可以将事件名称指定为通配符模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另请参见 off()

public void on ( $name, $handler, $data null, $append true )
$name string

事件名称

$handler callable

事件处理程序

$data mixed

触发事件时传递给事件处理程序的数据。当调用事件处理程序时,可以通过 yii\base\Event::$data 访问此数据。

$append boolean

是否将新的事件处理程序追加到现有处理程序列表的末尾。如果为 false,则新的处理程序将插入现有处理程序列表的开头。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
optionAliases() 公共方法 (自版本 2.0.8 起可用)

定义于: yii\console\Controller::optionAliases()

返回选项别名名称。

子类可以覆盖此方法以指定别名选项。

另请参见 options()

public array optionAliases ( )
返回值 array

对操作有效的选项别名,其中键是选项的别名,值是选项名称。

                public function optionAliases()
{
    return [
        'h' => 'help',
    ];
}

            
options() 公共方法

定义于: yii\console\Controller::options()

返回操作(id)的有效选项名称。选项需要存在一个名称为选项名称的公共成员变量。

子类可以覆盖此方法以指定可能的选项。

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

public string[] options ( $actionID )
$actionID string

当前请求的动作 ID

返回值 string[]

对操作有效的选项名称

                public function options($actionID)
{
    // $actionId might be used in subclasses to provide options specific to action id
    return ['color', 'interactive', 'help', 'silentExitOnException'];
}

            
parseDocCommentDetail() 受保护方法

定义于: yii\console\Controller::parseDocCommentDetail()

从 docblock 返回完整描述。

protected string parseDocCommentDetail ( $reflection )
$reflection ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract

                protected function parseDocCommentDetail($reflection)
{
    $comment = strtr(trim(preg_replace('/^\s*\**([ \t])?/m', '', trim($reflection->getDocComment(), '/'))), "\r", '');
    if (preg_match('/^\s*@\w+/m', $comment, $matches, PREG_OFFSET_CAPTURE)) {
        $comment = trim(substr($comment, 0, $matches[0][1]));
    }
    if ($comment !== '') {
        return rtrim(Console::renderColoredString(Console::markdownToAnsi($comment)));
    }
    return '';
}

            
parseDocCommentSummary() 受保护方法

定义于: yii\console\Controller::parseDocCommentSummary()

返回 docblock 的第一行。

protected string parseDocCommentSummary ( $reflection )
$reflection ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract

                protected function parseDocCommentSummary($reflection)
{
    $docLines = preg_split('~\R~u', $reflection->getDocComment());
    if (isset($docLines[1])) {
        return trim($docLines[1], "\t *");
    }
    return '';
}

            
parseDocCommentTags() 受保护方法

定义于: yii\console\Controller::parseDocCommentTags()

将注释块解析为标签。

protected array parseDocCommentTags ( $reflection )
$reflection ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract

注释块

返回值 array

解析的标签

                protected function parseDocCommentTags($reflection)
{
    $comment = $reflection->getDocComment();
    $comment = "@description \n" . strtr(trim(preg_replace('/^\s*\**([ \t])?/m', '', trim($comment, '/'))), "\r", '');
    $parts = preg_split('/^\s*@/m', $comment, -1, PREG_SPLIT_NO_EMPTY);
    $tags = [];
    foreach ($parts as $part) {
        if (preg_match('/^(\w+)(.*)/ms', trim($part), $matches)) {
            $name = $matches[1];
            if (!isset($tags[$name])) {
                $tags[$name] = trim($matches[2]);
            } elseif (is_array($tags[$name])) {
                $tags[$name][] = trim($matches[2]);
            } else {
                $tags[$name] = [$tags[$name], trim($matches[2])];
            }
        }
    }
    return $tags;
}

            
prompt() 公共方法

定义于: yii\console\Controller::prompt()

提示用户输入并进行验证。

public string prompt ( $text, $options = [] )
$text string

提示字符串

$options array

验证输入的选项

  • required:是否为必需
  • default:如果用户没有插入输入,则为默认值
  • pattern:验证用户输入的正则表达式模式
  • validator:一个可调用函数来验证输入。该函数必须接受两个参数
    • $input:要验证的用户输入
    • $error:如果验证失败,则通过引用传递的错误值。

有关如何使用带有验证器函数的 prompt 方法的示例。

$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;
}]);
返回值 string

用户输入

                public function prompt($text, $options = [])
{
    if ($this->interactive) {
        return Console::prompt($text, $options);
    }
    return isset($options['default']) ? $options['default'] : '';
}

            
render() 公共方法

定义于: yii\base\Controller::render()

渲染视图,并在可用时应用布局。

要渲染的视图可以以下列格式之一指定

  • 路径别名(例如“@app/views/site/index”);
  • 应用程序中的绝对路径(例如“//site/index”):视图名称以双斜杠开头。实际的视图文件将在应用程序的 视图路径 下查找。
  • 模块中的绝对路径(例如“/site/index”):视图名称以单个斜杠开头。实际的视图文件将在 视图路径$module 下查找。
  • 相对路径(例如“index”):实际的视图文件将在 $viewPath 下查找。

为了确定应该应用哪个布局,将执行以下两个步骤

  1. 在第一步中,它确定布局名称和上下文模块
  • 如果 $layout 指定为字符串,则将其用作布局名称,并将 $module 用作上下文模块;
  • 如果 $layout 为 null,则遍历此控制器的所有祖先模块,并找到第一个 layout 不为 null 的模块。布局和相应的模块分别用作布局名称和上下文模块。如果没有找到这样的模块,或者相应的布局不是字符串,它将返回 false,这意味着没有适用的布局。
  1. 在第二步中,它根据之前找到的布局名称和上下文模块确定实际的布局文件。布局名称可以是
  • 路径别名(例如“@app/views/layouts/main”);
  • 绝对路径(例如“/main”):布局名称以斜杠开头。实际的布局文件将在应用程序的 布局路径 下查找;
  • 相对路径(例如“main”):实际的布局文件将在上下文模块的 布局路径 下查找。

如果布局名称不包含文件扩展名,它将使用默认扩展名.php

public string render ( $view, $params = [] )
$view string

视图名称。

$params array

应该在视图中可用的参数(名称-值对)。这些参数在布局中不可用。

返回值 string

渲染结果。

抛出 yii\base\InvalidArgumentException

如果视图文件或布局文件不存在。

                public function render($view, $params = [])
{
    $content = $this->getView()->render($view, $params, $this);
    return $this->renderContent($content);
}

            
renderContent() 公共方法 (自版本 2.0.1 起可用)

定义于: yii\base\Controller::renderContent()

通过应用布局渲染静态字符串。

public string renderContent ( $content )
$content string

正在渲染的静态字符串

返回值 string

使用给定静态字符串作为$content变量的布局的渲染结果。如果布局被禁用,则将返回字符串。

                public function renderContent($content)
{
    $layoutFile = $this->findLayoutFile($this->getView());
    if ($layoutFile !== false) {
        return $this->getView()->renderFile($layoutFile, ['content' => $content], $this);
    }
    return $content;
}

            
renderFile() 公共方法

定义于: yii\base\Controller::renderFile()

渲染视图文件。

public string renderFile ( $file, $params = [] )
$file string

要渲染的视图文件。这可以是文件路径或 路径别名

$params array

应该在视图中提供的参数(名称-值对)。

返回值 string

渲染结果。

抛出 yii\base\InvalidArgumentException

如果视图文件不存在。

                public function renderFile($file, $params = [])
{
    return $this->getView()->renderFile($file, $params, $this);
}

            
renderPartial() 公共方法

定义于: yii\base\Controller::renderPartial()

渲染视图,不应用布局。

此方法与 render() 不同之处在于它不应用任何布局。

public string renderPartial ( $view, $params = [] )
$view string

视图名称。请参考 render() 关于如何指定视图名称。

$params array

应该在视图中提供的参数(名称-值对)。

返回值 string

渲染结果。

抛出 yii\base\InvalidArgumentException

如果视图文件不存在。

                public function renderPartial($view, $params = [])
{
    return $this->getView()->render($view, $params, $this);
}

            
run() 公共方法

定义于: yii\base\Controller::run()

运行根据路由指定的请求。

路由可以是此控制器中操作的 ID,也可以是包含模块 ID、控制器 ID 和操作 ID 的完整路由。如果路由以斜杠 '/' 开头,则路由的解析将从应用程序开始;否则,它将从此控制器的父模块开始。

另见 runAction()

public mixed run ( $route, $params = [] )
$route string

要处理的路由,例如 'view'、'comment/view'、'/admin/comment/view'。

$params array

要传递给操作的参数。

返回值 mixed

操作的结果。

                public function run($route, $params = [])
{
    $pos = strpos($route, '/');
    if ($pos === false) {
        return $this->runAction($route, $params);
    } elseif ($pos > 0) {
        return $this->module->runAction($route, $params);
    }
    return Yii::$app->runAction(ltrim($route, '/'), $params);
}

            
runAction() 公共方法

定义于: yii\console\Controller::runAction()

运行具有指定操作 ID 和参数的操作。

如果操作 ID 为空,则该方法将使用 $defaultAction

另见 createAction()

public integer runAction ( $id, $params = [] )
$id string

要执行的操作的 ID。

$params array

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

返回值 integer

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

抛出 yii\base\InvalidRouteException

如果请求的操作 ID 无法成功解析为操作。

抛出 yii\console\Exception

如果存在未知选项或缺少参数

                public function runAction($id, $params = [])
{
    if (!empty($params)) {
        // populate options here so that they are available in beforeAction().
        $options = $this->options($id === '' ? $this->defaultAction : $id);
        if (isset($params['_aliases'])) {
            $optionAliases = $this->optionAliases();
            foreach ($params['_aliases'] as $name => $value) {
                if (array_key_exists($name, $optionAliases)) {
                    $params[$optionAliases[$name]] = $value;
                } else {
                    $message = Yii::t('yii', 'Unknown alias: -{name}', ['name' => $name]);
                    if (!empty($optionAliases)) {
                        $aliasesAvailable = [];
                        foreach ($optionAliases as $alias => $option) {
                            $aliasesAvailable[] = '-' . $alias . ' (--' . $option . ')';
                        }
                        $message .= '. ' . Yii::t('yii', 'Aliases available: {aliases}', [
                            'aliases' => implode(', ', $aliasesAvailable)
                        ]);
                    }
                    throw new Exception($message);
                }
            }
            unset($params['_aliases']);
        }
        foreach ($params as $name => $value) {
            // Allow camelCase options to be entered in kebab-case
            if (!in_array($name, $options, true) && strpos($name, '-') !== false) {
                $kebabName = $name;
                $altName = lcfirst(Inflector::id2camel($kebabName));
                if (in_array($altName, $options, true)) {
                    $name = $altName;
                }
            }
            if (in_array($name, $options, true)) {
                $default = $this->$name;
                if (is_array($default) && is_string($value)) {
                    $this->$name = preg_split('/\s*,\s*(?![^()]*\))/', $value);
                } elseif ($default !== null) {
                    settype($value, gettype($default));
                    $this->$name = $value;
                } else {
                    $this->$name = $value;
                }
                $this->_passedOptions[] = $name;
                unset($params[$name]);
                if (isset($kebabName)) {
                    unset($params[$kebabName]);
                }
            } elseif (!is_int($name)) {
                $message = Yii::t('yii', 'Unknown option: --{name}', ['name' => $name]);
                if (!empty($options)) {
                    $message .= '. ' . Yii::t('yii', 'Options available: {options}', ['options' => '--' . implode(', --', $options)]);
                }
                throw new Exception($message);
            }
        }
    }
    if ($this->help) {
        $route = $this->getUniqueId() . '/' . $id;
        return Yii::$app->runAction('help', [$route]);
    }
    return parent::runAction($id, $params);
}

            
select() 公共方法

定义于: yii\console\Controller::select()

让用户从选项中选择。输入“?”将显示要选择的选项列表及其说明。

public string select ( $prompt, $options = [], $default null )
$prompt string

提示消息

$options array

要从中选择的选项的键值对数组

$default string|null

用户未提供选项时要使用的值。如果默认值为 null,则用户必须选择一个选项。

返回值 string

用户选择的选项字符

版本 描述
2.0.49 添加了 $default 参数

                public function select($prompt, $options = [], $default = null)
{
    if ($this->interactive) {
        return Console::select($prompt, $options, $default);
    }
    return $default;
}

            
setView() 公共方法

定义于: yii\base\Controller::setView()

设置要由该控制器使用的视图对象。

public void setView ( $view )
$view yii\base\View|yii\web\View

可用于渲染视图或视图文件的视图对象。

                public function setView($view)
{
    $this->_view = $view;
}

            
setViewPath() 公共方法 (自版本 2.0.7 起可用)

定义于: yii\base\Controller::setViewPath()

设置包含视图文件的目录。

public void setViewPath ( $path )
$path string

视图文件的根目录。

抛出 yii\base\InvalidArgumentException

如果目录无效

                public function setViewPath($path)
{
    $this->_viewPath = Yii::getAlias($path);
}

            
stderr() 公共方法

定义于: yii\console\Controller::stderr()

将字符串打印到 STDERR。

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

示例

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

要打印的字符串

返回值 integer|boolean

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

                public function stderr($string)
{
    if ($this->isColorEnabled(\STDERR)) {
        $args = func_get_args();
        array_shift($args);
        $string = Console::ansiFormat($string, $args);
    }
    return fwrite(\STDERR, $string);
}

            
stdout() 公共方法

定义于: yii\console\Controller::stdout()

将字符串打印到 STDOUT。

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

示例

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

要打印的字符串

返回值 integer|boolean

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

                public function stdout($string)
{
    if ($this->isColorEnabled()) {
        $args = func_get_args();
        array_shift($args);
        $string = Console::ansiFormat($string, $args);
    }
    return Console::stdout($string);
}

            
trigger() 公共方法

定义于: yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。它调用事件的所有附加处理程序,包括类级别处理程序。

public void trigger ( $name, yii\base\Event $event null )
$name string

事件名称

$event yii\base\Event|null

事件实例。如果未设置,将创建一个默认的 yii\base\Event 对象。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

            
validateControllerClass() 受保护方法

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

protected boolean validateControllerClass ( $controllerClass )
$controllerClass string

                protected function validateControllerClass($controllerClass)
{
    if (class_exists($controllerClass)) {
        $class = new \ReflectionClass($controllerClass);
        return !$class->isAbstract() && $class->isSubclassOf('yii\console\Controller');
    }
    return false;
}