0 关注者

类 yii\base\Theme

所有类 | 属性 | 方法
继承yii\base\Theme » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/base/Theme.php

主题代表应用程序主题。

当 yii\base\View 渲染视图文件时，它将检查 活动主题 以查看是否存在该视图文件的主题版本。如果是，则将渲染主题版本。

主题是一个目录，包含旨在替换其非主题对应文件的视图文件。

主题使用 $pathMap 来实现视图文件替换

  1. 它首先在 $pathMap 中查找一个键，该键是给定视图文件路径的子字符串；
  2. 如果存在这样的键，则相应的键将被用作替换视图文件路径中的相应部分；
  3. 然后，它将检查更新后的视图文件是否存在。如果是，该文件将被用作替换原始视图文件。
  4. 如果步骤 2 或 3 失败，将使用原始视图文件。

例如，如果 $pathMap 是 ['@app/views' => '@app/themes/basic']，则视图文件 @app/views/site/index.php 的主题版本将为 @app/themes/basic/site/index.php。

可以将单个路径映射到多个路径。例如,

'pathMap' => [
    '@app/views' => [
        '@app/themes/christmas',
        '@app/themes/basic',
    ],
]

在这种情况下，主题版本可以是 @app/themes/christmas/site/index.php 或 @app/themes/basic/site/index.php。如果两个文件都存在，则前者优先于后者。

要使用主题，您应该配置 主题 属性，例如 "view" 应用程序组件，如下所示

'view' => [
    'theme' => [
        'basePath' => '@app/themes/basic',
        'baseUrl' => '@web/themes/basic',
    ],
],

上述配置指定了一个主题，该主题位于包含应用程序入口脚本的 Web 文件夹的 "themes/basic" 目录下。如果您的主题设计用于处理模块，您可以配置 $pathMap 属性，如上所述。

有关主题的更多详细信息和使用信息，请参阅 关于主题的指南文章.

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$basePath string 此主题的根路径。 yii\base\Theme
$baseUrl string 此主题的基本 URL（没有尾部斜杠）。 yii\base\Theme
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$pathMap array|null 视图目录与其相应主题版本之间的映射。 yii\base\Theme

公共方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法在通过克隆现有对象创建对象后被调用。 yii\base\Component
__construct() 构造函数。 yii\base\BaseObject
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查是否设置了属性，即已定义且不为空。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
applyTo() 如果可能，将文件转换为主题文件。 yii\base\Theme
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
behaviors() 返回此组件应表现为的行为列表。 yii\base\Component
canGetProperty() 返回一个值，指示是否可以读取属性。 yii\base\Component
canSetProperty() 返回一个值，指示是否可以设置属性。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为附加到此组件。 yii\base\Component
getBasePath() yii\base\Theme
getBaseUrl() yii\base\Theme
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getPath() 使用 $basePath 将相对文件路径转换为绝对路径。 yii\base\Theme
getUrl() 使用 $baseUrl 将相对 URL 转换为绝对 URL。 yii\base\Theme
hasEventHandlers() 返回一个值，指示是否将任何处理程序附加到命名的事件。 yii\base\Component
hasMethod() 返回一个值，指示是否定义了方法。 yii\base\Component
hasProperty() 返回一个值，指示是否为该组件定义了属性。 yii\base\Component
init() 初始化对象。 yii\base\BaseObject
off() 从该组件分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
setBasePath() yii\base\Theme
setBaseUrl() yii\base\Theme
trigger() 触发事件。 yii\base\Component

属性详细信息

隐藏继承的属性

$basePath public property

此主题的根路径。此主题的所有资源都位于该目录下。

public string $basePath = null
$baseUrl public property

此主题的基本 URL（没有尾部斜杠）。此主题的所有资源都被认为位于此基本 URL 下。

public string $baseUrl = null
$pathMap public property

视图目录与其对应的主题版本的映射。当视图尝试应用主题时，此属性由 applyTo() 使用。 路径别名 可用于指定目录。如果此属性为空或未设置，则映射 yii\base\Application::$basePath 到 $basePath 将被使用。

public array|null $pathMap = null

方法详情

隐藏继承的方法

__call() public method

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

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

此方法将检查是否有任何附加的行为具有指定的名称，如果有则执行它。

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

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

方法名称
$params array

方法参数
return mixed

方法返回值
throws yii\base\UnknownMethodException

当调用未知方法时

 

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

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

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

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

public void __clone ( )

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

定义于： yii\base\BaseObject::__construct()

构造函数。

默认实现执行两件事

  • 使用给定的配置 $config 初始化对象。
  • 调用 init().

如果此方法在子类中被重写，则建议

  • 构造函数的最后一个参数是一个配置数组，就像这里的 $config 一样。
  • 在构造函数的末尾调用父类实现。
public void __construct ( $config = [] )
$config array

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

 

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}
__get() public method

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

返回组件属性的值。

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

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

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

另请参阅 __set().

public mixed __get ( $name )
$name string

属性名称
return mixed

属性值或行为属性的值
throws yii\base\UnknownPropertyException

如果属性未定义
throws yii\base\InvalidCallException

如果属性是只写的。

 

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

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

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

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

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

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

另请参阅 https://php.ac.cn/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

属性名称或事件名称
return boolean

命名的属性是否已设置

 

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

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

设置组件属性的值。

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

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

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

另请参阅 __get().

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

属性名称或事件名称
$value mixed

属性值
throws yii\base\UnknownPropertyException

如果属性未定义
throws yii\base\InvalidCallException

如果属性是只读的。

 

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

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

将组件属性设置为 null。

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

  • 通过 setter 定义的属性：将属性值设置为 null
  • 行为的属性：将属性值设置为 null

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

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

public void __unset ( $name )
$name string

属性名称
throws 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);
}
applyTo() public method

如果可能，将文件转换为主题文件。

如果没有对应的主题文件，则返回原始文件。

public string applyTo ( $path )
$path string

要主题化的文件
return string

主题化的文件，或者如果主题版本不可用，则为原始文件。
throws yii\base\InvalidConfigException

如果 $basePath 未设置

 

                public function applyTo($path)
{
    $pathMap = $this->pathMap;
    if (empty($pathMap)) {
        if (($basePath = $this->getBasePath()) === null) {
            throw new InvalidConfigException('The "basePath" property must be set.');
        }
        $pathMap = [Yii::$app->getBasePath() => [$basePath]];
    }
    $path = FileHelper::normalizePath($path);
    foreach ($pathMap as $from => $tos) {
        $from = FileHelper::normalizePath(Yii::getAlias($from)) . DIRECTORY_SEPARATOR;
        if (strpos($path, $from) === 0) {
            $n = strlen($from);
            foreach ((array) $tos as $to) {
                $to = FileHelper::normalizePath(Yii::getAlias($to)) . DIRECTORY_SEPARATOR;
                $file = $to . substr($path, $n);
                if (is_file($file)) {
                    return $file;
                }
            }
        }
    }
    return $path;
}
attachBehavior() public method

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

将行为附加到此组件。

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

另请参阅 detachBehavior().

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

行为的名称。
$behavior string|array|yii\base\Behavior

行为配置。它可以是以下之一
return 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);
    }
}
behaviors() 公共方法

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

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

子类可以覆盖此方法来指定它们想要作为行为的行为。

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

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

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

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

public array behaviors ( )
return array

行为配置。

 

                public function behaviors()
{
    return [];
}
canGetProperty() 公共方法

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

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

属性可以读取，如果

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

另请参阅 canSetProperty().

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

属性名称
$checkVars boolean

是否将成员变量视为属性
$checkBehaviors boolean

是否将行为的属性视为此组件的属性
return 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 为真时）；
  • 附加的行为具有给定名称的可写属性（当 $checkBehaviors 为真时）。

另请参阅 canGetProperty().

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

属性名称
$checkVars boolean

是否将成员变量视为属性
$checkBehaviors boolean

是否将行为的属性视为此组件的属性
return 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 ( )
return string

此类的完全限定名称。

 

                public static function className()
{
    return get_called_class();
}
detachBehavior() 公共方法

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

从组件中分离行为。

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

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

行为的名称。
return 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);
        }
    }
}
getBasePath() 公共方法

另请参阅 $pathMap.

public string getBasePath ( )
return string

此主题的根路径。此主题的所有资源都位于该目录下。

 

                public function getBasePath()
{
    return $this->_basePath;
}
getBaseUrl() 公共方法

public string getBaseUrl ( )
return string

此主题的基本 URL（没有尾部斜杠）。此主题的所有资源都被认为位于此基本 URL 下。

 

                public function getBaseUrl()
{
    return $this->_baseUrl;
}
getBehavior() 公共方法

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

返回命名的行为对象。

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

行为名称
return 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 ( )
return yii\base\Behavior[]

附加到此组件的行为列表

 

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}
getPath() 公共方法

使用 $basePath 将相对文件路径转换为绝对路径。

public string getPath ( $path )
$path string

要转换的相对文件路径。
return string

绝对文件路径
throws yii\base\InvalidConfigException

如果 $basePath 未设置

 

                public function getPath($path)
{
    if (($basePath = $this->getBasePath()) !== null) {
        return $basePath . DIRECTORY_SEPARATOR . ltrim($path, '/\\');
    }
    throw new InvalidConfigException('The "basePath" property must be set.');
}
getUrl() 公共方法

使用 $baseUrl 将相对 URL 转换为绝对 URL。

public string getUrl ( $url )
$url string

要转换的相对 URL。
return string

绝对 URL
throws yii\base\InvalidConfigException

如果 $baseUrl 未设置

 

                public function getUrl($url)
{
    if (($baseUrl = $this->getBaseUrl()) !== null) {
        return $baseUrl . '/' . ltrim($url, '/');
    }
    throw new InvalidConfigException('The "baseUrl" property must be set.');
}
hasEventHandlers() 公共方法

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

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

public boolean hasEventHandlers ( $name )
$name string

事件名称
return 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

是否将行为的方法视为该组件的方法
return boolean

该方法是否已定义

 

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

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

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

如果定义了一个属性，则

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

另请参见

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

属性名称
$checkVars boolean

是否将成员变量视为属性
$checkBehaviors boolean

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

该属性是否已定义

 

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

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

初始化对象。

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

public void init ( )

                public function init()
{
}
off() 公共方法

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

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

此方法与 on() 相反。

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

另请参见 on()。

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

事件名称
$handler callable|null

要删除的事件处理程序。如果为 null，将删除附加到命名事件的所有处理程序。
return 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]);
    }
}
setBasePath() 公共方法

另请参阅 $pathMap.

public void setBasePath ( $path )
$path string

此主题的根路径或 路径别名。此主题的所有资源都位于此目录下。

 

                public function setBasePath($path)
{
    $this->_basePath = Yii::getAlias($path);
}
setBaseUrl() 公共方法

public void setBaseUrl ( $url )
$url string

此主题的基 URL 或 路径别名。此主题的所有资源都被认为位于此基 URL 下。

 

                public function setBaseUrl($url)
{
    $this->_baseUrl = $url === null ? null : rtrim(Yii::getAlias($url), '/');
}
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);
}