0 关注者

类 yii\console\controllers\MessageController

继承关系yii\console\controllers\MessageController » 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/MessageController.php

从源文件中提取需要翻译的消息。

提取的消息可以根据配置文件中的 format 设置保存为以下格式:

  • PHP 消息源文件。
  • ".po" 文件。
  • 数据库。

使用方法

  1. 使用 'message/config' 命令创建一个配置文件: yii message/config /path/to/myapp/messages/config.php
  2. 编辑创建的配置文件,根据你的 web 应用需求进行调整。
  3. 运行 'message/extract' 命令,使用创建的配置文件: yii message /path/to/myapp/messages/config.php

公有属性

隐藏继承的属性

属性 类型 描述 定义位置
$action yii\base\Action|null 当前正在执行的操作。 yii\base\Controller
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$catalog string 将用于 "po" 格式翻译的目录名称。 yii\console\controllers\MessageController
$color boolean|null 是否启用输出中的 ANSI 颜色。 yii\console\Controller
$config array 消息提取的配置。 yii\console\controllers\MessageController
$db string "db" 格式的数据库连接组件 ID。 yii\console\controllers\MessageController
$defaultAction string 控制器的默认操作 ID。 yii\console\controllers\MessageController
$except array|null 指定哪些文件/目录不应处理的模式列表。 yii\console\controllers\MessageController
$format string 生成的文件格式。 yii\console\controllers\MessageController
$help boolean 是否显示当前命令的帮助信息。 yii\console\Controller
$helpSummary string yii\console\Controller
$id string 此控制器的 ID。 yii\base\Controller
$ignoreCategories array 要忽略的消息类别。 yii\console\controllers\MessageController
$interactive boolean 是否以交互方式运行命令。 yii\console\Controller
$languages array 必需,提取的消息需要翻译到的语言代码列表。 yii\console\controllers\MessageController
$layout string|null|false 应用于此控制器视图的布局名称。 yii\base\Controller
$markUnused boolean 是否标记源代码中不再出现的消息。 yii\console\controllers\MessageController
$messagePath string 必需,包含消息翻译的根目录。 yii\console\controllers\MessageController
$messageTable string "db" 格式翻译消息表自定义名称。 yii\console\controllers\MessageController
$module yii\base\Module 此控制器所属的模块。 yii\base\Controller
$modules yii\base\Module[] 此控制器所在的祖先模块。 yii\base\Controller
$only array|null 指定哪些文件(而不是目录)应处理的模式列表。 yii\console\controllers\MessageController
$overwrite boolean 是否用合并的消息覆盖消息文件。 yii\console\controllers\MessageController
$passedOptionValues array 传递选项的对应属性。 yii\console\Controller
$passedOptions array 执行过程中传递的选项名称。 yii\console\Controller
$phpDocBlock string|null 在生成 PHP 文件中用于消息数组的 DocBlock。 yii\console\controllers\MessageController
$phpFileHeader string 生成 PHP 文件中的文件头部,包含消息。 yii\console\controllers\MessageController
$removeUnused boolean 是否删除源代码中不再出现的消息。 yii\console\controllers\MessageController
$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
$sort boolean 是否在将新消息与现有消息合并时按键排序消息。 yii\console\controllers\MessageController
$sourceMessageTable string "db" 格式源消息表的自定义名称。 yii\console\controllers\MessageController
$sourcePath string 必需,所有源文件的根目录。 yii\console\controllers\MessageController
$translator string|string[] 用于翻译消息的函数名称。 yii\console\controllers\MessageController
$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() 检查属性是否已设置,即已定义且不为空。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
actionConfig() 使用指定的命令行选项为 "extract" 命令创建一个配置文件。 yii\console\controllers\MessageController
actionConfigTemplate() 为 "extract" 命令创建一个配置文件模板。 yii\console\controllers\MessageController
actionExtract() 从源代码中提取需要翻译的消息。 yii\console\controllers\MessageController
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
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
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\controllers\MessageController
options() 返回操作 (id) 的有效选项名称 选项要求存在一个公共成员变量,其名称是选项名称。 yii\console\controllers\MessageController
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

受保护的方法

隐藏继承的方法

方法 描述 定义位置
bindInjectedParams() 根据动作方法签名中的类型和名称填充参数。 yii\base\Controller
extractMessages() 从文件中提取消息。 yii\console\controllers\MessageController
extractMessagesFromTokens() 从解析的 PHP 令牌列表中提取消息。 yii\console\controllers\MessageController
getActionMethodReflection() yii\console\Controller
getLine() 找到第一个非字符 PHP 令牌的行。 yii\console\controllers\MessageController
initConfig() yii\console\controllers\MessageController
isCategoryIgnored() 该方法检查 $category 是否根据 $ignoreCategories 数组被忽略。 yii\console\controllers\MessageController
parseDocCommentDetail() 从 docblock 返回完整的描述。 yii\console\Controller
parseDocCommentSummary() 返回 docblock 的第一行。 yii\console\Controller
parseDocCommentTags() 将注释块解析为标签。 yii\console\Controller
saveMessagesCategoryToPHP() 将类别消息写入 PHP 文件。 yii\console\controllers\MessageController
saveMessagesToDb() 将消息保存到数据库。 yii\console\controllers\MessageController
saveMessagesToPHP() 将消息写入 PHP 文件。 yii\console\controllers\MessageController
saveMessagesToPO() 将消息写入 PO 文件。 yii\console\controllers\MessageController
saveMessagesToPOT() 将消息写入 POT 文件。 yii\console\controllers\MessageController
tokensEqual() 确定两个 PHP 令牌是否相等。 yii\console\controllers\MessageController

事件

隐藏继承的事件

事件 类型 描述 定义位置
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

属性详细信息

隐藏继承的属性

$catalog 公共属性

将用于 "po" 格式翻译的目录名称。

public string $catalog 'messages'
$config 受保护的属性 (自版本 2.0.13 起可用)

消息提取的配置。

另请参阅

protected array $config null
$db 公共属性

"db" 格式的数据库连接组件 ID。

public string $db 'db'
$defaultAction 公共属性

控制器的默认操作 ID。

public string $defaultAction 'extract'
$except 公共属性

指定哪些文件/目录不应处理的模式列表。如果为空或未设置,将处理所有文件/目录。有关模式匹配规则,请参见 helpers/FileHelper::findFiles() 的说明。如果文件/目录与“only”和“except”中的模式都匹配,则不会进行处理。

public array|null $except = [
    
'.*',
    
'/.*',
    
'/messages',
    
'/tests',
    
'/runtime',
    
'/vendor',
    
'/BaseYii.php',
]
$format 公共属性

生成的 文件格式。可以是 “php”、“db”、“po” 或 “pot”。

public string $format 'php'
$ignoreCategories 公共属性

要忽略的消息类别。例如,“yii”、“app*”、“widgets/menu” 等。

另请参阅 isCategoryIgnored()

$languages 公共属性

必填,要将提取的消息翻译成的语言代码列表。例如,['zh-CN', 'de']。

public array $languages = []
$markUnused 公共属性

是否标记不再出现在源代码中的消息。默认为 true,这意味着每个这样的消息都将用一对 '@@' 标记括起来。

public boolean $markUnused true
$messagePath 公共属性

必需,包含消息翻译的根目录。

public string $messagePath '@yii/messages'
$messageTable 公共属性

"db" 格式翻译消息表自定义名称。

public string $messageTable '{{%message}}'
$only 公共属性

指定哪些文件(不是目录)应该被处理的模式列表。如果为空或未设置,则将处理所有文件。有关模式匹配规则,请参见 helpers/FileHelper::findFiles() 的描述。如果文件/目录同时匹配 "only" 和 "except" 中的模式,则它将不会被处理。

public array|null $only = [
    
'*.php',
]
$overwrite 公共属性

是否用合并的消息覆盖消息文件。

public boolean $overwrite true
$phpDocBlock 公共属性 (从 2.0.13 版本开始可用)

在生成的 PHP 文件中为消息数组使用的 DocBlock。如果为 null,则将使用默认 DocBlock。此属性仅在 $format 为 "php" 时使用。

public string|null $phpDocBlock null
$phpFileHeader 公共属性 (从 2.0.13 版本开始可用)

在生成的包含消息的 PHP 文件中的文件头。此属性仅在 $format 为 "php" 时使用。

public string $phpFileHeader ''
$removeUnused 公共属性

是否删除不再出现在源代码中的消息。默认为 false,这意味着这些消息不会被删除。

public boolean $removeUnused false
$sort 公共属性

是否在将新消息与现有消息合并时按键对消息进行排序。默认为 false,这意味着新的(未翻译的)消息将与旧的(已翻译的)消息分开。

public boolean $sort false
$sourceMessageTable 公共属性

"db" 格式源消息表的自定义名称。

public string $sourceMessageTable '{{%source_message}}'
$sourcePath 公共属性

必需,所有源文件的根目录。

public string $sourcePath '@yii'
$translator 公共属性

用于翻译消息的函数的名称。这用作查找要翻译的消息的标记。您可以使用字符串表示单个函数名,或者使用数组表示多个函数名。

public string|string[] $translator = [
    
'Yii::t',
    
'\Yii::t',
]

方法详情

隐藏继承的方法

__call() public method

定义于: 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() public method

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

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

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

public void __clone ( )

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

            
__construct() public method
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() public method

定义于: 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() public method

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

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

此方法将按照以下顺序检查并相应地采取行动

  • 由 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() public method

定义于: 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() public method

定义于: 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);
}

            
actionConfig() public method

使用指定的命令行选项为 "extract" 命令创建一个配置文件。

生成的配置文件包含源代码消息提取所需的参数。您可以将此配置文件与“extract”命令一起使用。

public integer actionConfig ( $filePath )
$filePath string

输出文件名或别名。

返回值 integer

CLI 退出代码

抛出异常 yii\console\Exception

失败时。

                public function actionConfig($filePath)
{
    $filePath = Yii::getAlias($filePath);
    $dir = dirname($filePath);
    if (file_exists($filePath)) {
        if (!$this->confirm("File '{$filePath}' already exists. Do you wish to overwrite it?")) {
            return ExitCode::OK;
        }
    }
    $array = VarDumper::export($this->getOptionValues($this->action->id));
    $content = <<<EOD
p
onfiguration file for 'yii {$this->id}/{$this->defaultAction}' command.
his file is automatically generated by 'yii {$this->id}/{$this->action->id}' command.
t contains parameters for source code messages extraction.
ou may modify this file to suit your needs.
ou can use 'yii {$this->id}/{$this->action->id}-template' command to create
emplate configuration file with detailed description for each parameter.
rn $array;

    if (FileHelper::createDirectory($dir) === false || file_put_contents($filePath, $content, LOCK_EX) === false) {
        $this->stdout("Configuration file was NOT created: '{$filePath}'.\n\n", Console::FG_RED);
        return ExitCode::UNSPECIFIED_ERROR;
    }
    $this->stdout("Configuration file created: '{$filePath}'.\n\n", Console::FG_GREEN);
    return ExitCode::OK;
}

            
actionConfigTemplate() public method

为 "extract" 命令创建一个配置文件模板。

创建的配置文件包含有关如何对其进行自定义以适应您的需求的详细说明。自定义后,您可以将此配置文件与“extract”命令一起使用。

public integer actionConfigTemplate ( $filePath )
$filePath string

输出文件名或别名。

返回值 integer

CLI 退出代码

抛出异常 yii\console\Exception

失败时。

                public function actionConfigTemplate($filePath)
{
    $filePath = Yii::getAlias($filePath);
    if (file_exists($filePath)) {
        if (!$this->confirm("File '{$filePath}' already exists. Do you wish to overwrite it?")) {
            return ExitCode::OK;
        }
    }
    if (!copy(Yii::getAlias('@yii/views/messageConfig.php'), $filePath)) {
        $this->stdout("Configuration file template was NOT created at '{$filePath}'.\n\n", Console::FG_RED);
        return ExitCode::UNSPECIFIED_ERROR;
    }
    $this->stdout("Configuration file template created at '{$filePath}'.\n\n", Console::FG_GREEN);
    return ExitCode::OK;
}

            
actionExtract() public method

从源代码中提取需要翻译的消息。

此命令将搜索源代码文件并提取需要翻译成不同语言的消息。

public void actionExtract ( $configFile null )
$configFile string|null

配置文件的路径或别名。您可以使用“yii message/config”命令生成此文件,然后根据您的需求进行自定义。

抛出异常 yii\console\Exception

失败时。

                public function actionExtract($configFile = null)
{
    $this->initConfig($configFile);
    $files = FileHelper::findFiles(realpath($this->config['sourcePath']), $this->config);
    $messages = [];
    foreach ($files as $file) {
        $messages = array_merge_recursive($messages, $this->extractMessages($file, $this->config['translator'], $this->config['ignoreCategories']));
    }
    $catalog = isset($this->config['catalog']) ? $this->config['catalog'] : 'messages';
    if (in_array($this->config['format'], ['php', 'po'])) {
        foreach ($this->config['languages'] as $language) {
            $dir = $this->config['messagePath'] . DIRECTORY_SEPARATOR . $language;
            if (!is_dir($dir) && !@mkdir($dir)) {
                throw new Exception("Directory '{$dir}' can not be created.");
            }
            if ($this->config['format'] === 'po') {
                $this->saveMessagesToPO($messages, $dir, $this->config['overwrite'], $this->config['removeUnused'], $this->config['sort'], $catalog, $this->config['markUnused']);
            } else {
                $this->saveMessagesToPHP($messages, $dir, $this->config['overwrite'], $this->config['removeUnused'], $this->config['sort'], $this->config['markUnused']);
            }
        }
    } elseif ($this->config['format'] === 'db') {
        /** @var Connection $db */
        $db = Instance::ensure($this->config['db'], Connection::className());
        $sourceMessageTable = isset($this->config['sourceMessageTable']) ? $this->config['sourceMessageTable'] : '{{%source_message}}';
        $messageTable = isset($this->config['messageTable']) ? $this->config['messageTable'] : '{{%message}}';
        $this->saveMessagesToDb(
            $messages,
            $db,
            $sourceMessageTable,
            $messageTable,
            $this->config['removeUnused'],
            $this->config['languages'],
            $this->config['markUnused']
        );
    } elseif ($this->config['format'] === 'pot') {
        $this->saveMessagesToPOT($messages, $this->config['messagePath'], $catalog);
    }
}

            
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() 公共方法

定义于: 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() 受保护方法 (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() 公共方法

定义于: 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() 公共方法

定义于: 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() 公共静态方法
自 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() 公共方法

定义于: 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() 公共方法

定义于: 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() 公共方法

定义于: 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);
        }
    }
}

            
extractMessages() 受保护的方法

从文件中提取消息。

protected array extractMessages ( $fileName, $translator, $ignoreCategories = [] )
$fileName string

要从中提取消息的文件的名称

$translator string

用于翻译消息的函数的名称

$ignoreCategories array

要忽略的消息类别。此参数自版本 2.0.4 起可用。

                protected function extractMessages($fileName, $translator, $ignoreCategories = [])
{
    $this->stdout('Extracting messages from ');
    $this->stdout($fileName, Console::FG_CYAN);
    $this->stdout("...\n");
    $subject = file_get_contents($fileName);
    $messages = [];
    $tokens = token_get_all($subject);
    foreach ((array) $translator as $currentTranslator) {
        $translatorTokens = token_get_all('<?php ' . $currentTranslator);
        array_shift($translatorTokens);
        $messages = array_merge_recursive($messages, $this->extractMessagesFromTokens($tokens, $translatorTokens, $ignoreCategories));
    }
    $this->stdout("\n");
    return $messages;
}

            
extractMessagesFromTokens() 受保护的方法

从解析的 PHP 令牌列表中提取消息。

protected array extractMessagesFromTokens ( array $tokens, array $translatorTokens, array $ignoreCategories )
$tokens array

要处理的令牌。

$translatorTokens array

翻译器令牌。

$ignoreCategories array

要忽略的消息类别。

返回值 array

消息。

                protected function extractMessagesFromTokens(array $tokens, array $translatorTokens, array $ignoreCategories)
{
    $messages = [];
    $translatorTokensCount = count($translatorTokens);
    $matchedTokensCount = 0;
    $buffer = [];
    $pendingParenthesisCount = 0;
    foreach ($tokens as $tokenIndex => $token) {
        // finding out translator call
        if ($matchedTokensCount < $translatorTokensCount) {
            if ($this->tokensEqual($token, $translatorTokens[$matchedTokensCount])) {
                $matchedTokensCount++;
            } else {
                $matchedTokensCount = 0;
            }
        } elseif ($matchedTokensCount === $translatorTokensCount) {
            // translator found
            // end of function call
            if ($this->tokensEqual(')', $token)) {
                $pendingParenthesisCount--;
                if ($pendingParenthesisCount === 0) {
                    // end of translator call or end of something that we can't extract
                    if (isset($buffer[0][0], $buffer[1], $buffer[2][0]) && $buffer[0][0] === T_CONSTANT_ENCAPSED_STRING && $buffer[1] === ',' && $buffer[2][0] === T_CONSTANT_ENCAPSED_STRING) {
                        // is valid call we can extract
                        $category = stripcslashes($buffer[0][1]);
                        $category = mb_substr($category, 1, -1);
                        if (!$this->isCategoryIgnored($category, $ignoreCategories)) {
                            $fullMessage = mb_substr($buffer[2][1], 1, -1);
                            $i = 3;
                            while ($i < count($buffer) - 1 && !is_array($buffer[$i]) && $buffer[$i] === '.') {
                                $fullMessage .= mb_substr($buffer[$i + 1][1], 1, -1);
                                $i += 2;
                            }
                            $message = stripcslashes($fullMessage);
                            $messages[$category][] = $message;
                        }
                        $nestedTokens = array_slice($buffer, 3);
                        if (count($nestedTokens) > $translatorTokensCount) {
                            // search for possible nested translator calls
                            $messages = array_merge_recursive($messages, $this->extractMessagesFromTokens($nestedTokens, $translatorTokens, $ignoreCategories));
                        }
                    } else {
                        // invalid call or dynamic call we can't extract
                        $line = Console::ansiFormat($this->getLine($buffer), [Console::FG_CYAN]);
                        $skipping = Console::ansiFormat('Skipping line', [Console::FG_YELLOW]);
                        $this->stdout("$skipping $line. Make sure both category and message are static strings.\n");
                    }
                    // prepare for the next match
                    $matchedTokensCount = 0;
                    $pendingParenthesisCount = 0;
                    $buffer = [];
                } else {
                    $buffer[] = $token;
                }
            } elseif ($this->tokensEqual('(', $token)) {
                // count beginning of function call, skipping translator beginning
                // If we are not yet inside the translator, make sure that it's beginning of the real translator.
                // See https://github.com/yiisoft/yii2/issues/16828
                if ($pendingParenthesisCount === 0) {
                    $previousTokenIndex = $tokenIndex - $matchedTokensCount - 1;
                    if (is_array($tokens[$previousTokenIndex])) {
                        $previousToken = $tokens[$previousTokenIndex][0];
                        if (in_array($previousToken, [T_OBJECT_OPERATOR, T_PAAMAYIM_NEKUDOTAYIM], true)) {
                            $matchedTokensCount = 0;
                            continue;
                        }
                    }
                }
                if ($pendingParenthesisCount > 0) {
                    $buffer[] = $token;
                }
                $pendingParenthesisCount++;
            } elseif (isset($token[0]) && !in_array($token[0], [T_WHITESPACE, T_COMMENT])) {
                // ignore comments and whitespaces
                $buffer[] = $token;
            }
        }
    }
    return $messages;
}

            
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;
}

            
getActionArgsHelp() public method

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

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

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

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

默认实现将返回从对应于操作方法的参数的反射或 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() public method

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

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

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

要获取帮助的操作

返回值 string

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

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

            
getActionHelpSummary() public method

定义于: 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 method
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() public method

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

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

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

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

默认实现将返回从对应于操作选项的属性的 doc-comment 中提取的帮助信息。

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;
}

            
getBehavior() public method

定义于: 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;
}

            
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));
}

            
getLine() protected method (available since version 2.0.1)

找到第一个非字符 PHP 令牌的行。

protected integer|string getLine ( $tokens )
$tokens array

                protected function getLine($tokens)
{
    foreach ($tokens as $token) {
        if (isset($token[2])) {
            return $token[2];
        }
    }
    return 'unknown';
}

            
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();
}

            
getUniqueId() public method

定义于: 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

定义于: 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

定义于: 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

定义于: 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

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

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

方法定义如下

  • 类具有指定名称的方法
  • 附加的行为具有具有给定名称的方法(当 $checkBehaviors 为真时)。
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

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

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

属性定义如下

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

另请参阅

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)

定义于: 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());
}

            
initConfig() protected method (available since version 2.0.13)

protected void initConfig ( $configFile )
$configFile string
抛出异常 yii\console\Exception

如果配置文件不存在。

                protected function initConfig($configFile)
{
    $configFileContent = [];
    if ($configFile !== null) {
        $configFile = Yii::getAlias($configFile);
        if (!is_file($configFile)) {
            throw new Exception("The configuration file does not exist: $configFile");
        }
        $configFileContent = require $configFile;
    }
    $this->config = array_merge(
        $this->getOptionValues($this->action->id),
        $configFileContent,
        $this->getPassedOptionValues()
    );
    $this->config['sourcePath'] = Yii::getAlias($this->config['sourcePath']);
    $this->config['messagePath'] = Yii::getAlias($this->config['messagePath']);
    if (!isset($this->config['sourcePath'], $this->config['languages'])) {
        throw new Exception('The configuration file must specify "sourcePath" and "languages".');
    }
    if (!is_dir($this->config['sourcePath'])) {
        throw new Exception("The source path {$this->config['sourcePath']} is not a valid directory.");
    }
    if (empty($this->config['format']) || !in_array($this->config['format'], ['php', 'po', 'pot', 'db'])) {
        throw new Exception('Format should be either "php", "po", "pot" or "db".');
    }
    if (in_array($this->config['format'], ['php', 'po', 'pot'])) {
        if (!isset($this->config['messagePath'])) {
            throw new Exception('The configuration file must specify "messagePath".');
        }
        if (!is_dir($this->config['messagePath'])) {
            throw new Exception("The message path {$this->config['messagePath']} is not a valid directory.");
        }
    }
    if (empty($this->config['languages'])) {
        throw new Exception('Languages cannot be empty.');
    }
    if ($this->config['format'] === 'php' && $this->config['phpDocBlock'] === null) {
        $this->config['phpDocBlock'] = <<<DOCBLOCK
essage translations.
his file is automatically generated by 'yii {$this->id}/{$this->action->id}' command.
t contains the localizable messages extracted from source code.
ou may modify this file by translating the extracted messages.
ach array element represents the translation (value) of a message (key).
f the value is empty, the message is considered as not translated.
essages that no longer need translation will have their translations
nclosed between a pair of '@@' marks.
essage string can be used with plural forms format. Check i18n section
f the guide for details.
OTE: this file must be saved in UTF-8 encoding.
LOCK;
    }
}

            
isCategoryIgnored() 受保护方法 (从版本 2.0.7 开始可用)

该方法检查 $category 是否根据 $ignoreCategories 数组被忽略。

示例

  • myapp - 仅忽略 myapp 类别;
  • myapp* - 将被所有以 myapp 开头的类别忽略(myappmyapplicationmyapprovemyapp/widgetsmyapp.widgets 等)。
protected boolean isCategoryIgnored ( $category, array $ignoreCategories )
$category string

正在检查的类别

$ignoreCategories array

要忽略的消息类别。

                protected function isCategoryIgnored($category, array $ignoreCategories)
{
    if (!empty($ignoreCategories)) {
        if (in_array($category, $ignoreCategories, true)) {
            return true;
        }
        foreach ($ignoreCategories as $pattern) {
            if (strpos($pattern, '*') > 0 && strpos($category, rtrim($pattern, '*')) === 0) {
                return true;
            }
        }
    }
    return false;
}

            
isColorEnabled() 公共方法

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

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

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

public boolean isColorEnabled ( $stream = \STDOUT )
$stream 资源

要检查的流。

返回值 boolean

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

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

            
off() 公共方法

定义于: 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() 公共方法

定义于: 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 开始可用)

返回选项别名。

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

public array optionAliases ( )
返回值 array

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

                public function optionAliases()
{
    return array_merge(parent::optionAliases(), [
        'c' => 'catalog',
        'e' => 'except',
        'f' => 'format',
        'i' => 'ignoreCategories',
        'l' => 'languages',
        'u' => 'markUnused',
        'p' => 'messagePath',
        'o' => 'only',
        'w' => 'overwrite',
        'S' => 'sort',
        't' => 'translator',
        'm' => 'sourceMessageTable',
        's' => 'sourcePath',
        'r' => 'removeUnused',
    ]);
}

            
options() 公共方法

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

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

请注意,在调用 beforeAction() 之前,无法使用通过选项设置的值。

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

当前请求的动作 ID

返回值 string[]

对操作有效的选项名称

                public function options($actionID)
{
    return array_merge(parent::options($actionID), [
        'sourcePath',
        'messagePath',
        'languages',
        'translator',
        'sort',
        'overwrite',
        'removeUnused',
        'markUnused',
        'except',
        'only',
        'format',
        'db',
        'sourceMessageTable',
        'messageTable',
        'catalog',
        'ignoreCategories',
        'phpFileHeader',
        'phpDocBlock',
    ]);
}

            
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:如果验证失败,则通过引用传递的错误值。

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

$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 为空,则遍历该控制器的所有祖先模块,并找到第一个其 layout 不为空的模块。布局及其对应的模块将分别用作布局名称和上下文模块。如果未找到这样的模块或对应的布局不是字符串,它将返回 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);
}

            
saveMessagesCategoryToPHP() 受保护方法

将类别消息写入 PHP 文件。

protected integer saveMessagesCategoryToPHP ( $messages, $fileName, $overwrite, $removeUnused, $sort, $category, $markUnused )
$messages array
$fileName string

要写入的文件的名称

$overwrite boolean

如果现有文件应该被覆盖,而无需备份

$removeUnused boolean

如果应该删除过时的翻译

$sort boolean

如果应该对翻译进行排序

$category string

消息类别

$markUnused boolean

如果应该标记过时的翻译

返回值 integer

退出代码

                protected function saveMessagesCategoryToPHP($messages, $fileName, $overwrite, $removeUnused, $sort, $category, $markUnused)
{
    if (is_file($fileName)) {
        $rawExistingMessages = require $fileName;
        $existingMessages = $rawExistingMessages;
        sort($messages);
        ksort($existingMessages);
        if (array_keys($existingMessages) === $messages && (!$sort || array_keys($rawExistingMessages) === $messages)) {
            $this->stdout("Nothing new in \"$category\" category... Nothing to save.\n\n", Console::FG_GREEN);
            return ExitCode::OK;
        }
        unset($rawExistingMessages);
        $merged = [];
        $untranslated = [];
        foreach ($messages as $message) {
            if (array_key_exists($message, $existingMessages) && $existingMessages[$message] !== '') {
                $merged[$message] = $existingMessages[$message];
            } else {
                $untranslated[] = $message;
            }
        }
        ksort($merged);
        sort($untranslated);
        $todo = [];
        foreach ($untranslated as $message) {
            $todo[$message] = '';
        }
        ksort($existingMessages);
        foreach ($existingMessages as $message => $translation) {
            if (!$removeUnused && !isset($merged[$message]) && !isset($todo[$message])) {
                if (!$markUnused || (!empty($translation) && (strncmp($translation, '@@', 2) === 0 && substr_compare($translation, '@@', -2, 2) === 0))) {
                    $todo[$message] = $translation;
                } else {
                    $todo[$message] = '@@' . $translation . '@@';
                }
            }
        }
        $merged = array_merge($merged, $todo);
        if ($sort) {
            ksort($merged);
        }
        if (false === $overwrite) {
            $fileName .= '.merged';
        }
        $this->stdout("Translation merged.\n");
    } else {
        $merged = [];
        foreach ($messages as $message) {
            $merged[$message] = '';
        }
        ksort($merged);
    }
    $array = VarDumper::export($merged);
    $content = <<<EOD
p
is->config['phpFileHeader']}{$this->config['phpDocBlock']}
rn $array;

    if (file_put_contents($fileName, $content, LOCK_EX) === false) {
        $this->stdout("Translation was NOT saved.\n\n", Console::FG_RED);
        return ExitCode::UNSPECIFIED_ERROR;
    }
    $this->stdout("Translation saved.\n\n", Console::FG_GREEN);
    return ExitCode::OK;
}

            
saveMessagesToDb() 受保护方法

将消息保存到数据库。

protected void saveMessagesToDb ( $messages, $db, $sourceMessageTable, $messageTable, $removeUnused, $languages, $markUnused )
$messages array
$db yii\db\Connection
$sourceMessageTable string
$messageTable string
$removeUnused boolean
$languages array
$markUnused boolean

                protected function saveMessagesToDb($messages, $db, $sourceMessageTable, $messageTable, $removeUnused, $languages, $markUnused)
{
    $currentMessages = [];
    $rows = (new Query())->select(['id', 'category', 'message'])->from($sourceMessageTable)->all($db);
    foreach ($rows as $row) {
        $currentMessages[$row['category']][$row['id']] = $row['message'];
    }
    $new = [];
    $obsolete = [];
    foreach ($messages as $category => $msgs) {
        $msgs = array_unique($msgs);
        if (isset($currentMessages[$category])) {
            $new[$category] = array_diff($msgs, $currentMessages[$category]);
            // obsolete messages per category
            $obsolete += array_diff($currentMessages[$category], $msgs);
        } else {
            $new[$category] = $msgs;
        }
    }
    // obsolete categories
    foreach (array_diff(array_keys($currentMessages), array_keys($messages)) as $category) {
        $obsolete += $currentMessages[$category];
    }
    if (!$removeUnused) {
        foreach ($obsolete as $pk => $msg) {
            // skip already marked unused
            if (strncmp($msg, '@@', 2) === 0 && substr($msg, -2) === '@@') {
                unset($obsolete[$pk]);
            }
        }
    }
    $this->stdout('Inserting new messages...');
    $insertCount = 0;
    foreach ($new as $category => $msgs) {
        foreach ($msgs as $msg) {
            $insertCount++;
            $db->schema->insert($sourceMessageTable, ['category' => $category, 'message' => $msg]);
        }
    }
    $this->stdout($insertCount ? "{$insertCount} saved.\n" : "Nothing to save.\n");
    $this->stdout($removeUnused ? 'Deleting obsoleted messages...' : 'Updating obsoleted messages...');
    if (empty($obsolete)) {
        $this->stdout("Nothing obsoleted...skipped.\n");
    }
    if ($obsolete) {
        if ($removeUnused) {
            $affected = $db->createCommand()
               ->delete($sourceMessageTable, ['in', 'id', array_keys($obsolete)])
               ->execute();
            $this->stdout("{$affected} deleted.\n");
        } elseif ($markUnused) {
            $marked = 0;
            $rows = (new Query())
                ->select(['id', 'message'])
                ->from($sourceMessageTable)
                ->where(['in', 'id', array_keys($obsolete)])
                ->all($db);
            foreach ($rows as $row) {
                $marked++;
                $db->createCommand()->update(
                    $sourceMessageTable,
                    ['message' => '@@' . $row['message'] . '@@'],
                    ['id' => $row['id']]
                )->execute();
            }
            $this->stdout("{$marked} updated.\n");
        } else {
            $this->stdout("kept untouched.\n");
        }
    }
    // get fresh message id list
    $freshMessagesIds = [];
    $rows = (new Query())->select(['id'])->from($sourceMessageTable)->all($db);
    foreach ($rows as $row) {
        $freshMessagesIds[] = $row['id'];
    }
    $this->stdout('Generating missing rows...');
    $generatedMissingRows = [];
    foreach ($languages as $language) {
        $count = 0;
        // get list of ids of translations for this language
        $msgRowsIds = [];
        $msgRows = (new Query())->select(['id'])->from($messageTable)->where([
            'language' => $language,
        ])->all($db);
        foreach ($msgRows as $row) {
            $msgRowsIds[] = $row['id'];
        }
        // insert missing
        foreach ($freshMessagesIds as $id) {
            if (!in_array($id, $msgRowsIds)) {
                $db->createCommand()
                   ->insert($messageTable, ['id' => $id, 'language' => $language])
                   ->execute();
                $count++;
            }
        }
        if ($count) {
            $generatedMissingRows[] = "{$count} for {$language}";
        }
    }
    $this->stdout($generatedMissingRows ? implode(', ', $generatedMissingRows) . ".\n" : "Nothing to do.\n");
    $this->stdout('Dropping unused languages...');
    $droppedLanguages = [];
    $currentLanguages = [];
    $rows = (new Query())->select(['language'])->from($messageTable)->groupBy('language')->all($db);
    foreach ($rows as $row) {
        $currentLanguages[] = $row['language'];
    }
    foreach ($currentLanguages as $currentLanguage) {
        if (!in_array($currentLanguage, $languages)) {
            $deleted = $db->createCommand()->delete($messageTable, 'language=:language', [
                'language' => $currentLanguage,
            ])->execute();
            $droppedLanguages[] = "removed {$deleted} rows for $currentLanguage";
        }
    }
    $this->stdout($droppedLanguages ? implode(', ', $droppedLanguages) . ".\n" : "Nothing to do.\n");
}

            
saveMessagesToPHP() 受保护方法

将消息写入 PHP 文件。

protected void saveMessagesToPHP ( $messages, $dirName, $overwrite, $removeUnused, $sort, $markUnused )
$messages array
$dirName string

要写入的目录的名称

$overwrite boolean

如果现有文件应该被覆盖,而无需备份

$removeUnused boolean

如果应该删除过时的翻译

$sort boolean

如果应该对翻译进行排序

$markUnused boolean

如果应该标记过时的翻译

                protected function saveMessagesToPHP($messages, $dirName, $overwrite, $removeUnused, $sort, $markUnused)
{
    foreach ($messages as $category => $msgs) {
        $file = str_replace('\\', '/', "$dirName/$category.php");
        $path = dirname($file);
        FileHelper::createDirectory($path);
        $msgs = array_values(array_unique($msgs));
        $coloredFileName = Console::ansiFormat($file, [Console::FG_CYAN]);
        $this->stdout("Saving messages to $coloredFileName...\n");
        $this->saveMessagesCategoryToPHP($msgs, $file, $overwrite, $removeUnused, $sort, $category, $markUnused);
    }
    if ($removeUnused) {
        $this->deleteUnusedPhpMessageFiles(array_keys($messages), $dirName);
    }
}

            
saveMessagesToPO() 受保护方法

将消息写入 PO 文件。

protected void saveMessagesToPO ( $messages, $dirName, $overwrite, $removeUnused, $sort, $catalog, $markUnused )
$messages array
$dirName string

要写入的目录的名称

$overwrite boolean

如果现有文件应该被覆盖,而无需备份

$removeUnused boolean

如果应该删除过时的翻译

$sort boolean

如果应该对翻译进行排序

$catalog string

消息目录

$markUnused boolean

如果应该标记过时的翻译

                protected function saveMessagesToPO($messages, $dirName, $overwrite, $removeUnused, $sort, $catalog, $markUnused)
{
    $file = str_replace('\\', '/', "$dirName/$catalog.po");
    FileHelper::createDirectory(dirname($file));
    $this->stdout("Saving messages to $file...\n");
    $poFile = new GettextPoFile();
    $merged = [];
    $todos = [];
    $hasSomethingToWrite = false;
    foreach ($messages as $category => $msgs) {
        $notTranslatedYet = [];
        $msgs = array_values(array_unique($msgs));
        if (is_file($file)) {
            $existingMessages = $poFile->load($file, $category);
            sort($msgs);
            ksort($existingMessages);
            if (array_keys($existingMessages) == $msgs) {
                $this->stdout("Nothing new in \"$category\" category...\n");
                sort($msgs);
                foreach ($msgs as $message) {
                    $merged[$category . chr(4) . $message] = $existingMessages[$message];
                }
                ksort($merged);
                continue;
            }
            // merge existing message translations with new message translations
            foreach ($msgs as $message) {
                if (array_key_exists($message, $existingMessages) && $existingMessages[$message] !== '') {
                    $merged[$category . chr(4) . $message] = $existingMessages[$message];
                } else {
                    $notTranslatedYet[] = $message;
                }
            }
            ksort($merged);
            sort($notTranslatedYet);
            // collect not yet translated messages
            foreach ($notTranslatedYet as $message) {
                $todos[$category . chr(4) . $message] = '';
            }
            // add obsolete unused messages
            foreach ($existingMessages as $message => $translation) {
                if (!$removeUnused && !isset($merged[$category . chr(4) . $message]) && !isset($todos[$category . chr(4) . $message])) {
                    if (!$markUnused || (!empty($translation) && (substr($translation, 0, 2) === '@@' && substr($translation, -2) === '@@'))) {
                        $todos[$category . chr(4) . $message] = $translation;
                    } else {
                        $todos[$category . chr(4) . $message] = '@@' . $translation . '@@';
                    }
                }
            }
            $merged = array_merge($merged, $todos);
            if ($sort) {
                ksort($merged);
            }
            if ($overwrite === false) {
                $file .= '.merged';
            }
        } else {
            sort($msgs);
            foreach ($msgs as $message) {
                $merged[$category . chr(4) . $message] = '';
            }
            ksort($merged);
        }
        $this->stdout("Category \"$category\" merged.\n");
        $hasSomethingToWrite = true;
    }
    if ($hasSomethingToWrite) {
        $poFile->save($file, $merged);
        $this->stdout("Translation saved.\n", Console::FG_GREEN);
    } else {
        $this->stdout("Nothing to save.\n", Console::FG_GREEN);
    }
}

            
saveMessagesToPOT() 受保护方法 (自版本 2.0.6 起可用)

将消息写入 POT 文件。

protected void saveMessagesToPOT ( $messages, $dirName, $catalog )
$messages array
$dirName string

要写入的目录的名称

$catalog string

消息目录

                protected function saveMessagesToPOT($messages, $dirName, $catalog)
{
    $file = str_replace('\\', '/', "$dirName/$catalog.pot");
    FileHelper::createDirectory(dirname($file));
    $this->stdout("Saving messages to $file...\n");
    $poFile = new GettextPoFile();
    $merged = [];
    $hasSomethingToWrite = false;
    foreach ($messages as $category => $msgs) {
        $msgs = array_values(array_unique($msgs));
        sort($msgs);
        foreach ($msgs as $message) {
            $merged[$category . chr(4) . $message] = '';
        }
        $this->stdout("Category \"$category\" merged.\n");
        $hasSomethingToWrite = true;
    }
    if ($hasSomethingToWrite) {
        ksort($merged);
        $poFile->save($file, $merged);
        $this->stdout("Translation saved.\n", Console::FG_GREEN);
    } else {
        $this->stdout("Nothing to save.\n", Console::FG_GREEN);
    }
}

            
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);
}

            
tokensEqual() 受保护方法 (自版本 2.0.1 起可用)

确定两个 PHP 令牌是否相等。

protected boolean tokensEqual ( $a, $b )
$a array|string
$b array|string

                protected function tokensEqual($a, $b)
{
    if (is_string($a) && is_string($b)) {
        return $a === $b;
    }
    if (isset($a[0], $a[1], $b[0], $b[1])) {
        return $a[0] === $b[0] && $a[1] == $b[1];
    }
    return false;
}

            
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);
}