1 关注者

类 yii\base\Module

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

Module 是模块和应用类的基类。

一个模块代表一个子应用,它本身包含 MVC 元素,例如模型、视图、控制器等。

一个模块可能包含 子模块

组件 可以注册到模块中,以便在模块内全局访问。

有关 Module 的更多详细信息和用法信息,请参阅 模块指南文章

公共属性

隐藏继承属性

属性 类型 描述 定义于
$aliases array 要定义的路径别名列表。 yii\base\Module
$basePath string 模块的根目录。 yii\base\Module
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$components array 组件定义或已加载的组件实例列表(ID => 定义或实例)。 yii\di\ServiceLocator
$controllerMap array 控制器 ID 到控制器配置的映射。 yii\base\Module
$controllerNamespace string|null 控制器类所在的命名空间。 yii\base\Module
$controllerPath string 包含控制器类的目录。 yii\base\Module
$defaultRoute string 此模块的默认路由。 yii\base\Module
$id string 一个 ID,用于在具有相同 父级 的其他模块中唯一标识此模块。 yii\base\Module
$layout string|boolean|null 应应用于此模块内视图的布局。 yii\base\Module
$layoutPath string 布局文件的根目录。 yii\base\Module
$module yii\base\Module|null 此模块的父模块。 yii\base\Module
$modules array 模块(按其 ID 索引)。 yii\base\Module
$params array 自定义模块参数(名称 => 值)。 yii\base\Module
$uniqueId string 模块的唯一 ID。 yii\base\Module
$version string 此模块的版本。 yii\base\Module
$viewPath string 视图文件的根目录。 yii\base\Module

公共方法

隐藏继承方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法在通过克隆现有对象创建对象后调用。 yii\base\Component
__construct() 构造函数。 yii\base\Module
__get() Getter 魔术方法。 yii\di\ServiceLocator
__isset() 检查属性值是否为空。 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
createController() 根据给定的路由创建控制器实例。 yii\base\Module
createControllerByID() 根据给定的控制器 ID 创建控制器。 yii\base\Module
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为附加到此组件。 yii\base\Component
get() 返回具有指定 ID 的组件实例。 yii\base\Module
getBasePath() 返回模块的根目录。 yii\base\Module
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getComponents() 返回组件定义或已加载的组件实例列表。 yii\di\ServiceLocator
getControllerPath() 根据 $controllerNamespace 返回包含控制器类的目录。 yii\base\Module
getInstance() 返回此模块类的当前请求实例。 yii\base\Module
getLayoutPath() 返回包含此模块的布局视图文件的目录。 yii\base\Module
getModule() 检索指定 ID 的子模块。 yii\base\Module
getModules() 返回此模块中的子模块。 yii\base\Module
getUniqueId() 返回一个 ID,用于在当前应用程序中的所有模块中唯一标识此模块。 yii\base\Module
getVersion() 返回当前模块版本。 yii\base\Module
getViewPath() 返回包含此模块的视图文件的目录。 yii\base\Module
has() 返回一个值,指示定位器是否具有指定的组件定义或已实例化组件。 yii\base\Module
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到命名事件。 yii\base\Component
hasMethod() 返回一个值,指示方法是否已定义。 yii\base\Component
hasModule() 检查指定 ID 的子模块是否存在。 yii\base\Module
hasProperty() 返回一个值,指示是否为此组件定义了属性。 yii\base\Component
init() 初始化模块。 yii\base\Module
off() 从此组件中分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
runAction() 运行由路由指定的控制器操作。 yii\base\Module
set() 使用此定位器注册组件定义。 yii\di\ServiceLocator
setAliases() 定义路径别名。 yii\base\Module
setBasePath() 设置模块的根目录。 yii\base\Module
setComponents() 在此定位器中注册一组组件定义。 yii\di\ServiceLocator
setControllerPath() 设置包含控制器类的目录。 yii\base\Module
setInstance() 设置此模块类的当前请求实例。 yii\base\Module
setLayoutPath() 设置包含布局文件的目录。 yii\base\Module
setModule() 向此模块添加子模块。 yii\base\Module
setModules() 在当前模块中注册子模块。 yii\base\Module
setVersion() 设置当前模块版本。 yii\base\Module
setViewPath() 设置包含视图文件的目录。 yii\base\Module
trigger() 触发事件。 yii\base\Component

受保护方法

隐藏继承方法

方法 描述 定义于
defaultVersion() 返回默认模块版本。 yii\base\Module

事件

隐藏继承事件

事件 类型 描述 定义于
EVENT_AFTER_ACTION yii\base\ActionEvent 执行控制器操作后触发的事件。 yii\base\Module
EVENT_BEFORE_ACTION yii\base\ActionEvent 执行控制器操作前触发的事件。 yii\base\Module

属性详情

隐藏继承属性

$aliases 公共属性

要定义的路径别名列表。数组键是别名(必须以@开头),数组值是对应的路径或别名。请参阅setAliases()以了解示例。

public 数组 $aliases null
$basePath 公共属性

模块的根目录。

public 字符串 $basePath null
$controllerMap 公共属性

控制器 ID 到控制器配置的映射。每个名称-值对指定单个控制器的配置。控制器配置可以是字符串或数组。如果是前者,则字符串应为控制器的完全限定类名。如果是后者,则数组必须包含一个class元素,该元素指定控制器的完全限定类名,数组中其余的名称-值对用于初始化相应的控制器属性。例如,

[
  'account' => 'app\controllers\UserController',
  'article' => [
     'class' => 'app\controllers\PostController',
     'pageTitle' => 'something new',
  ],
]
public 数组 $controllerMap = []
$controllerNamespace 公共属性

控制器类所在的命名空间。此命名空间将用于通过在其前面添加控制器类名来加载控制器类。

如果未设置,它将使用此模块命名空间下的controllers子命名空间。例如,如果此模块的命名空间是foo\bar,则默认控制器命名空间将为foo\bar\controllers

另请参阅关于自动加载的指南部分,以了解有关定义命名空间以及如何加载类的更多信息。

$controllerPath 公共属性

包含控制器类的目录。

public 字符串 $controllerPath null
$defaultRoute 公共属性

此模块的默认路由。默认为default。路由可以包含子模块 ID、控制器 ID 和/或操作 ID。例如,helppost/createadmin/post/create。如果未给出操作 ID,它将采用yii\base\Controller::$defaultAction中指定的默认值。

public 字符串 $defaultRoute 'default'
$id 公共属性

一个 ID,用于在具有相同 父级 的其他模块中唯一标识此模块。

public 字符串 $id null
$layout 公共属性

应为此模块内的视图应用的布局。这指的是相对于$layoutPath的视图名称。如果未设置,则表示将采用父模块的布局值。如果为false,则在此模块内禁用布局。

$layoutPath 公共属性

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

public 字符串 $layoutPath null
$module 公共属性

此模块的父模块。如果此模块没有父模块,则为null

$modules 公共属性

模块(按其 ID 索引)。

public 数组 $modules null
$params 公共属性

自定义模块参数(名称 => 值)。

public 数组 $params = []
$uniqueId 公共属性

模块的唯一 ID。

public 字符串 $uniqueId null
$version 公共属性

此模块的版本。请注意,此属性在 getter 和 setter 中的类型不同。有关详细信息,请参阅 getVersion()setVersion()

public 字符串 $version null
$viewPath 公共属性

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

public 字符串 $viewPath null

方法详情

隐藏继承方法

__call() 公共方法

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

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

此方法将检查任何附加的行为是否具有命名方法,如果可用,则执行它。

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

public 混合 __call ( $name, $params )
$name string

方法名

$params array

方法参数

返回值 混合

方法返回值

抛出 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, $parent null, $config = [] )
$id string

此模块的 ID。

$parent yii\base\Module|null

父模块(如果有)。

$config array

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

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

            
__get() 公共方法

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

Getter 魔术方法。

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

public 混合 __get ( $name )
$name string

组件或属性名称

返回值 混合

命名的属性值

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

            
__isset() 公共方法

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

检查属性值是否为空。

此方法通过检查是否加载了命名的组件来覆盖父实现。

public 布尔值 __isset ( $name )
$name string

属性名称或事件名称

返回值 布尔值

属性值是否为 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 混合

属性值

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

此方法在执行此模块内的操作后立即调用。

此方法将触发 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 混合

操作返回结果。

返回值 混合

已处理的操作结果。

                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 字符串|数组|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() 公共方法

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

此方法将触发 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 布尔值 beforeAction ( $action )
$action yii\base\Action

要执行的操作。

返回值 布尔值

操作是否应该继续执行。

                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 数组 behaviors ( )
返回值 array

行为配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公共方法

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

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

如果可以读取属性

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

另请参阅 canSetProperty()

public 布尔值 canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

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

返回值 布尔值

属性是否可以读取

                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 布尔值 canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

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

返回值 布尔值

属性是否可以写入

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

            
createController() 公共方法

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

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

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

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

public 数组|布尔值 createController ( $route )
$route string

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

返回值 数组|布尔值

如果控制器创建成功,则将其与请求的操作 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() 公共方法

根据给定的控制器 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 起可用)

返回默认模块版本。

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

protected string 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() 方法。

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

            
get() 公共方法

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

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

public object|null get ( $id, $throwException true )
$id string

组件 ID(例如 db)。

$throwException 布尔值

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

返回值 object|null

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

            
getBasePath() 公共方法

返回模块的根目录。

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

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

返回命名的行为对象。

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

            
getComponents() 公共方法

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

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

public array getComponents ( $returnDefinitions true )
$returnDefinitions 布尔值

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

返回值 array

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

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

            
getControllerPath() 公共方法

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

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

public string getControllerPath ( )
返回值 string

包含控制器类的目录。

抛出 yii\base\InvalidArgumentException

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

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

            
getInstance() 公共静态方法

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

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

public static static|null getInstance ( )
返回值 yii\base\Module|null

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

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

            
getLayoutPath() 公共方法

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

public string getLayoutPath ( )
返回值 string

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

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

            
getModule() 公共方法

检索指定 ID 的子模块。

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

另请参阅 hasModule()

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

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

$load 布尔值

如果模块尚未加载,是否加载模块。

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

返回此模块中的子模块。

public array getModules ( $loadedOnly false )
$loadedOnly 布尔值

是否仅返回已加载的子模块。如果将其设置为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;
}

            
getUniqueId() 公共方法

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

请注意,如果模块是应用程序,则将返回空字符串。

public string getUniqueId ( )
返回值 string

模块的唯一 ID。

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

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

返回当前模块版本。

如果未显式设置版本,则将使用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;
}

            
getViewPath() 公共方法

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

public string getViewPath ( )
返回值 string

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

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

            
has() 公共方法

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

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

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

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

组件 ID(例如 db)。

$checkInstance 布尔值

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

返回值 布尔值

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

                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

事件名称

返回值 布尔值

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

                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 布尔值

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

返回值 布尔值

方法是否已定义

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

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

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

public boolean hasModule ( $id )
$id string

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

返回值 布尔值

命名的模块是否存在。已加载和未加载的模块都将被考虑。

                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 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

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

返回值 布尔值

属性是否已定义

                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()
{
    if ($this->controllerNamespace === null) {
        $class = get_class($this);
        if (($pos = strrpos($class, '\\')) !== false) {
            $this->controllerNamespace = substr($class, 0, $pos) . '\\controllers';
        }
    }
}

            
off() 公共方法

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

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

此方法与 on() 相反。

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

另请参阅 on()

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

事件名称

$handler callable|null

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

返回值 布尔值

如果找到并分离了一个处理程序

                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 混合

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

$append 布尔值

是否将新的事件处理程序追加到现有处理程序列表的末尾。如果为 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]);
    }
}

            
runAction() 公共方法

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

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

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

指定操作的路由。

$params array

要传递给操作的参数

返回值 混合

操作的结果。

抛出 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 混合

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

  • 类名
  • 配置数组:该数组包含名称-值对,当调用 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::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() 公共方法

设置模块的根目录。

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

public void setBasePath ( $path )
$path string

模块的根目录。这可以是目录名称或 路径别名

抛出 yii\base\InvalidArgumentException

如果目录不存在。

                public function setBasePath($path)
{
    $path = Yii::getAlias($path);
    $p = strncmp($path, 'phar://', 7) === 0 ? $path : realpath($path);
    if (is_string($p) && is_dir($p)) {
        $this->_basePath = $p;
    } else {
        throw new InvalidArgumentException("The directory does not exist: $path");
    }
}

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

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

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

public void setControllerPath ( $path )
$path string

包含控制器类的根目录。

抛出 yii\base\InvalidArgumentException

如果目录无效。

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

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

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

public void setLayoutPath ( $path )
$path string

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

抛出 yii\base\InvalidArgumentException

如果目录无效

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

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

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

每个子模块都应指定为一个键值对,其中键表示模块的 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;
        }
    }
}

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

设置当前模块版本。

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

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

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

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

            
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_ACTION yii\base\ActionEvent 类型的事件

执行控制器操作后触发的事件。

EVENT_BEFORE_ACTION yii\base\ActionEvent 类型的事件

在执行控制器操作之前引发的事件。您可以将 yii\base\ActionEvent::$isValid 设置为 false 以取消操作执行。