0 关注者

类 yii\console\controllers\AssetController

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

允许您合并和压缩 JavaScript 和 CSS 文件。

用法

  1. 使用 template 操作创建配置文件

    yii asset/template /path/to/myapp/config.php

  2. 编辑创建的配置文件,根据您的 Web 应用程序需求进行调整。
  3. 运行 'compress' 操作,使用创建的配置文件

    yii asset /path/to/myapp/config.php /path/to/myapp/config/assets_compressed.php

  4. 调整您的 Web 应用程序配置以使用压缩后的资源。

注意:在控制台环境中,一些 路径别名(如 @webroot@web)可能不存在,因此配置中的相应路径应直接指定。

注意:默认情况下,此命令依赖于外部工具来执行实际的文件压缩,请查看 $jsCompressor$cssCompressor 以了解更多详细信息。

公有属性

隐藏继承的属性

属性 类型 描述 定义于
$action yii\base\Action|null 当前正在执行的操作。 yii\base\Controller
$assetManager yii\web\AssetManager 资源管理器实例。 yii\console\controllers\AssetController
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$bundles array 要压缩的资源包列表。 yii\console\controllers\AssetController
$color boolean|null 是否启用输出中的 ANSI 颜色。 yii\console\Controller
$cssCompressor string|callable CSS 文件压缩器。 yii\console\controllers\AssetController
$defaultAction string 控制器默认操作 ID。 yii\console\controllers\AssetController
$deleteSource boolean 压缩后是否删除资源源文件。 yii\console\controllers\AssetController
$help boolean 是否显示当前命令的帮助信息。 yii\console\Controller
$helpSummary string yii\console\Controller
$id string 此控制器的 ID。 yii\base\Controller
$interactive boolean 是否以交互方式运行命令。 yii\console\Controller
$jsCompressor string|callable JavaScript 文件压缩器。 yii\console\controllers\AssetController
$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 如果为真 - 脚本在出现异常时以 ExitCode::OK 结束。 yii\console\Controller
$targets array 资源包列表,表示输出压缩文件。 yii\console\controllers\AssetController
$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
actionCompress() 根据给定的配置合并和压缩资源文件。 yii\console\controllers\AssetController
actionTemplate() actionCompress() 创建配置文件模板。 yii\console\controllers\AssetController
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
combineCssFiles() 将 CSS 文件合并到一个文件中。 yii\console\controllers\AssetController
combineJsFiles() 将 JavaScript 文件合并到一个文件中。 yii\console\controllers\AssetController
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
getAssetManager() 返回资产管理器实例。 yii\console\controllers\AssetController
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\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
setAssetManager() 设置资产管理器实例或配置。 yii\console\controllers\AssetController
setView() 设置此控制器要使用的视图对象。 yii\base\Controller
setViewPath() 设置包含视图文件的目录。 yii\base\Controller
stderr() 将字符串打印到 STDERR。 yii\console\Controller
stdout() 将字符串打印到 STDOUT。 yii\console\Controller
trigger() 触发事件。 yii\base\Component

受保护方法

隐藏继承的方法

方法 描述 定义于
adjustCssUrl() 调整 CSS 内容,允许指向原始资源的 URL 引用。 yii\console\controllers\AssetController
adjustDependency() 以源捆绑包开始依赖输出捆绑包的方式调整资产捆绑包之间的依赖关系。 yii\console\controllers\AssetController
bindInjectedParams() 根据操作方法签名中的类型和名称填充参数。 yii\base\Controller
buildTarget() 构建输出资产捆绑包。 yii\console\controllers\AssetController
compressCssFiles() 压缩给定的 CSS 文件并将它们合并到单个文件中。 yii\console\controllers\AssetController
compressJsFiles() 压缩给定的 JavaScript 文件并将它们合并到单个文件中。 yii\console\controllers\AssetController
getActionMethodReflection() yii\console\Controller
loadBundles() 创建源资产捆绑包的完整列表。 yii\console\controllers\AssetController
loadConfiguration() 将给定文件中的配置应用于自身实例。 yii\console\controllers\AssetController
loadDependency() 递归加载资产捆绑包依赖项。 yii\console\controllers\AssetController
loadTargets() 创建输出资产捆绑包的完整列表。 yii\console\controllers\AssetController
parseDocCommentDetail() 从文档块返回完整描述。 yii\console\Controller
parseDocCommentSummary() 返回文档块的第一行。 yii\console\Controller
parseDocCommentTags() 将注释块解析为标签。 yii\console\Controller
registerBundle() 注册资产捆绑包,包括它们的依赖项。 yii\console\controllers\AssetController
saveTargets() 保存新的资产捆绑包配置。 yii\console\controllers\AssetController

事件

隐藏继承的事件

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

属性详情

隐藏继承的属性

$assetManager 公共属性

资产管理器实例。请注意,此属性在 getter 和 setter 中的类型不同。有关详细信息,请参阅 getAssetManager()setAssetManager()

$bundles 公共属性

要压缩的资源包列表。

public array $bundles = []
$cssCompressor 公共属性

CSS 文件压缩器。如果为字符串,则将其视为 shell 命令模板,该模板应包含占位符 {from} - 源文件名 - 和 {to} - 输出文件名。否则,将其视为 PHP 回调,该回调应执行压缩。

默认值依赖于使用“YUI Compressor”

另请参阅 https://github.com/yui/yuicompressor/

public string|callable $cssCompressor 'java -jar yuicompressor.jar --type css {from} -o {to}'
$defaultAction 公共属性

控制器默认操作 ID。

public string $defaultAction 'compress'
$deleteSource 公共属性 (自版本 2.0.10 起可用)

压缩后是否删除资产源文件。此选项仅影响那些 yii\web\AssetBundle::$sourcePath 设置的捆绑包。

public boolean $deleteSource false
$jsCompressor 公共属性

JavaScript 文件压缩器。如果为字符串,则将其视为 shell 命令模板,该模板应包含占位符 {from} - 源文件名 - 和 {to} - 输出文件名。否则,将其视为 PHP 回调,该回调应执行压缩。

默认值依赖于使用“Closure Compiler”

另请参阅 https://developers.google.com/closure/compiler/

public string|callable $jsCompressor 'java -jar compiler.jar --js {from} --js_output_file {to}'
$targets 公共属性

资产包列表,表示输出的压缩文件。您可以使用 'css' 和 'js' 键指定输出压缩文件的名称:例如

'app\config\AllAsset' => [
    'js' => 'js/all-{hash}.js',
    'css' => 'css/all-{hash}.css',
    'depends' => [ ... ],
]

文件名可以包含占位符“{hash}”,它将由结果文件的哈希值填充。

您可以指定多个目标包以压缩不同组的资产。在这种情况下,您应该使用 'depends' 键来指定哪些包应该包含在特定的目标包中。对于单个包,您可以将 'depends' 留空,在这种情况下,它将压缩此案例中所有剩余的包。例如

'allShared' => [
    'js' => 'js/all-shared-{hash}.js',
    'css' => 'css/all-shared-{hash}.css',
    'depends' => [
        // Include all assets shared between 'backend' and 'frontend'
        'yii\web\YiiAsset',
        'app\assets\SharedAsset',
    ],
],
'allBackEnd' => [
    'js' => 'js/all-{hash}.js',
    'css' => 'css/all-{hash}.css',
    'depends' => [
        // Include only 'backend' assets:
        'app\assets\AdminAsset'
    ],
],
'allFrontEnd' => [
    'js' => 'js/all-{hash}.js',
    'css' => 'css/all-{hash}.css',
    'depends' => [], // Include all remaining assets
],
public array $targets = []

方法详情

隐藏继承的方法

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

            
actionCompress() 公共方法

根据给定的配置合并和压缩资源文件。

在此过程中,将创建新的资产包配置文件。您应该用此文件替换原始资产包配置,以便使用压缩文件。

public void actionCompress ( $configFile, $bundleFile )
$configFile string

配置文件名。

$bundleFile string

输出资产包配置文件名。

                public function actionCompress($configFile, $bundleFile)
{
    $this->loadConfiguration($configFile);
    $bundles = $this->loadBundles($this->bundles);
    $targets = $this->loadTargets($this->targets, $bundles);
    foreach ($targets as $name => $target) {
        $this->stdout("Creating output bundle '{$name}':\n");
        if (!empty($target->js)) {
            $this->buildTarget($target, 'js', $bundles);
        }
        if (!empty($target->css)) {
            $this->buildTarget($target, 'css', $bundles);
        }
        $this->stdout("\n");
    }
    $targets = $this->adjustDependency($targets, $bundles);
    $this->saveTargets($targets, $bundleFile);
    if ($this->deleteSource) {
        $this->deletePublishedAssets($bundles);
    }
}

            
actionTemplate() 公共方法

actionCompress() 创建配置文件模板。

public integer actionTemplate ( $configFile )
$configFile string

输出文件名。

返回值 integer

CLI 退出代码

抛出 yii\console\Exception

失败时。

                public function actionTemplate($configFile)
{
    $jsCompressor = VarDumper::export($this->jsCompressor);
    $cssCompressor = VarDumper::export($this->cssCompressor);
    $template = <<<EOD
p
onfiguration file for the "yii asset" console command.
n the console environment, some path aliases may not exist. Please define these:
ii::setAlias('@webroot', __DIR__ . '/../web');
ii::setAlias('@web', '/');
rn [
// Adjust command/callback for JavaScript files compressing:
'jsCompressor' => {$jsCompressor},
// Adjust command/callback for CSS files compressing:
'cssCompressor' => {$cssCompressor},
// Whether to delete asset source after compression:
'deleteSource' => false,
// The list of asset bundles to compress:
'bundles' => [
    // 'app\assets\AppAsset',
    // 'yii\web\YiiAsset',
    // 'yii\web\JqueryAsset',
],
// Asset bundle for compression output:
'targets' => [
    'all' => [
        'class' => 'yii\web\AssetBundle',
        'basePath' => '@webroot/assets',
        'baseUrl' => '@web/assets',
        'js' => 'js/all-{hash}.js',
        'css' => 'css/all-{hash}.css',
    ],
],
// Asset manager configuration:
'assetManager' => [
    //'basePath' => '@webroot/assets',
    //'baseUrl' => '@web/assets',
],

    if (file_exists($configFile)) {
        if (!$this->confirm("File '{$configFile}' already exists. Do you wish to overwrite it?")) {
            return ExitCode::OK;
        }
    }
    if (!file_put_contents($configFile, $template, LOCK_EX)) {
        throw new Exception("Unable to write template file '{$configFile}'.");
    }
    $this->stdout("Configuration file template created at '{$configFile}'.\n\n", Console::FG_GREEN);
    return ExitCode::OK;
}

            
actions() 公共方法

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

声明控制器的外部操作。

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

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

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

public 数组 actions ( )

                public function actions()
{
    return [];
}

            
adjustCssUrl() 受保护方法

调整 CSS 内容,允许指向原始资源的 URL 引用。

protected 字符串 adjustCssUrl ( $cssContent, $inputFilePath, $outputFilePath )
$cssContent string

源 CSS 内容。

$inputFilePath string

输入 CSS 文件名。

$outputFilePath string

输出 CSS 文件名。

返回值 string

调整后的 CSS 内容。

                protected function adjustCssUrl($cssContent, $inputFilePath, $outputFilePath)
{
    $inputFilePath = str_replace('\\', '/', $inputFilePath);
    $outputFilePath = str_replace('\\', '/', $outputFilePath);
    $sharedPathParts = [];
    $inputFilePathParts = explode('/', $inputFilePath);
    $inputFilePathPartsCount = count($inputFilePathParts);
    $outputFilePathParts = explode('/', $outputFilePath);
    $outputFilePathPartsCount = count($outputFilePathParts);
    for ($i = 0; $i < $inputFilePathPartsCount && $i < $outputFilePathPartsCount; $i++) {
        if ($inputFilePathParts[$i] == $outputFilePathParts[$i]) {
            $sharedPathParts[] = $inputFilePathParts[$i];
        } else {
            break;
        }
    }
    $sharedPath = implode('/', $sharedPathParts);
    $inputFileRelativePath = trim(str_replace($sharedPath, '', $inputFilePath), '/');
    $outputFileRelativePath = trim(str_replace($sharedPath, '', $outputFilePath), '/');
    if (empty($inputFileRelativePath)) {
        $inputFileRelativePathParts = [];
    } else {
        $inputFileRelativePathParts = explode('/', $inputFileRelativePath);
    }
    if (empty($outputFileRelativePath)) {
        $outputFileRelativePathParts = [];
    } else {
        $outputFileRelativePathParts = explode('/', $outputFileRelativePath);
    }
    $callback = function ($matches) use ($inputFileRelativePathParts, $outputFileRelativePathParts) {
        $fullMatch = $matches[0];
        $inputUrl = $matches[1];
        if (strncmp($inputUrl, '/', 1) === 0 || strncmp($inputUrl, '#', 1) === 0 || preg_match('/^https?:\/\//i', $inputUrl) || preg_match('/^data:/i', $inputUrl)) {
            return $fullMatch;
        }
        if ($inputFileRelativePathParts === $outputFileRelativePathParts) {
            return $fullMatch;
        }
        if (empty($outputFileRelativePathParts)) {
            $outputUrlParts = [];
        } else {
            $outputUrlParts = array_fill(0, count($outputFileRelativePathParts), '..');
        }
        $outputUrlParts = array_merge($outputUrlParts, $inputFileRelativePathParts);
        if (strpos($inputUrl, '/') !== false) {
            $inputUrlParts = explode('/', $inputUrl);
            foreach ($inputUrlParts as $key => $inputUrlPart) {
                if ($inputUrlPart === '..') {
                    array_pop($outputUrlParts);
                    unset($inputUrlParts[$key]);
                }
            }
            $outputUrlParts[] = implode('/', $inputUrlParts);
        } else {
            $outputUrlParts[] = $inputUrl;
        }
        $outputUrl = implode('/', $outputUrlParts);
        return str_replace($inputUrl, $outputUrl, $fullMatch);
    };
    $cssContent = preg_replace_callback('/url\(["\']?([^)^"\']*)["\']?\)/i', $callback, $cssContent);
    return $cssContent;
}

            
adjustDependency() 受保护方法

以源捆绑包开始依赖输出捆绑包的方式调整资产捆绑包之间的依赖关系。

protected yii\web\AssetBundle[] adjustDependency ( $targets, $bundles )
$targets yii\web\AssetBundle[]

输出资产包。

$bundles yii\web\AssetBundle[]

源资产包。

返回值 yii\web\AssetBundle[]

输出资产包。

                protected function adjustDependency($targets, $bundles)
{
    $this->stdout("Creating new bundle configuration...\n");
    $map = [];
    foreach ($targets as $name => $target) {
        foreach ($target->depends as $bundle) {
            $map[$bundle] = $name;
        }
    }
    foreach ($targets as $name => $target) {
        $depends = [];
        foreach ($target->depends as $bn) {
            foreach ($bundles[$bn]->depends as $bundle) {
                $depends[$map[$bundle]] = true;
            }
        }
        unset($depends[$name]);
        $target->depends = array_keys($depends);
    }
    // detect possible circular dependencies
    foreach ($targets as $name => $target) {
        $registered = [];
        $this->registerBundle($targets, $name, $registered);
    }
    foreach ($map as $bundle => $target) {
        $sourceBundle = $bundles[$bundle];
        $depends = $sourceBundle->depends;
        if (!$this->isBundleExternal($sourceBundle)) {
            $depends[] = $target;
        }
        $targetBundle = clone $sourceBundle;
        $targetBundle->depends = $depends;
        $targets[$bundle] = $targetBundle;
    }
    return $targets;
}

            
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 混合类型 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 字符串 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 字符串|数组|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 布尔值 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 数组 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() 受保护方法 (自版本 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);
    }
}

            
buildTarget() 受保护方法

构建输出资产捆绑包。

protected void buildTarget ( $target, $type, $bundles )
$target yii\web\AssetBundle

输出资产包

$type string

“js” 或 “css”。

$bundles yii\web\AssetBundle[]

源资产包。

抛出 yii\console\Exception

失败时。

                protected function buildTarget($target, $type, $bundles)
{
    $inputFiles = [];
    foreach ($target->depends as $name) {
        if (isset($bundles[$name])) {
            if (!$this->isBundleExternal($bundles[$name])) {
                foreach ($bundles[$name]->$type as $file) {
                    if (is_array($file)) {
                        $inputFiles[] = $bundles[$name]->basePath . '/' . $file[0];
                    } else {
                        $inputFiles[] = $bundles[$name]->basePath . '/' . $file;
                    }
                }
            }
        } else {
            throw new Exception("Unknown bundle: '{$name}'");
        }
    }
    if (empty($inputFiles)) {
        $target->$type = [];
    } else {
        FileHelper::createDirectory($target->basePath, $this->getAssetManager()->dirMode);
        $tempFile = $target->basePath . '/' . strtr($target->$type, ['{hash}' => 'temp']);
        if ($type === 'js') {
            $this->compressJsFiles($inputFiles, $tempFile);
        } else {
            $this->compressCssFiles($inputFiles, $tempFile);
        }
        $targetFile = strtr($target->$type, ['{hash}' => md5_file($tempFile)]);
        $outputFile = $target->basePath . '/' . $targetFile;
        rename($tempFile, $outputFile);
        $target->$type = [$targetFile];
    }
}

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

            
combineCssFiles() 公共方法

将 CSS 文件合并到一个文件中。

public void combineCssFiles ( $inputFiles, $outputFile )
$inputFiles array

源文件名。

$outputFile string

输出文件名。

抛出 yii\console\Exception

失败时。

                public function combineCssFiles($inputFiles, $outputFile)
{
    $content = '';
    $outputFilePath = dirname($this->findRealPath($outputFile));
    foreach ($inputFiles as $file) {
        $content .= "/*** BEGIN FILE: $file ***/\n"
            . $this->adjustCssUrl(file_get_contents($file), dirname($this->findRealPath($file)), $outputFilePath)
            . "/*** END FILE: $file ***/\n";
    }
    if (!file_put_contents($outputFile, $content)) {
        throw new Exception("Unable to write output CSS file '{$outputFile}'.");
    }
}

            
combineJsFiles() 公共方法

将 JavaScript 文件合并到一个文件中。

public void combineJsFiles ( $inputFiles, $outputFile )
$inputFiles array

源文件名。

$outputFile string

输出文件名。

抛出 yii\console\Exception

失败时。

                public function combineJsFiles($inputFiles, $outputFile)
{
    $content = '';
    foreach ($inputFiles as $file) {
        // Add a semicolon to source code if trailing semicolon missing.
        // Notice: It needs a new line before `;` to avoid affection of line comment. (// ...;)
        $fileContent = rtrim(file_get_contents($file));
        if (substr($fileContent, -1) !== ';') {
            $fileContent .= "\n;";
        }
        $content .= "/*** BEGIN FILE: $file ***/\n"
            . $fileContent . "\n"
            . "/*** END FILE: $file ***/\n";
    }
    if (!file_put_contents($outputFile, $content)) {
        throw new Exception("Unable to write output JavaScript file '{$outputFile}'.");
    }
}

            
compressCssFiles() 受保护方法

压缩给定的 CSS 文件并将它们合并到单个文件中。

protected void compressCssFiles ( $inputFiles, $outputFile )
$inputFiles array

源文件名的列表。

$outputFile string

输出文件名。

抛出 yii\console\Exception

失败时

                protected function compressCssFiles($inputFiles, $outputFile)
{
    if (empty($inputFiles)) {
        return;
    }
    $this->stdout("  Compressing CSS files...\n");
    if (is_string($this->cssCompressor)) {
        $tmpFile = $outputFile . '.tmp';
        $this->combineCssFiles($inputFiles, $tmpFile);
        $this->stdout((string)shell_exec(strtr($this->cssCompressor, [
            '{from}' => escapeshellarg($tmpFile),
            '{to}' => escapeshellarg($outputFile),
        ])));
        @unlink($tmpFile);
    } else {
        call_user_func($this->cssCompressor, $this, $inputFiles, $outputFile);
    }
    if (!file_exists($outputFile)) {
        throw new Exception("Unable to compress CSS files into '{$outputFile}'.");
    }
    $this->stdout("  CSS files compressed into '{$outputFile}'.\n");
}

            
compressJsFiles() 受保护方法

压缩给定的 JavaScript 文件并将它们合并到单个文件中。

protected void compressJsFiles ( $inputFiles, $outputFile )
$inputFiles array

源文件名的列表。

$outputFile string

输出文件名。

抛出 yii\console\Exception

失败时

                protected function compressJsFiles($inputFiles, $outputFile)
{
    if (empty($inputFiles)) {
        return;
    }
    $this->stdout("  Compressing JavaScript files...\n");
    if (is_string($this->jsCompressor)) {
        $tmpFile = $outputFile . '.tmp';
        $this->combineJsFiles($inputFiles, $tmpFile);
        $this->stdout((string)shell_exec(strtr($this->jsCompressor, [
            '{from}' => escapeshellarg($tmpFile),
            '{to}' => escapeshellarg($outputFile),
        ])));
        @unlink($tmpFile);
    } else {
        call_user_func($this->jsCompressor, $this, $inputFiles, $outputFile);
    }
    if (!file_exists($outputFile)) {
        throw new Exception("Unable to compress JavaScript files into '{$outputFile}'.");
    }
    $this->stdout("  JavaScript files compressed into '{$outputFile}'.\n");
}

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

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

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

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

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

  • required: bool,此参数是否必需
  • type: string|null,此参数的 PHP 类型
  • 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;
}

            
getAssetManager() 公共方法

返回资产管理器实例。

public yii\web\AssetManager getAssetManager ( )
返回值 yii\web\AssetManager

资源管理器实例。

抛出 yii\console\Exception

在配置无效时。

                public function getAssetManager()
{
    if (!is_object($this->_assetManager)) {
        $options = $this->_assetManager;
        if (!isset($options['class'])) {
            $options['class'] = 'yii\\web\\AssetManager';
        }
        if (!isset($options['basePath'])) {
            throw new Exception("Please specify 'basePath' for the 'assetManager' option.");
        }
        if (!isset($options['baseUrl'])) {
            throw new Exception("Please specify 'baseUrl' for the 'assetManager' option.");
        }
        if (!isset($options['forceCopy'])) {
            $options['forceCopy'] = true;
        }
        $this->_assetManager = Yii::createObject($options);
    }
    return $this->_assetManager;
}

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

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

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

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

附加到此组件的行为列表

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

            
getHelp() 公共方法

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

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

您可以重写此方法以返回自定义帮助信息。默认实现返回从 PHPDoc 注释中检索到的帮助信息。

public string getHelp ( )

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

            
getHelpSummary() 公共方法

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

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

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

public string getHelpSummary ( )

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

            
getModules() 公共方法

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

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

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

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

public array getPassedOptionValues ( )
返回值 array

对应于传递选项的属性

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

            
getPassedOptions() 公共方法

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

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

public array getPassedOptions ( )
返回值 array

执行期间传递的选项名称

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

            
getRoute() 公共方法

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

返回当前请求的路由。

public string getRoute ( )
返回值 string

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

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

            
getUniqueId() 公共方法

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

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

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

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

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

定义于: 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() 公共方法 (自版本 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());
}

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

            
loadBundles() 受保护的方法

创建源资产捆绑包的完整列表。

protected yii\web\AssetBundle[] loadBundles ( $bundles )
$bundles string[]

资产包名称列表

返回值 yii\web\AssetBundle[]

源资产包列表。

                protected function loadBundles($bundles)
{
    $this->stdout("Collecting source bundles information...\n");
    $am = $this->getAssetManager();
    $result = [];
    foreach ($bundles as $name) {
        $result[$name] = $am->getBundle($name);
    }
    foreach ($result as $bundle) {
        $this->loadDependency($bundle, $result);
    }
    return $result;
}

            
loadConfiguration() 受保护的方法

将给定文件中的配置应用于自身实例。

protected void loadConfiguration ( $configFile )
$configFile string

配置文件名。

抛出 yii\console\Exception

失败时。

                protected function loadConfiguration($configFile)
{
    $this->stdout("Loading configuration from '{$configFile}'...\n");
    $config = require $configFile;
    foreach ($config as $name => $value) {
        if (property_exists($this, $name) || $this->canSetProperty($name)) {
            $this->$name = $value;
        } else {
            throw new Exception("Unknown configuration option: $name");
        }
    }
    $this->getAssetManager(); // check if asset manager configuration is correct
}

            
loadDependency() 受保护的方法

递归加载资产捆绑包依赖项。

protected void loadDependency ( $bundle, &$result )
$bundle yii\web\AssetBundle

包实例

$result array

已加载的包列表。

抛出 yii\console\Exception

失败时。

                protected function loadDependency($bundle, &$result)
{
    $am = $this->getAssetManager();
    foreach ($bundle->depends as $name) {
        if (!isset($result[$name])) {
            $dependencyBundle = $am->getBundle($name);
            $result[$name] = false;
            $this->loadDependency($dependencyBundle, $result);
            $result[$name] = $dependencyBundle;
        } elseif ($result[$name] === false) {
            throw new Exception("A circular dependency is detected for bundle '{$name}': " . $this->composeCircularDependencyTrace($name, $result) . '.');
        }
    }
}

            
loadTargets() 受保护的方法

创建输出资产捆绑包的完整列表。

protected yii\web\AssetBundle[] loadTargets ( $targets, $bundles )
$targets array

输出资产包配置。

$bundles yii\web\AssetBundle[]

源资产包列表。

返回值 yii\web\AssetBundle[]

输出资产包列表。

抛出 yii\console\Exception

失败时。

                protected function loadTargets($targets, $bundles)
{
    // build the dependency order of bundles
    $registered = [];
    foreach ($bundles as $name => $bundle) {
        $this->registerBundle($bundles, $name, $registered);
    }
    $bundleOrders = array_combine(array_keys($registered), range(0, count($bundles) - 1));
    // fill up the target which has empty 'depends'.
    $referenced = [];
    foreach ($targets as $name => $target) {
        if (empty($target['depends'])) {
            if (!isset($all)) {
                $all = $name;
            } else {
                throw new Exception("Only one target can have empty 'depends' option. Found two now: $all, $name");
            }
        } else {
            foreach ($target['depends'] as $bundle) {
                if (!isset($referenced[$bundle])) {
                    $referenced[$bundle] = $name;
                } else {
                    throw new Exception("Target '{$referenced[$bundle]}' and '$name' cannot contain the bundle '$bundle' at the same time.");
                }
            }
        }
    }
    if (isset($all)) {
        $targets[$all]['depends'] = array_diff(array_keys($registered), array_keys($referenced));
    }
    // adjust the 'depends' order for each target according to the dependency order of bundles
    // create an AssetBundle object for each target
    foreach ($targets as $name => $target) {
        if (!isset($target['basePath'])) {
            throw new Exception("Please specify 'basePath' for the '$name' target.");
        }
        if (!isset($target['baseUrl'])) {
            throw new Exception("Please specify 'baseUrl' for the '$name' target.");
        }
        usort($target['depends'], function ($a, $b) use ($bundleOrders) {
            if ($bundleOrders[$a] == $bundleOrders[$b]) {
                return 0;
            }
            return $bundleOrders[$a] > $bundleOrders[$b] ? 1 : -1;
        });
        if (!isset($target['class'])) {
            $target['class'] = $name;
        }
        $targets[$name] = Yii::createObject($target);
    }
    return $targets;
}

            
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 起可用)

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

从文档块返回完整描述。

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

返回文档块的第一行。

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'] : '';
}

            
registerBundle() 受保护方法

注册资产捆绑包,包括它们的依赖项。

protected void registerBundle ( $bundles, $name, &$registered )
$bundles yii\web\AssetBundle[]

资产包列表。

$name string

包名。

$registered array

存储已注册的名称。

抛出 yii\console\Exception

如果检测到循环依赖。

                protected function registerBundle($bundles, $name, &$registered)
{
    if (!isset($registered[$name])) {
        $registered[$name] = false;
        $bundle = $bundles[$name];
        foreach ($bundle->depends as $depend) {
            $this->registerBundle($bundles, $depend, $registered);
        }
        unset($registered[$name]);
        $registered[$name] = $bundle;
    } elseif ($registered[$name] === false) {
        throw new Exception("A circular dependency is detected for target '{$name}': " . $this->composeCircularDependencyTrace($name, $registered) . '.');
    }
}

            
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 混合 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 整数 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);
}

            
saveTargets() 受保护的方法

保存新的资产捆绑包配置。

protected void saveTargets ( $targets, $bundleFile )
$targets yii\web\AssetBundle[]

要保存的资产包列表。

$bundleFile string

输出文件名。

抛出 yii\console\Exception

失败时。

                protected function saveTargets($targets, $bundleFile)
{
    $array = [];
    foreach ($targets as $name => $target) {
        if (isset($this->targets[$name])) {
            $array[$name] = array_merge($this->targets[$name], [
                'class' => get_class($target),
                'sourcePath' => null,
                'basePath' => $this->targets[$name]['basePath'],
                'baseUrl' => $this->targets[$name]['baseUrl'],
                'js' => $target->js,
                'css' => $target->css,
                'depends' => [],
            ]);
        } else {
            if ($this->isBundleExternal($target)) {
                $array[$name] = $this->composeBundleConfig($target);
            } else {
                $array[$name] = [
                    'sourcePath' => null,
                    'js' => [],
                    'css' => [],
                    'depends' => $target->depends,
                ];
            }
        }
    }
    $array = VarDumper::export($array);
    $version = date('Y-m-d H:i:s');
    $bundleFileContent = <<<EOD
p
his file is generated by the "yii {$this->id}" command.
O NOT MODIFY THIS FILE DIRECTLY.
version {$version}
rn {$array};

    if (!file_put_contents($bundleFile, $bundleFileContent, LOCK_EX)) {
        throw new Exception("Unable to write output bundle configuration at '{$bundleFile}'.");
    }
    $this->stdout("Output bundle configuration created at '{$bundleFile}'.\n", Console::FG_GREEN);
}

            
select() 公共方法

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

让用户选择一个选项。输入“?”将显示可供选择的选项列表及其说明。

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

提示消息

$options array

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

$default 字符串|

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

返回值 string

用户选择的选项字符

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

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

            
setAssetManager() 公共方法

设置资产管理器实例或配置。

public void setAssetManager ( $assetManager )
$assetManager yii\web\AssetManager|数组

资产管理器实例或其数组配置。

抛出 yii\console\Exception

在无效的参数类型上。

                public function setAssetManager($assetManager)
{
    if (is_scalar($assetManager)) {
        throw new Exception('"' . get_class($this) . '::assetManager" should be either object or array - "' . gettype($assetManager) . '" given.');
    }
    $this->_assetManager = $assetManager;
}

            
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 整数|布尔值 stderr ( $string )
$string string

要打印的字符串

返回值 整数|布尔值

打印的字节数或错误时的 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 整数|布尔值 stdout ( $string )
$string string

要打印的字符串

返回值 整数|布尔值

打印的字节数或错误时的 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|

事件实例。如果未设置,将创建一个默认的 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);
}