0 关注者

抽象类 yii\base\Application

继承关系yii\base\Application » yii\base\Module » yii\di\ServiceLocator » yii\base\Component » yii\base\BaseObject
实现接口yii\base\Configurable
子类yii\console\Application, yii\web\Application
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/base/Application.php

Application 是所有应用程序类的基类。

有关 Application 的更多详细信息和用法信息,请参阅 关于应用程序的指南文章

公共属性

隐藏继承属性

属性 类型 描述 定义于
$aliases array 要定义的路径别名列表。 yii\base\Module
$assetManager yii\web\AssetManager 资产管理器应用程序组件。 yii\base\Application
$authManager yii\rbac\ManagerInterface|null 权限管理器应用程序组件,如果未配置则为 null。 yii\base\Application
$basePath string 应用程序的根目录。 yii\base\Application
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$bootstrap array 应在应用程序 引导过程中 运行的组件列表。 yii\base\Application
$cache yii\caching\CacheInterface|null 缓存应用程序组件。 yii\base\Application
$charset string 当前用于应用程序的字符集。 yii\base\Application
$components array 组件定义或已加载的组件实例列表 (ID => 定义或实例)。 yii\di\ServiceLocator
$container array 以名称-值对形式给出的值。 yii\base\Application
$controller yii\base\Controller 当前活动的控制器实例 yii\base\Application
$controllerMap array 从控制器 ID 到控制器配置的映射。 yii\base\Module
$controllerNamespace string 控制器类所在的命名空间。 yii\base\Application
$controllerPath string 包含控制器类的目录。 yii\base\Module
$db yii\db\Connection 数据库连接。 yii\base\Application
$defaultRoute string 此模块的默认路由。 yii\base\Module
$errorHandler yii\web\ErrorHandler|yii\console\ErrorHandler 错误处理程序应用程序组件。 yii\base\Application
$extensions array|null 已安装的 Yii 扩展列表。 yii\base\Application
$formatter yii\i18n\Formatter 格式化程序应用程序组件。 yii\base\Application
$i18n yii\i18n\I18N 国际化应用程序组件。 yii\base\Application
$id string 一个 ID,用于在具有相同 父级 的其他模块中唯一标识此模块。 yii\base\Module
$language string 打算用于最终用户的语言。 yii\base\Application
$layout string|boolean 应用于此应用程序中视图的布局。 yii\base\Application
$layoutPath string 布局文件的根目录。 yii\base\Module
$loadedModules array 已加载的模块列表,按其类名索引。 yii\base\Application
$log yii\log\Dispatcher 日志分发器应用程序组件。 yii\base\Application
$mailer yii\mail\MailerInterface 邮件发送器应用程序组件。 yii\base\Application
$module yii\base\Module|null 此模块的父模块。 yii\base\Module
$modules array 模块(按其 ID 索引)。 yii\base\Module
$name string 应用程序名称。 yii\base\Application
$params array 自定义模块参数(名称 => 值)。 yii\base\Module
$request yii\web\Request|yii\console\Request 请求组件。 yii\base\Application
$requestedAction yii\base\Action|null 请求的动作。 yii\base\Application
$requestedParams array 提供给请求动作的参数。 yii\base\Application
$requestedRoute string 请求的路由 yii\base\Application
$response yii\web\Response|yii\console\Response 响应组件。 yii\base\Application
$runtimePath string 存储运行时文件的目录。 yii\base\Application
$security yii\base\Security 安全应用程序组件。 yii\base\Application
$sourceLanguage string 应用程序编写的语言。 yii\base\Application
$state integer 请求处理生命周期中的当前应用程序状态。 yii\base\Application
$timeZone string 此应用程序使用的时间区域。 yii\base\Application
$uniqueId string 模块的唯一 ID。 yii\base\Application
$urlManager yii\web\UrlManager 此应用程序的 URL 管理器。 yii\base\Application
$vendorPath string 存储供应商文件的目录。 yii\base\Application
$version string 此模块的版本。 yii\base\Module
$view yii\base\View|yii\web\View 用于渲染各种视图文件的视图应用程序组件。 yii\base\Application
$viewPath string 视图文件的根目录。 yii\base\Module

公共方法

隐藏继承方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法在通过克隆现有对象创建对象后被调用。 yii\base\Component
__construct() 构造函数。 yii\base\Application
__get() Getter 魔术方法。 yii\di\ServiceLocator
__isset() 检查属性值是否为 null。 yii\di\ServiceLocator
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
afterAction() 此方法在执行此模块中的操作后立即调用。 yii\base\Module
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
beforeAction() 此方法在执行此模块中的操作之前立即调用。 yii\base\Module
behaviors() 返回此组件应表现为的行为列表。 yii\base\Component
canGetProperty() 返回一个值,指示是否可以读取属性。 yii\base\Component
canSetProperty() 返回一个值,指示是否可以设置属性。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
clear() 从定位器中移除组件。 yii\di\ServiceLocator
coreComponents() 返回核心应用程序组件的配置。 yii\base\Application
createController() 根据给定的路由创建控制器实例。 yii\base\Module
createControllerByID() 根据给定的控制器 ID 创建控制器。 yii\base\Module
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
end() 终止应用程序。 yii\base\Application
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
get() 返回具有指定 ID 的组件实例。 yii\base\Module
getAssetManager() 返回资产管理器。 yii\base\Application
getAuthManager() 返回此应用程序的权限管理器。 yii\base\Application
getBasePath() 返回模块的根目录。 yii\base\Module
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getCache() 返回缓存组件。 yii\base\Application
getComponents() 返回组件定义或已加载的组件实例列表。 yii\di\ServiceLocator
getControllerPath() 根据 $controllerNamespace 返回包含控制器类的目录。 yii\base\Module
getDb() 返回数据库连接组件。 yii\base\Application
getErrorHandler() 返回错误处理程序组件。 yii\base\Application
getFormatter() 返回格式化程序组件。 yii\base\Application
getI18n() 返回国际化 (i18n) 组件。 yii\base\Application
getInstance() 返回当前请求的此模块类的实例。 yii\base\Module
getLayoutPath() 返回包含此模块布局视图文件的目录。 yii\base\Module
getLog() 返回日志调度程序组件。 yii\base\Application
getMailer() 返回邮件发送器组件。 yii\base\Application
getModule() 检索指定 ID 的子模块。 yii\base\Module
getModules() 返回此模块中的子模块。 yii\base\Module
getRequest() 返回请求组件。 yii\base\Application
getResponse() 返回响应组件。 yii\base\Application
getRuntimePath() 返回存储运行时文件的目录。 yii\base\Application
getSecurity() 返回安全组件。 yii\base\Application
getTimeZone() 返回此应用程序使用的时区。 yii\base\Application
getUniqueId() 返回一个 ID,该 ID 在当前应用程序中的所有模块中唯一标识此模块。 yii\base\Application
getUrlManager() 返回此应用程序的 URL 管理器。 yii\base\Application
getVendorPath() 返回存储供应商文件的目录。 yii\base\Application
getVersion() 返回当前模块版本。 yii\base\Module
getView() 返回视图对象。 yii\base\Application
getViewPath() 返回包含此模块视图文件的目录。 yii\base\Module
handleRequest() 处理指定的请求。 yii\base\Application
has() 返回一个值,指示定位器是否具有指定的组件定义或已实例化组件。 yii\base\Module
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到指定的事件。 yii\base\Component
hasMethod() 返回一个值,指示是否定义了方法。 yii\base\Component
hasModule() 检查指定 ID 的子模块是否存在。 yii\base\Module
hasProperty() 返回一个值,指示是否为该组件定义了属性。 yii\base\Component
init() 初始化模块。 yii\base\Application
off() 从此组件分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
preInit() 预初始化应用程序。 yii\base\Application
run() 运行应用程序。 yii\base\Application
runAction() 运行由路由指定的控制器操作。 yii\base\Module
set() 使用此定位器注册组件定义。 yii\di\ServiceLocator
setAliases() 定义路径别名。 yii\base\Module
setBasePath() 设置应用程序的根目录和 @app 别名。 yii\base\Application
setComponents() 在此定位器中注册一组组件定义。 yii\di\ServiceLocator
setContainer() 使用 $config 配置 Yii::$container yii\base\Application
setControllerPath() 设置包含控制器类的目录。 yii\base\Module
setInstance() 设置当前请求的此模块类的实例。 yii\base\Module
setLayoutPath() 设置包含布局文件的目录。 yii\base\Module
setModule() 向此模块添加子模块。 yii\base\Module
setModules() 在当前模块中注册子模块。 yii\base\Module
setRuntimePath() 设置存储运行时文件的目录。 yii\base\Application
setTimeZone() 设置此应用程序使用的时区。 yii\base\Application
setVendorPath() 设置存储供应商文件的目录。 yii\base\Application
setVersion() 设置当前模块版本。 yii\base\Module
setViewPath() 设置包含视图文件的目录。 yii\base\Module
trigger() 触发事件。 yii\base\Component

受保护的方法

隐藏继承方法

方法 描述 定义于
bootstrap() 初始化扩展并执行引导组件。 yii\base\Application
defaultVersion() 返回默认模块版本。 yii\base\Module
registerErrorHandler() 将 errorHandler 组件注册为 PHP 错误处理程序。 yii\base\Application

事件

隐藏继承的事件

事件 类型 描述 定义于
EVENT_AFTER_ACTION yii\base\ActionEvent 执行控制器操作后触发的事件。 yii\base\Module
EVENT_AFTER_REQUEST yii\base\Event 应用程序成功处理请求后(在发送响应之前)触发的事件。 yii\base\Application
EVENT_BEFORE_ACTION yii\base\ActionEvent 执行控制器操作之前触发的事件。 yii\base\Module
EVENT_BEFORE_REQUEST yii\base\Event 应用程序开始处理请求之前触发的事件。 yii\base\Application

常量

隐藏继承的常量

常量 描述 定义于
STATE_AFTER_REQUEST 4 $state 使用的应用程序状态:应用程序正在触发 EVENT_AFTER_REQUEST yii\base\Application
STATE_BEFORE_REQUEST 2 $state 使用的应用程序状态:应用程序正在触发 EVENT_BEFORE_REQUEST yii\base\Application
STATE_BEGIN 0 $state 使用的应用程序状态:应用程序刚刚启动。 yii\base\Application
STATE_END 6 $state 使用的应用程序状态:应用程序已结束。 yii\base\Application
STATE_HANDLING_REQUEST 3 $state 使用的应用程序状态:应用程序正在处理请求。 yii\base\Application
STATE_INIT 1 $state 使用的应用程序状态:应用程序正在初始化。 yii\base\Application
STATE_SENDING_RESPONSE 5 $state 使用的应用程序状态:应用程序即将发送响应。 yii\base\Application

属性详细信息

隐藏继承属性

$assetManager 公共属性

资产管理器应用程序组件。

$authManager 公共属性

权限管理器应用程序组件,如果未配置则为 null。

$basePath 公共属性

应用程序的根目录。

public string $basePath null
$bootstrap 公共属性

应在应用程序 引导过程中 运行的组件列表。

每个组件都可以以下列格式之一指定

  • 通过 $components 指定的应用程序组件 ID。
  • 通过 $modules 指定的模块 ID。
  • 类名。
  • 配置数组。
  • 闭包

在引导过程中,每个组件都将被实例化。如果组件类实现了 yii\base\BootstrapInterface,则其 bootstrap() 方法也将被调用。

public array $bootstrap = []
$cache 公共属性

缓存应用程序组件。如果组件未启用,则为 null。

$charset 公共属性

当前用于应用程序的字符集。

public string $charset 'UTF-8'
$container 公共属性

以名称-值对形式给出的值。

public 数组 $container null
$controller 公共属性

当前活动的控制器实例

$controllerNamespace 公共属性

控制器类所在的命名空间。此命名空间将用于通过将其添加到控制器类名前来加载控制器类。默认命名空间为 app\controllers

有关更多详细信息,请参阅 有关类自动加载的指南

public 字符串 $controllerNamespace 'app\controllers'
$db 公共属性

数据库连接。

public yii\db\Connection $db null
$errorHandler 公共属性

错误处理程序应用程序组件。

$extensions 公共属性

已安装的 Yii 扩展列表。每个数组元素代表一个扩展,具有以下结构

[
    'name' => 'extension name',
    'version' => 'version number',
    'bootstrap' => 'BootstrapClassName',  // optional, may also be a configuration array
    'alias' => [
        '@alias1' => 'to/path1',
        '@alias2' => 'to/path2',
    ],
]

上面列出的“bootstrap”类将在应用程序 引导过程中 实例化。如果该类实现了 yii\base\BootstrapInterface,则也会调用其 bootstrap() 方法。

如果未在应用程序配置中显式设置,则此属性将使用 @vendor/yiisoft/extensions.php 的内容填充。

public 数组|null $extensions null
$formatter 公共属性

格式化程序应用程序组件。

$i18n 公共属性

国际化应用程序组件。

public yii\i18n\I18N $i18n null
$language 公共属性

用于最终用户的语言。建议您使用 IETF 语言标签。例如,en 代表英语,而 en-US 代表英语(美国)。

另请参阅 $sourceLanguage

public 字符串 $language 'en-US'
$layout 公共属性

应用于此应用程序中视图的布局。默认为“main”。如果为 false,则布局将被禁用。

public 字符串|布尔值 $layout 'main'
$loadedModules 公共属性

已加载的模块列表,按其类名索引。

public 数组 $loadedModules = []
$log 公共属性

日志分发器应用程序组件。

public yii\log\Dispatcher $log null
$mailer 公共属性

邮件发送器应用程序组件。

$name 公共属性

应用程序名称。

public 字符串 $name '我的应用程序'
$request 公共属性

请求组件。

$requestedAction 公共属性

请求的操作。如果为 null,则表示请求无法解析为操作。

$requestedParams 公共属性

提供给请求动作的参数。

public array $requestedParams null
$requestedRoute 公共属性

请求的路由

public string $requestedRoute null
$response 公共属性

响应组件。

$runtimePath 公共属性

存储运行时文件的目录。默认为 $basePath 下的 "runtime" 子目录。

public string $runtimePath null
$security 公共属性

安全应用程序组件。

$sourceLanguage 公共属性

应用程序的编写语言。这主要指的是消息和视图文件编写的语言。

另请参阅 $language

public string $sourceLanguage 'en-US'
$state 公共属性

请求处理生命周期中的当前应用程序状态。此属性由应用程序管理。请勿修改此属性。

public integer $state null
$timeZone 公共属性

此应用程序使用的时间区域。

public string $timeZone null
$uniqueId 公共属性

模块的唯一 ID。

public string $uniqueId null
$urlManager 公共属性

此应用程序的 URL 管理器。

$vendorPath 公共属性

存储供应商文件的目录。默认为 $basePath 下的 "vendor" 目录。

public string $vendorPath null
$view 公共属性

用于渲染各种视图文件的视图应用程序组件。

方法详情

隐藏继承方法

__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 ( $config = [] )
$config array

用于初始化对象属性的名称-值对。请注意,配置必须同时包含 $id$basePath

抛出异常 yii\base\InvalidConfigException

如果缺少 $id$basePath 配置。

                public function __construct($config = [])
{
    Yii::$app = $this;
    static::setInstance($this);
    $this->state = self::STATE_BEGIN;
    $this->preInit($config);
    $this->registerErrorHandler($config);
    Component::__construct($config);
}

            
__get() 公共方法

定义于: yii\di\ServiceLocator::__get()

Getter 魔术方法。

此方法被重写以支持像读取属性一样访问组件。

public mixed __get ( $name )
$name string

组件或属性名称

返回值 mixed

命名的属性值

                public function __get($name)
{
    if ($this->has($name)) {
        return $this->get($name);
    }
    return parent::__get($name);
}

            
__isset() 公共方法

定义于: yii\di\ServiceLocator::__isset()

检查属性值是否为 null。

此方法重写了父类的实现,通过检查命名的组件是否已加载。

public boolean __isset ( $name )
$name string

属性名称或事件名称

返回值 boolean

属性值是否为 null

                public function __isset($name)
{
    if ($this->has($name)) {
        return true;
    }
    return parent::__isset($name);
}

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

            
afterAction() 公共方法

定义于: yii\base\Module::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;
}

            
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\base\Module::beforeAction()

此方法在执行此模块中的操作之前立即调用。

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

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

如果您重写此方法,您的代码应如下所示

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

    // your 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)
{
    $event = new ActionEvent($action);
    $this->trigger(self::EVENT_BEFORE_ACTION, $event);
    return $event->isValid;
}

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

            
bootstrap() 受保护方法

初始化扩展并执行引导组件。

此方法由 init() 在应用程序完全配置后调用。如果覆盖此方法,请确保也调用父实现。

protected void bootstrap ( )

                protected function bootstrap()
{
    if ($this->extensions === null) {
        $file = Yii::getAlias('@vendor/yiisoft/extensions.php');
        $this->extensions = is_file($file) ? include $file : [];
    }
    foreach ($this->extensions as $extension) {
        if (!empty($extension['alias'])) {
            foreach ($extension['alias'] as $name => $path) {
                Yii::setAlias($name, $path);
            }
        }
        if (isset($extension['bootstrap'])) {
            $component = Yii::createObject($extension['bootstrap']);
            if ($component instanceof BootstrapInterface) {
                Yii::debug('Bootstrap with ' . get_class($component) . '::bootstrap()', __METHOD__);
                $component->bootstrap($this);
            } else {
                Yii::debug('Bootstrap with ' . get_class($component), __METHOD__);
            }
        }
    }
    foreach ($this->bootstrap as $mixed) {
        $component = null;
        if ($mixed instanceof \Closure) {
            Yii::debug('Bootstrap with Closure', __METHOD__);
            if (!$component = call_user_func($mixed, $this)) {
                continue;
            }
        } elseif (is_string($mixed)) {
            if ($this->has($mixed)) {
                $component = $this->get($mixed);
            } elseif ($this->hasModule($mixed)) {
                $component = $this->getModule($mixed);
            } elseif (strpos($mixed, '\\') === false) {
                throw new InvalidConfigException("Unknown bootstrapping component ID: $mixed");
            }
        }
        if (!isset($component)) {
            $component = Yii::createObject($mixed);
        }
        if ($component instanceof BootstrapInterface) {
            Yii::debug('Bootstrap with ' . get_class($component) . '::bootstrap()', __METHOD__);
            $component->bootstrap($this);
        } else {
            Yii::debug('Bootstrap with ' . get_class($component), __METHOD__);
        }
    }
}

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

            
clear() 公共方法

定义于: yii\di\ServiceLocator::clear()

从定位器中移除组件。

public void clear ( $id )
$id string

组件 ID

                public function clear($id)
{
    unset($this->_definitions[$id], $this->_components[$id]);
}

            
coreComponents() 公共方法

返回核心应用程序组件的配置。

另请参阅 set()

public array coreComponents ( )

                public function coreComponents()
{
    $components = [
        'log' => ['class' => 'yii\log\Dispatcher'],
        'view' => ['class' => 'yii\web\View'],
        'formatter' => ['class' => 'yii\i18n\Formatter'],
        'i18n' => ['class' => 'yii\i18n\I18N'],
        'urlManager' => ['class' => 'yii\web\UrlManager'],
        'assetManager' => ['class' => 'yii\web\AssetManager'],
        'security' => ['class' => 'yii\base\Security'],
    ];
    if (class_exists('yii\swiftmailer\Mailer')) {
        $components['mailer'] = ['class' => 'yii\swiftmailer\Mailer'];
    }
    return $components;
}

            
createController() 公共方法

定义于: yii\base\Module::createController()

根据给定的路由创建控制器实例。

路由应相对于此模块。该方法实现了以下算法来解析给定的路由

  1. 如果路由为空,则使用 $defaultRoute
  2. 如果路由的第一个段在 $controllerMap 中找到,则根据 $controllerMap 中找到的相应配置创建控制器;
  3. 如果路由的第一个段是 $modules 中声明的有效模块 ID,则使用路由的其余部分调用模块的 createController()
  4. 给定的路由格式为 abc/def/xyz。在 控制器命名空间 中尝试 abc\DefControllerabc\def\XyzController 类。

如果上述任何步骤都解析为控制器,则将其与将被视为操作 ID 的路由的其余部分一起返回。否则,将返回 false

public array|boolean createController ( $route )
$route string

由模块、控制器和操作 ID 组成的路由。

返回值 array|boolean

如果控制器创建成功,则将其与请求的操作 ID 一起返回。否则,将返回 false

抛出异常 yii\base\InvalidConfigException

如果控制器类及其文件不匹配。

                public function createController($route)
{
    if ($route === '') {
        $route = $this->defaultRoute;
    }
    // double slashes or leading/ending slashes may cause substr problem
    $route = trim($route, '/');
    if (strpos($route, '//') !== false) {
        return false;
    }
    if (strpos($route, '/') !== false) {
        list($id, $route) = explode('/', $route, 2);
    } else {
        $id = $route;
        $route = '';
    }
    // module and controller map take precedence
    if (isset($this->controllerMap[$id])) {
        $controller = Yii::createObject($this->controllerMap[$id], [$id, $this]);
        return [$controller, $route];
    }
    $module = $this->getModule($id);
    if ($module !== null) {
        return $module->createController($route);
    }
    if (($pos = strrpos($route, '/')) !== false) {
        $id .= '/' . substr($route, 0, $pos);
        $route = substr($route, $pos + 1);
    }
    $controller = $this->createControllerByID($id);
    if ($controller === null && $route !== '') {
        $controller = $this->createControllerByID($id . '/' . $route);
        $route = '';
    }
    return $controller === null ? false : [$controller, $route];
}

            
createControllerByID() 公共方法

定义于: yii\base\Module::createControllerByID()

根据给定的控制器 ID 创建控制器。

控制器 ID 相对于此模块。控制器类应在 $controllerNamespace 下命名。

请注意,此方法不会检查 $modules$controllerMap

public yii\base\Controller|null createControllerByID ( $id )
$id string

控制器 ID。

返回值 yii\base\Controller|null

新创建的控制器实例,如果控制器 ID 无效,则为 null

抛出异常 yii\base\InvalidConfigException

如果控制器类及其文件名不匹配。此异常仅在调试模式下抛出。

                public function createControllerByID($id)
{
    $pos = strrpos($id, '/');
    if ($pos === false) {
        $prefix = '';
        $className = $id;
    } else {
        $prefix = substr($id, 0, $pos + 1);
        $className = substr($id, $pos + 1);
    }
    if ($this->isIncorrectClassNameOrPrefix($className, $prefix)) {
        return null;
    }
    $className = preg_replace_callback('%-([a-z0-9_])%i', function ($matches) {
            return ucfirst($matches[1]);
    }, ucfirst($className)) . 'Controller';
    $className = ltrim($this->controllerNamespace . '\\' . str_replace('/', '\\', $prefix) . $className, '\\');
    if (strpos($className, '-') !== false || !class_exists($className)) {
        return null;
    }
    if (is_subclass_of($className, 'yii\base\Controller')) {
        $controller = Yii::createObject($className, [$id, $this]);
        return get_class($controller) === $className ? $controller : null;
    } elseif (YII_DEBUG) {
        throw new InvalidConfigException('Controller class must extend from \\yii\\base\\Controller.');
    }
    return null;
}

            
defaultVersion() 受保护方法 (自 2.0.11 版本起可用)

定义于: yii\base\Module::defaultVersion()

返回默认模块版本。

子类可以重写此方法以提供更具体的版本检测。

受保护 字符串 defaultVersion ( )
返回值 string

此模块的版本。

                protected function defaultVersion()
{
    if ($this->module === null) {
        return '1.0';
    }
    return $this->module->getVersion();
}

            
detachBehavior() 公共方法

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

从组件中分离行为。

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

公共 yii\base\Behavior| detachBehavior ( $name )
$name string

行为的名称。

返回值 yii\base\Behavior|

分离的行为。如果行为不存在,则为 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()

从组件中分离所有行为。

公共 detachBehaviors ( )

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

            
end() 公共方法

终止应用程序。

此方法用 exit() 函数替换,以确保在终止应用程序之前完成应用程序生命周期。

公共 end ( $status 0, $response null )
$status integer

退出状态(值 0 表示正常退出,其他值表示异常退出)。

$response yii\base\Response|

要发送的响应。如果未设置,则将使用默认的应用程序 $response 组件。

抛出异常 yii\base\ExitException

如果应用程序处于测试模式

                public function end($status = 0, $response = null)
{
    if ($this->state === self::STATE_BEFORE_REQUEST || $this->state === self::STATE_HANDLING_REQUEST) {
        $this->state = self::STATE_AFTER_REQUEST;
        $this->trigger(self::EVENT_AFTER_REQUEST);
    }
    if ($this->state !== self::STATE_SENDING_RESPONSE && $this->state !== self::STATE_END) {
        $this->state = self::STATE_END;
        $response = $response ?: $this->getResponse();
        $response->send();
    }
    if (YII_ENV_TEST) {
        throw new ExitException($status);
    }
    exit($status);
}

            
ensureBehaviors() 公共方法

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

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

公共 ensureBehaviors ( )

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

            
get() 公共方法

定义于: yii\base\Module::get()

返回具有指定 ID 的组件实例。

自 2.0.13 版本起,如果模块中未定义组件,则将在父模块中查找。父模块可能是应用程序。

公共 对象| get ( $id, $throwException true )
$id string

组件 ID(例如 db)。

$throwException boolean

如果 $id 之前未在定位器中注册,是否抛出异常。

返回值 对象|

指定 ID 的组件。如果 $throwException 为 false 且 $id 之前未注册,则返回 null。

抛出异常 yii\base\InvalidConfigException

如果 $id 指的是不存在的组件 ID

                public function get($id, $throwException = true)
{
    if (!isset($this->module)) {
        return parent::get($id, $throwException);
    }
    $component = parent::get($id, false);
    if ($component === null) {
        $component = $this->module->get($id, $throwException);
    }
    return $component;
}

            
getAssetManager() 公共方法

返回资产管理器。

公共 yii\web\AssetManager getAssetManager ( )
返回值 yii\web\AssetManager

资产管理器应用程序组件。

                public function getAssetManager()
{
    return $this->get('assetManager');
}

            
getAuthManager() 公共方法

返回此应用程序的权限管理器。

公共 yii\rbac\ManagerInterface| getAuthManager ( )
返回值 yii\rbac\ManagerInterface|null

权限管理器应用程序组件,如果未配置则为 null。

                public function getAuthManager()
{
    return $this->get('authManager', false);
}

            
getBasePath() 公共方法

定义于: yii\base\Module::getBasePath()

返回模块的根目录。

它默认为包含模块类文件的目录。

公共 字符串 getBasePath ( )
返回值 string

模块的根目录。

                public function getBasePath()
{
    if ($this->_basePath === null) {
        $class = new \ReflectionClass($this);
        $this->_basePath = dirname($class->getFileName());
    }
    return $this->_basePath;
}

            
getBehavior() 公共方法

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

返回命名的行为对象。

公共 yii\base\Behavior| getBehavior ( $name )
$name string

行为名称

返回值 yii\base\Behavior|

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

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

            
getBehaviors() 公共方法

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

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

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

附加到此组件的行为列表

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

            
getCache() 公共方法

返回缓存组件。

公共 yii\caching\CacheInterface| getCache ( )
返回值 yii\caching\CacheInterface|null

缓存应用程序组件。如果组件未启用,则为 null。

                public function getCache()
{
    return $this->get('cache', false);
}

            
getComponents() 公共方法

定义于: yii\di\ServiceLocator::getComponents()

返回组件定义或已加载的组件实例列表。

公共 数组 getComponents ( $returnDefinitions true )
$returnDefinitions boolean

是否返回组件定义而不是加载的组件实例。

返回值 array

组件定义或已加载的组件实例列表 (ID => 定义或实例)。

                public function getComponents($returnDefinitions = true)
{
    return $returnDefinitions ? $this->_definitions : $this->_components;
}

            
getControllerPath() 公共方法

定义于: yii\base\Module::getControllerPath()

根据 $controllerNamespace 返回包含控制器类的目录。

请注意,为了使此方法返回值,您必须为 $controllerNamespace 的根命名空间定义一个别名。

public 字符串 getControllerPath ( )
返回值 string

包含控制器类的目录。

抛出异常 yii\base\InvalidArgumentException

如果未为 $controllerNamespace 的根命名空间定义别名。

                public function getControllerPath()
{
    if ($this->_controllerPath === null) {
        $this->_controllerPath = Yii::getAlias('@' . str_replace('\\', '/', $this->controllerNamespace));
    }
    return $this->_controllerPath;
}

            
getDb() 公共方法

返回数据库连接组件。

public yii\db\Connection getDb ( )
返回值 yii\db\Connection

数据库连接。

                public function getDb()
{
    return $this->get('db');
}

            
getErrorHandler() 公共方法

返回错误处理程序组件。

public yii\web\ErrorHandler|yii\console\ErrorHandler getErrorHandler ( )
返回值 yii\web\ErrorHandler|yii\console\ErrorHandler

错误处理程序应用程序组件。

                public function getErrorHandler()
{
    return $this->get('errorHandler');
}

            
getFormatter() 公共方法

返回格式化程序组件。

public yii\i18n\Formatter getFormatter ( )
返回值 yii\i18n\Formatter

格式化程序应用程序组件。

                public function getFormatter()
{
    return $this->get('formatter');
}

            
getI18n() 公共方法

返回国际化 (i18n) 组件。

public yii\i18n\I18N getI18n ( )
返回值 yii\i18n\I18N

国际化应用程序组件。

                public function getI18n()
{
    return $this->get('i18n');
}

            
getInstance() 公共静态方法

定义于: yii\base\Module::getInstance()

返回当前请求的此模块类的实例。

如果模块类当前未被请求,则将返回 null。提供此方法是为了您可以在模块内的任何位置访问模块实例。

public static 静态| null getInstance ( )
返回值 静态| null

此模块类的当前请求实例,如果模块类未被请求,则为 null

                public static function getInstance()
{
    $class = get_called_class();
    return isset(Yii::$app->loadedModules[$class]) ? Yii::$app->loadedModules[$class] : null;
}

            
getLayoutPath() 公共方法

定义于: yii\base\Module::getLayoutPath()

返回包含此模块布局视图文件的目录。

public 字符串 getLayoutPath ( )
返回值 string

布局文件的根目录。默认为 "$viewPath/layouts"。

                public function getLayoutPath()
{
    if ($this->_layoutPath === null) {
        $this->_layoutPath = $this->getViewPath() . DIRECTORY_SEPARATOR . 'layouts';
    }
    return $this->_layoutPath;
}

            
getLog() 公共方法

返回日志调度程序组件。

public yii\log\Dispatcher getLog ( )
返回值 yii\log\Dispatcher

日志分发器应用程序组件。

                public function getLog()
{
    return $this->get('log');
}

            
getMailer() 公共方法

返回邮件发送器组件。

public yii\mail\MailerInterface getMailer ( )
返回值 yii\mail\MailerInterface

邮件发送器应用程序组件。

抛出异常 yii\base\InvalidConfigException

如果此组件未配置。

                public function getMailer()
{
    return $this->get('mailer');
}

            
getModule() 公共方法

定义于: yii\base\Module::getModule()

检索指定 ID 的子模块。

此方法支持检索子模块和孙子模块。

另请参阅 hasModule()

public yii\base\Module|null getModule ( $id, $load true )
$id string

模块 ID(区分大小写)。要检索孙子模块,请使用相对于此模块的 ID 路径(例如 admin/content)。

$load boolean

是否加载尚未加载的模块。

返回值 yii\base\Module|null

模块实例,如果模块不存在,则为 null

                public function getModule($id, $load = true)
{
    if (($pos = strpos($id, '/')) !== false) {
        // sub-module
        $module = $this->getModule(substr($id, 0, $pos));
        return $module === null ? null : $module->getModule(substr($id, $pos + 1), $load);
    }
    if (isset($this->_modules[$id])) {
        if ($this->_modules[$id] instanceof self) {
            return $this->_modules[$id];
        } elseif ($load) {
            Yii::debug("Loading module: $id", __METHOD__);
            /* @var $module Module */
            $module = Yii::createObject($this->_modules[$id], [$id, $this]);
            $module::setInstance($module);
            return $this->_modules[$id] = $module;
        }
    }
    return null;
}

            
getModules() 公共方法

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

返回此模块中的子模块。

public 数组 getModules ( $loadedOnly false )
$loadedOnly boolean

是否仅返回已加载的子模块。如果将其设置为 false,则将返回在此模块中注册的所有子模块,无论它们是否已加载。已加载的模块将作为对象返回,而未加载的模块将作为配置数组返回。

返回值 array

模块(按其 ID 索引)。

                public function getModules($loadedOnly = false)
{
    if ($loadedOnly) {
        $modules = [];
        foreach ($this->_modules as $module) {
            if ($module instanceof self) {
                $modules[] = $module;
            }
        }
        return $modules;
    }
    return $this->_modules;
}

            
getRequest() 公共方法

返回请求组件。

public yii\web\Request|yii\console\Request getRequest ( )
返回值 yii\web\Request|yii\console\Request

请求组件。

                public function getRequest()
{
    return $this->get('request');
}

            
getResponse() 公共方法

返回响应组件。

public yii\web\Response|yii\console\Response getResponse ( )
返回值 yii\web\Response|yii\console\Response

响应组件。

                public function getResponse()
{
    return $this->get('response');
}

            
getRuntimePath() 公共方法

返回存储运行时文件的目录。

public 字符串 getRuntimePath ( )
返回值 string

存储运行时文件的目录。默认为 $basePath 下的 "runtime" 子目录。

                public function getRuntimePath()
{
    if ($this->_runtimePath === null) {
        $this->setRuntimePath($this->getBasePath() . DIRECTORY_SEPARATOR . 'runtime');
    }
    return $this->_runtimePath;
}

            
getSecurity() 公共方法

返回安全组件。

public yii\base\Security getSecurity ( )
返回值 yii\base\Security

安全应用程序组件。

                public function getSecurity()
{
    return $this->get('security');
}

            
getTimeZone() 公共方法

返回此应用程序使用的时区。

这是 PHP 函数 date_default_timezone_get() 的简单封装。如果在 php.ini 或应用程序配置中未配置时区,则默认设置为 UTC。

另请参阅 https://php.ac.cn/manual/en/function.date-default-timezone-get.php

public string getTimeZone ( )
返回值 string

此应用程序使用的时间区域。

                public function getTimeZone()
{
    return date_default_timezone_get();
}

            
getUniqueId() 公共方法

返回一个 ID,该 ID 在当前应用程序中的所有模块中唯一标识此模块。

由于这是一个应用程序实例,因此它将始终返回空字符串。

public string getUniqueId ( )
返回值 string

模块的唯一 ID。

                public function getUniqueId()
{
    return '';
}

            
getUrlManager() 公共方法

返回此应用程序的 URL 管理器。

public yii\web\UrlManager getUrlManager ( )
返回值 yii\web\UrlManager

此应用程序的 URL 管理器。

                public function getUrlManager()
{
    return $this->get('urlManager');
}

            
getVendorPath() 公共方法

返回存储供应商文件的目录。

public string getVendorPath ( )
返回值 string

存储供应商文件的目录。默认为 $basePath 下的 "vendor" 目录。

                public function getVendorPath()
{
    if ($this->_vendorPath === null) {
        $this->setVendorPath($this->getBasePath() . DIRECTORY_SEPARATOR . 'vendor');
    }
    return $this->_vendorPath;
}

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

定义于: yii\base\Module::getVersion()

返回当前模块版本。

如果版本没有显式设置,则将使用 defaultVersion() 方法来确定其值。

public string getVersion ( )
返回值 string

此模块的版本。

                public function getVersion()
{
    if ($this->_version === null) {
        $this->_version = $this->defaultVersion();
    } else {
        if (!is_scalar($this->_version)) {
            $this->_version = call_user_func($this->_version, $this);
        }
    }
    return $this->_version;
}

            
getView() 公共方法

返回视图对象。

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

用于渲染各种视图文件的视图应用程序组件。

                public function getView()
{
    return $this->get('view');
}

            
getViewPath() 公共方法

定义于: yii\base\Module::getViewPath()

返回包含此模块视图文件的目录。

public string getViewPath ( )
返回值 string

视图文件的根目录。默认为 "$basePath/views"。

                public function getViewPath()
{
    if ($this->_viewPath === null) {
        $this->_viewPath = $this->getBasePath() . DIRECTORY_SEPARATOR . 'views';
    }
    return $this->_viewPath;
}

            
handleRequest() 公共抽象方法

处理指定的请求。

此方法应返回 yii\base\Response 或其子类的实例,该实例表示请求处理的结果。

public abstract yii\base\Response handleRequest ( $request )
$request yii\base\Request

要处理的请求

返回值 yii\base\Response

结果响应

                abstract public function handleRequest($request);

            
has() 公共方法

定义于: yii\base\Module::has()

返回一个值,指示定位器是否具有指定的组件定义或已实例化组件。

自 2.0.13 版本起,如果模块中未定义组件,则将在父模块中查找。父模块可能是应用程序。

此方法可能会根据 $checkInstance 的值返回不同的结果。

  • 如果 $checkInstance 为 false(默认值),则该方法将返回一个值,指示定位器是否具有指定的组件定义。
  • 如果 $checkInstance 为 true,则该方法将返回一个值,指示定位器是否已实例化指定的组件。
public boolean has ( $id, $checkInstance false )
$id string

组件 ID(例如 db)。

$checkInstance boolean

该方法是否应该检查组件是否已共享并实例化。

返回值 boolean

定位器是否具有指定的组件定义或已实例化该组件。

                public function has($id, $checkInstance = false)
{
    return parent::has($id, $checkInstance) || (isset($this->module) && $this->module->has($id, $checkInstance));
}

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

            
hasModule() 公共方法

定义于: yii\base\Module::hasModule()

检查指定 ID 的子模块是否存在。

此方法支持检查子模块和孙子模块的存在性。

public boolean hasModule ( $id )
$id string

模块 ID。对于孙子模块,请使用相对于此模块的 ID 路径(例如 admin/content)。

返回值 boolean

检查指定模块是否存在。已加载和未加载的模块都将被考虑。

                public function hasModule($id)
{
    if (($pos = strpos($id, '/')) !== false) {
        // sub-module
        $module = $this->getModule(substr($id, 0, $pos));
        return $module === null ? false : $module->hasModule(substr($id, $pos + 1));
    }
    return isset($this->_modules[$id]);
}

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

初始化模块。

此方法在模块创建并使用配置中给定的属性值进行初始化后调用。默认实现将初始化 $controllerNamespace(如果未设置)。

如果覆盖此方法,请确保调用父实现。

public void init ( )

                public function init()
{
    $this->state = self::STATE_INIT;
    $this->bootstrap();
}

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

            
preInit() 公共方法

预初始化应用程序。

此方法在应用程序构造函数的开头调用。它初始化几个重要的应用程序属性。如果覆盖此方法,请确保调用父实现。

public void preInit ( &$config )
$config array

应用程序配置

抛出异常 yii\base\InvalidConfigException

如果缺少 $id$basePath 配置。

                public function preInit(&$config)
{
    if (!isset($config['id'])) {
        throw new InvalidConfigException('The "id" configuration for the Application is required.');
    }
    if (isset($config['basePath'])) {
        $this->setBasePath($config['basePath']);
        unset($config['basePath']);
    } else {
        throw new InvalidConfigException('The "basePath" configuration for the Application is required.');
    }
    if (isset($config['vendorPath'])) {
        $this->setVendorPath($config['vendorPath']);
        unset($config['vendorPath']);
    } else {
        // set "@vendor"
        $this->getVendorPath();
    }
    if (isset($config['runtimePath'])) {
        $this->setRuntimePath($config['runtimePath']);
        unset($config['runtimePath']);
    } else {
        // set "@runtime"
        $this->getRuntimePath();
    }
    if (isset($config['timeZone'])) {
        $this->setTimeZone($config['timeZone']);
        unset($config['timeZone']);
    } elseif (!ini_get('date.timezone')) {
        $this->setTimeZone('UTC');
    }
    if (isset($config['container'])) {
        $this->setContainer($config['container']);
        unset($config['container']);
    }
    // merge core components with custom components
    foreach ($this->coreComponents() as $id => $component) {
        if (!isset($config['components'][$id])) {
            $config['components'][$id] = $component;
        } elseif (is_array($config['components'][$id]) && !isset($config['components'][$id]['class'])) {
            $config['components'][$id]['class'] = $component['class'];
        }
    }
}

            
registerErrorHandler() 受保护方法

将 errorHandler 组件注册为 PHP 错误处理程序。

protected void registerErrorHandler ( &$config )
$config array

应用程序配置

                protected function registerErrorHandler(&$config)
{
    if (YII_ENABLE_ERROR_HANDLER) {
        if (!isset($config['components']['errorHandler']['class'])) {
            echo "Error: no errorHandler component is configured.\n";
            exit(1);
        }
        $this->set('errorHandler', $config['components']['errorHandler']);
        unset($config['components']['errorHandler']);
        $this->getErrorHandler()->register();
    }
}

            
run() 公共方法

运行应用程序。

这是应用程序的主入口。

public integer run ( )
返回值 integer

退出状态(0 表示正常,非零值表示异常)

                public function run()
{
    try {
        $this->state = self::STATE_BEFORE_REQUEST;
        $this->trigger(self::EVENT_BEFORE_REQUEST);
        $this->state = self::STATE_HANDLING_REQUEST;
        $response = $this->handleRequest($this->getRequest());
        $this->state = self::STATE_AFTER_REQUEST;
        $this->trigger(self::EVENT_AFTER_REQUEST);
        $this->state = self::STATE_SENDING_RESPONSE;
        $response->send();
        $this->state = self::STATE_END;
        return $response->exitStatus;
    } catch (ExitException $e) {
        $this->end($e->statusCode, isset($response) ? $response : null);
        return $e->statusCode;
    }
}

            
runAction() 公共方法

定义于: yii\base\Module::runAction()

运行由路由指定的控制器操作。

此方法解析指定的路由并创建相应的子模块、控制器和操作实例。然后,它调用 yii\base\Controller::runAction() 使用给定的参数运行操作。如果路由为空,则该方法将使用 $defaultRoute

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

指定操作的路由。

$params array

要传递给操作的参数

返回值 mixed

操作的结果。

抛出异常 yii\base\InvalidRouteException

如果无法将请求的路由成功解析为操作。

                public function runAction($route, $params = [])
{
    $parts = $this->createController($route);
    if (is_array($parts)) {
        /* @var $controller Controller */
        list($controller, $actionID) = $parts;
        $oldController = Yii::$app->controller;
        Yii::$app->controller = $controller;
        $result = $controller->runAction($actionID, $params);
        if ($oldController !== null) {
            Yii::$app->controller = $oldController;
        }
        return $result;
    }
    $id = $this->getUniqueId();
    throw new InvalidRouteException('Unable to resolve the request "' . ($id === '' ? $route : $id . '/' . $route) . '".');
}

            
set() 公共方法

定义于: yii\di\ServiceLocator::set()

使用此定位器注册组件定义。

例如,

// a class name
$locator->set('cache', 'yii\caching\FileCache');

// a configuration array
$locator->set('db', [
    'class' => 'yii\db\Connection',
    'dsn' => 'mysql:host=127.0.0.1;dbname=demo',
    'username' => 'root',
    'password' => '',
    'charset' => 'utf8',
]);

// an anonymous function
$locator->set('cache', function ($params) {
    return new \yii\caching\FileCache;
});

// an instance
$locator->set('cache', new \yii\caching\FileCache);

如果已存在具有相同 ID 的组件定义,它将被覆盖。

public void set ( $id, $definition )
$id string

组件 ID(例如 db)。

$definition mixed

要与此定位器一起注册的组件定义。它可以是以下之一:

  • 类名
  • 配置数组:该数组包含名称-值对,这些对将在调用 get() 时用于初始化新创建对象的属性值。class 元素是必需的,代表要创建的对象的类。
  • PHP 可调用对象:匿名函数或表示类方法的数组(例如 ['Foo', 'bar'])。可调用对象将由 get() 调用以返回与指定组件 ID 关联的对象。
  • 对象:调用 get() 时,将返回此对象。
抛出异常 yii\base\InvalidConfigException

如果定义是无效的配置数组,则

                public function set($id, $definition)
{
    unset($this->_components[$id]);
    if ($definition === null) {
        unset($this->_definitions[$id]);
        return;
    }
    if (is_object($definition) || is_callable($definition, true)) {
        // an object, a class name, or a PHP callable
        $this->_definitions[$id] = $definition;
    } elseif (is_array($definition)) {
        // a configuration array
        if (isset($definition['__class'])) {
            $this->_definitions[$id] = $definition;
            $this->_definitions[$id]['class'] = $definition['__class'];
            unset($this->_definitions[$id]['__class']);
        } elseif (isset($definition['class'])) {
            $this->_definitions[$id] = $definition;
        } else {
            throw new InvalidConfigException("The configuration for the \"$id\" component must contain a \"class\" element.");
        }
    } else {
        throw new InvalidConfigException("Unexpected configuration type for the \"$id\" component: " . gettype($definition));
    }
}

            
setAliases() 公共方法

定义于: yii\base\Module::setAliases()

定义路径别名。

此方法调用 Yii::setAlias() 来注册路径别名。提供此方法是为了在配置模块时定义路径别名。

public void setAliases ( $aliases )
$aliases array

要定义的路径别名列表。数组键是别名(必须以@开头),数组值是相应的路径或别名。例如,

[
    '@models' => '@app/models', // an existing alias
    '@backend' => __DIR__ . '/../backend',  // a directory
]

                public function setAliases($aliases)
{
    foreach ($aliases as $name => $alias) {
        Yii::setAlias($name, $alias);
    }
}

            
setBasePath() 公共方法

设置应用程序的根目录和 @app 别名。

此方法只能在构造函数的开头调用。

public void setBasePath ( $path )
$path string

应用程序的根目录。

抛出异常 yii\base\InvalidArgumentException

如果目录不存在。

                public function setBasePath($path)
{
    parent::setBasePath($path);
    Yii::setAlias('@app', $this->getBasePath());
}

            
setComponents() 公共方法

定义于: yii\di\ServiceLocator::setComponents()

在此定位器中注册一组组件定义。

这是 set() 的批量版本。参数应为一个数组,其键为组件 ID,值为相应的组件定义。

有关如何指定组件 ID 和定义的更多详细信息,请参阅 set()

如果已存在具有相同 ID 的组件定义,它将被覆盖。

以下是注册两个组件定义的示例

[
    'db' => [
        'class' => 'yii\db\Connection',
        'dsn' => 'sqlite:path/to/file.db',
    ],
    'cache' => [
        'class' => 'yii\caching\DbCache',
        'db' => 'db',
    ],
]
public void setComponents ( $components )
$components array

组件定义或实例

                public function setComponents($components)
{
    foreach ($components as $id => $component) {
        $this->set($id, $component);
    }
}

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

使用 $config 配置 Yii::$container

public void setContainer ( $config )
$config array

以名称-值对的形式给出的值

                public function setContainer($config)
{
    Yii::configure(Yii::$container, $config);
}

            
setControllerPath() 公共方法 (自版本 2.0.44 起可用)

定义于: yii\base\Module::setControllerPath()

设置包含控制器类的目录。

public void setControllerPath ( $path )
$path string

包含控制器类的根目录。

抛出异常 yii\base\InvalidArgumentException

如果目录无效。

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

            
setInstance() 公共静态方法

定义于: yii\base\Module::setInstance()

设置当前请求的此模块类的实例。

public static void setInstance ( $instance )
$instance yii\base\Module|null

此模块类的当前请求实例。如果它是null,则将删除调用类的实例(如果有)。

                public static function setInstance($instance)
{
    if ($instance === null) {
        unset(Yii::$app->loadedModules[get_called_class()]);
    } else {
        Yii::$app->loadedModules[get_class($instance)] = $instance;
    }
}

            
setLayoutPath() 公共方法

定义于: yii\base\Module::setLayoutPath()

设置包含布局文件的目录。

public void setLayoutPath ( $path )
$path string

布局文件的根目录或 路径别名

抛出异常 yii\base\InvalidArgumentException

如果目录无效

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

            
setModule() 公共方法

定义于: yii\base\Module::setModule()

向此模块添加子模块。

public void setModule ( $id, $module )
$id string

模块 ID。

$module yii\base\Module|数组|null

要添加到此模块的子模块。可以是以下之一:

  • 一个 yii\base\Module 对象
  • 一个配置数组:当最初调用 getModule() 时,该数组将用于实例化子模块
  • null:将从该模块中删除命名的子模块

                public function setModule($id, $module)
{
    if ($module === null) {
        unset($this->_modules[$id]);
    } else {
        $this->_modules[$id] = $module;
        if ($module instanceof self) {
            $module->module = $this;
        }
    }
}

            
setModules() 公共方法

定义于: yii\base\Module::setModules()

在当前模块中注册子模块。

每个子模块应指定为一个名称-值对,其中名称指的是模块的 ID,值是模块或可用于创建模块的配置数组。在后一种情况下,将使用 Yii::createObject() 创建模块。

如果新的子模块与现有子模块具有相同的 ID,则现有子模块将被静默覆盖。

以下是注册两个子模块的示例

[
    'comment' => [
        'class' => 'app\modules\comment\CommentModule',
        'db' => 'db',
    ],
    'booking' => ['class' => 'app\modules\booking\BookingModule'],
]
public void setModules ( $modules )
$modules array

模块(id => 模块配置或实例)。

                public function setModules($modules)
{
    foreach ($modules as $id => $module) {
        $this->_modules[$id] = $module;
        if ($module instanceof self) {
            $module->module = $this;
        }
    }
}

            
setRuntimePath() 公共方法

设置存储运行时文件的目录。

public void setRuntimePath ( $path )
$path string

存储运行时文件的目录。

                public function setRuntimePath($path)
{
    $this->_runtimePath = Yii::getAlias($path);
    Yii::setAlias('@runtime', $this->_runtimePath);
}

            
setTimeZone() 公共方法

设置此应用程序使用的时区。

这是 PHP 函数 date_default_timezone_set() 的简单包装器。有关可用的时区,请参阅 php 手册

另请参阅 https://php.ac.cn/manual/en/function.date-default-timezone-set.php

public void setTimeZone ( $value )
$value string

此应用程序使用的时间区域。

                public function setTimeZone($value)
{
    date_default_timezone_set($value);
}

            
setVendorPath() 公共方法

设置存储供应商文件的目录。

public void setVendorPath ( $path )
$path string

存储供应商文件的目录。

                public function setVendorPath($path)
{
    $this->_vendorPath = Yii::getAlias($path);
    Yii::setAlias('@vendor', $this->_vendorPath);
    Yii::setAlias('@bower', $this->_vendorPath . DIRECTORY_SEPARATOR . 'bower');
    Yii::setAlias('@npm', $this->_vendorPath . DIRECTORY_SEPARATOR . 'npm');
}

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

定义于: yii\base\Module::setVersion()

设置当前模块版本。

public void setVersion ( $version )
$version 字符串|可调用|null

此模块的版本。版本可以指定为 PHP 回调,它可以接受模块实例作为参数,并应返回实际版本。例如

function (Module $module) {
    //return string
}

                public function setVersion($version)
{
    $this->_version = $version;
}

            
setViewPath() 公共方法

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

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

public void setViewPath ( $path )
$path string

视图文件的根目录。

抛出异常 yii\base\InvalidArgumentException

如果目录无效。

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

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

            

事件详情

隐藏继承属性

EVENT_AFTER_REQUEST 类型为 yii\base\Event 的事件

应用程序成功处理请求后(在发送响应之前)触发的事件。

EVENT_BEFORE_REQUEST 类型为 yii\base\Event 的事件

应用程序开始处理请求之前触发的事件。