0 follower

类 yii\web\AssetManager

继承yii\web\AssetManager » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/web/AssetManager.php

AssetManager 管理资产包配置和加载。

AssetManager 默认情况下在 yii\web\Application 中配置为应用程序组件。您可以通过 Yii::$app->assetManager 访问该实例。

您可以在应用程序配置中的 components 下添加一个数组来修改其配置,如下例所示

'assetManager' => [
    'bundles' => [
        // you can override AssetBundle configs here
    ],
]

有关 AssetManager 的更多详细信息和使用信息,请参阅 资产指南文章

公共属性

隐藏继承的属性

属性 类型 描述 定义
$afterCopy callable|null 在成功复制子目录或文件后调用的 PHP 回调函数。此选项仅在发布目录时使用。回调函数的签名与 $beforeCopy 相同。它作为参数 afterCopy 传递给 yii\helpers\FileHelper::copyDirectory() yii\web\AssetManager
$appendTimestamp boolean 是否在每个已发布资产的 URL 后附加时间戳。 yii\web\AssetManager
$assetMap string[] 源资产文件(键)到目标资产文件(值)的映射。 yii\web\AssetManager
$basePath string 存储已发布资产文件的根目录。 yii\web\AssetManager
$baseUrl string 可以访问已发布资产文件的基准 URL。 yii\web\AssetManager
$beforeCopy callable|null 在复制每个子目录或文件之前调用的 PHP 回调函数。此选项仅在发布目录时使用。回调函数的签名与 $afterCopy 相同。它作为参数 beforeCopy 传递给 yii\helpers\FileHelper::copyDirectory() yii\web\AssetManager
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$bundles array|false 资产包配置列表。 yii\web\AssetManager
$converter yii\web\AssetConverterInterface 资产转换器。 yii\web\AssetManager
$dirMode integer 为新生成的资产目录设置的权限。 yii\web\AssetManager
$fileMode integer|null 为新发布的资产文件设置的权限。 yii\web\AssetManager
$forceCopy boolean 即使在目标目录中找到正在发布的目录,是否也要复制它。 yii\web\AssetManager
$hashCallback callable|null 用于生成资产目录哈希值的回调函数。 yii\web\AssetManager
$linkAssets boolean 是否使用符号链接来发布资产文件。 yii\web\AssetManager

公共方法

隐藏继承的方法

方法 描述 定义
__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
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
behaviors() 返回此组件应表现的行为列表。 yii\base\Component
canGetProperty() 返回一个值,指示是否可以读取属性。 yii\base\Component
canSetProperty() 返回一个值,指示是否可以设置属性。 yii\base\Component
checkBasePathPermission() 检查 basePath 是否存在且可写。 yii\web\AssetManager
className() 返回此类的完全限定名称。 yii\base\BaseObject
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
ensureBehaviors() 确保 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
getActualAssetUrl() 返回指定资产的实际 URL。不带参数。 yii\web\AssetManager
getAssetPath() 返回指定资产的实际文件路径。 yii\web\AssetManager
getAssetUrl() 返回指定资产的实际 URL。 yii\web\AssetManager
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getBundle() 返回命名的资产包。 yii\web\AssetManager
getConverter() 返回资产转换器。 yii\web\AssetManager
getPublishedPath() 返回文件路径的已发布路径。 yii\web\AssetManager
getPublishedUrl() 返回已发布文件路径的 URL。 yii\web\AssetManager
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到命名的事件。 yii\base\Component
hasMethod() 返回一个值,指示是否定义了方法。 yii\base\Component
hasProperty() 返回一个值,指示是否为此组件定义了属性。 yii\base\Component
init() 初始化组件。 yii\web\AssetManager
off() 从此组件中分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
publish() 发布文件或目录。 yii\web\AssetManager
setConverter() 设置资产转换器。 yii\web\AssetManager
trigger() 触发事件。 yii\base\Component

受保护的方法

隐藏继承的方法

方法 描述 定义
hash() 为目录路径生成 CRC32 哈希值。冲突高于 MD5,但会生成更小的哈希字符串。 yii\web\AssetManager
loadBundle() 按名称加载资产包类。 yii\web\AssetManager
loadDummyBundle() 按名称加载虚拟包。 yii\web\AssetManager
publishDirectory() 发布目录。 yii\web\AssetManager
publishFile() 发布文件。 yii\web\AssetManager
resolveAsset() yii\web\AssetManager

属性详细信息

隐藏继承的属性

$afterCopy 公共属性

在成功复制子目录或文件后调用的 PHP 回调函数。此选项仅在发布目录时使用。回调函数的签名与 $beforeCopy 相同。它作为参数 afterCopy 传递给 yii\helpers\FileHelper::copyDirectory()

public callable|null $afterCopy null
$appendTimestamp 公共属性 (可用版本 2.0.3)

是否将时间戳附加到每个发布资产的 URL。当此值为 true 时,已发布资产的 URL 可能类似于 /path/to/asset?v=timestamp,其中 timestamp 是已发布资产文件的最后修改时间。通常在为资产启用 HTTP 缓存时,您希望将此属性设置为 true,因为它允许您在更新资产时清除缓存。

public boolean $appendTimestamp false
$assetMap 公共属性

源资产文件(键)到目标资产文件(值)的映射。

提供此属性是为了支持修复某些资产包中不正确的资产文件路径。当用视图注册资产包时,其 cssjs 数组中的每个相对资产文件将针对此映射进行检查。如果发现任何键是资产文件的最后一部分(该部分以 yii\web\AssetBundle::$sourcePath 为前缀,如果可用),则相应的 value 将替换资产并用视图注册。例如,资产文件 my/path/to/jquery.js 与键 jquery.js 匹配。

请注意,目标资产文件应该是绝对 URL、域名相对 URL(以“/”开头)或相对于 $baseUrl$basePath 的路径。

在以下示例中,任何以 jquery.min.js 结尾的资产将被替换为 jquery/dist/jquery.js,该资产相对于 $baseUrl$basePath

[
    'jquery.min.js' => 'jquery/dist/jquery.js',
]

您也可以在指定映射 value 时使用别名,例如

[
    'jquery.min.js' => '@web/js/jquery/jquery.js',
]
public string[] $assetMap = []
$basePath 公共属性

存储已发布资产文件的根目录。

public string $basePath '@webroot/assets'
$baseUrl 公共属性

可以访问已发布资产文件的基准 URL。

public string $baseUrl '@web/assets'
$beforeCopy 公共属性

在复制每个子目录或文件之前调用的 PHP 回调。此选项仅在发布目录时使用。如果回调返回 false,则子目录或文件的复制操作将被取消。

回调的签名应为:function ($from, $to),其中 $from 是要从中复制的子目录或文件,而 $to 是复制目标。

这作为参数 beforeCopy 传递给 yii\helpers\FileHelper::copyDirectory()

public callable|null $beforeCopy null
$bundles 公共属性

资产包配置列表。提供此属性是为了自定义资产包。当通过 getBundle() 加载包时,如果此处指定了相应的配置,则该配置将应用于该包。

数组键是资产包名称,通常是不带前导反斜杠的资产包类名。数组值是相应的配置。如果一个值是 false,则表示相应的资产包被禁用,getBundle() 应该返回 null。

如果此属性为 false,则表示整个资产包功能被禁用,getBundle() 将始终返回 null。

以下示例展示了如何禁用 Bootstrap 小部件使用的 bootstrap css 文件(因为您想使用自己的样式)

[
    'yii\bootstrap\BootstrapAsset' => [
        'css' => [],
    ],
]
public array|false $bundles = []
$converter 公共属性

资产转换器。请注意,此属性在 getter 和 setter 中的类型不同。有关详细信息,请参阅 getConverter()setConverter()

$dirMode 公共属性

要为新生成的资产目录设置的权限。此值将由 PHP chmod() 函数使用。不会应用 umask。默认为 0775,这意味着该目录对所有者和组可读写,但对其他用户只读。

public integer $dirMode 0775
$fileMode 公共属性

要为新发布的资产文件设置的权限。此值将由 PHP chmod() 函数使用。不会应用 umask。如果未设置,则权限将由当前环境确定。

public integer|null $fileMode null
$forceCopy 公共属性

是否即使在目标目录中找到要发布的目录也应该复制该目录。此选项仅在发布目录时使用。您可能希望在开发阶段将此设置为 true,以确保发布的目录始终是最新的。不要在生产服务器上将此设置为 true,因为它会显着降低性能。

public boolean $forceCopy false
$hashCallback 公共属性 (版本 2.0.6 及更高版本可用)

将被调用以生成资产目录哈希的回调。回调的签名应如下所示

function ($path)

其中 $path 是资源路径。请注意,$path 可以是资源文件所在的目录,也可以是单个文件。对于在 url() 中使用相对路径的 CSS 文件,哈希实现应该使用该文件的目录路径而不是文件路径来包含相对资源文件。

如果未设置此项,资源管理器将在 hash 方法中使用默认的 CRC32 和 filemtime。

使用 MD4 哈希的实现示例

function ($path) {
    return hash('md4', $path);
}
public callable|null $hashCallback null
$linkAssets 公共属性

是否使用符号链接来发布资源文件。默认为 false,这意味着资源文件被复制到 $basePath。使用符号链接的好处是发布的资源将始终与源资源一致,并且不需要任何复制操作。这在开发期间特别有用。

但是,对于托管环境来说,使用符号链接存在一些特殊的要求。特别是,符号链接仅在 Linux/Unix 和 Windows Vista/2008 或更高版本上受支持。

此外,一些 Web 服务器需要正确配置,以便 Web 用户可以访问链接的资源。例如,对于 Apache Web 服务器,应该为 Web 文件夹添加以下配置指令

Options FollowSymLinks
public boolean $linkAssets false

方法细节

隐藏继承的方法

__call() 公共方法

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

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

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

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

public void __clone ( )

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

            
__construct() 公共方法

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

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

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

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

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

            
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

行为配置。这可以是以下之一

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 为 true 时);
  • 附加的行为具有给定名称的可读属性(当 $checkBehaviors 为 true 时)。

另请参阅 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 为 true 时);
  • 附加的行为具有给定名称的可写属性(当 $checkBehaviors 为 true 时)。

另请参阅 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;
}

            
checkBasePathPermission() 公共方法 (版本 2.0.40 及更高版本可用)

检查 basePath 是否存在且可写。

public void checkBasePathPermission ( )

                public function checkBasePathPermission()
{
    // if the check is been done already, skip further checks
    if ($this->_isBasePathPermissionChecked) {
        return;
    }
    if (!is_dir($this->basePath)) {
        throw new InvalidConfigException("The directory does not exist: {$this->basePath}");
    }
    if (!is_writable($this->basePath)) {
        throw new InvalidConfigException("The directory is not writable by the Web process: {$this->basePath}");
    }
    $this->_isBasePathPermissionChecked = true;
}

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

            
getActualAssetUrl() 公共方法 (版本 2.0.39 及更高版本可用)

返回指定资产的实际 URL。不带参数。

实际 URL 是通过将 yii\web\AssetBundle::$baseUrlyii\web\AssetManager::$baseUrl 预先添加到给定的资产路径来获得的。

public string getActualAssetUrl ( $bundle, $asset )
$bundle yii\web\AssetBundle

资产文件所属的资产包

$asset string

资产路径。这应该是 yii\web\AssetBundle::$jsyii\web\AssetBundle::$css 中列出的资产之一。

return string

指定资产的实际 URL。

                public function getActualAssetUrl($bundle, $asset)
{
    if (($actualAsset = $this->resolveAsset($bundle, $asset)) !== false) {
        if (strncmp($actualAsset, '@web/', 5) === 0) {
            $asset = substr($actualAsset, 5);
            $baseUrl = Yii::getAlias('@web');
        } else {
            $asset = Yii::getAlias($actualAsset);
            $baseUrl = $this->baseUrl;
        }
    } else {
        $baseUrl = $bundle->baseUrl;
    }
    if (!Url::isRelative($asset) || strncmp($asset, '/', 1) === 0) {
        return $asset;
    }
    return "$baseUrl/$asset";
}

            
getAssetPath() 公共方法

返回指定资产的实际文件路径。

public string|false getAssetPath ( $bundle, $asset )
$bundle yii\web\AssetBundle

资产文件所属的资产包

$asset string

资产路径。这应该是 yii\web\AssetBundle::$jsyii\web\AssetBundle::$css 中列出的资产之一。

return string|false

实际文件路径,或者如果资产指定为绝对 URL,则为 false

                public function getAssetPath($bundle, $asset)
{
    if (($actualAsset = $this->resolveAsset($bundle, $asset)) !== false) {
        return Url::isRelative($actualAsset) ? $this->basePath . '/' . $actualAsset : false;
    }
    return Url::isRelative($asset) ? $bundle->basePath . '/' . $asset : false;
}

            
getAssetUrl() public method

返回指定资产的实际 URL。

实际 URL 是通过将 yii\web\AssetBundle::$baseUrlyii\web\AssetManager::$baseUrl 预先添加到给定的资产路径来获得的。

public string getAssetUrl ( $bundle, $asset, $appendTimestamp null )
$bundle yii\web\AssetBundle

资产文件所属的资产包

$asset string

资产路径。这应该是 yii\web\AssetBundle::$jsyii\web\AssetBundle::$css 中列出的资产之一。

$appendTimestamp boolean|null

是否将时间戳附加到 URL。

return string

指定资产的实际 URL。

                public function getAssetUrl($bundle, $asset, $appendTimestamp = null)
{
    $assetUrl = $this->getActualAssetUrl($bundle, $asset);
    $assetPath = $this->getAssetPath($bundle, $asset);
    $withTimestamp = $this->appendTimestamp;
    if ($appendTimestamp !== null) {
        $withTimestamp = $appendTimestamp;
    }
    if ($withTimestamp && $assetPath && ($timestamp = @filemtime($assetPath)) > 0) {
        return "$assetUrl?v=$timestamp";
    }
    return $assetUrl;
}

            
getBehavior() public method

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

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

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

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

附加到此组件的行为列表

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

            
getBundle() public method

返回命名的资产包。

此方法将首先在 $bundles 中查找捆绑包。如果未找到,它将把 $name 视为资产捆绑包的类,并创建一个新实例。

public yii\web\AssetBundle getBundle ( $name, $publish true )
$name string

资产捆绑包的类名(不含开头的反斜杠)

$publish boolean

是否在返回资产捆绑包之前发布其资产文件。如果您将此设置为 false,则必须手动调用 AssetBundle::publish() 来发布资产文件。

return yii\web\AssetBundle

资产捆绑包实例

throws yii\base\InvalidConfigException

如果 $name 不指向有效的资产捆绑包

                public function getBundle($name, $publish = true)
{
    if ($this->bundles === false) {
        return $this->loadDummyBundle($name);
    } elseif (!isset($this->bundles[$name])) {
        return $this->bundles[$name] = $this->loadBundle($name, [], $publish);
    } elseif ($this->bundles[$name] instanceof AssetBundle) {
        return $this->bundles[$name];
    } elseif (is_array($this->bundles[$name])) {
        return $this->bundles[$name] = $this->loadBundle($name, $this->bundles[$name], $publish);
    } elseif ($this->bundles[$name] === false) {
        return $this->loadDummyBundle($name);
    }
    throw new InvalidConfigException("Invalid asset bundle configuration: $name");
}

            
getConverter() public method

返回资产转换器。

public yii\web\AssetConverterInterface getConverter ( )
return yii\web\AssetConverterInterface

资产转换器。

                public function getConverter()
{
    if ($this->_converter === null) {
        $this->_converter = Yii::createObject(AssetConverter::className());
    } elseif (is_array($this->_converter) || is_string($this->_converter)) {
        if (is_array($this->_converter) && !isset($this->_converter['class'])) {
            $this->_converter['class'] = AssetConverter::className();
        }
        $this->_converter = Yii::createObject($this->_converter);
    }
    return $this->_converter;
}

            
getPublishedPath() public method

返回文件路径的已发布路径。

此方法不执行任何发布操作。它只是告诉你文件或目录是否已发布,以及它将在哪里发布。

public string|false getPublishedPath ( $path )
$path string

要发布的目录或文件路径

return string|false

字符串,发布后的文件路径。如果文件或目录不存在,则为 false

                public function getPublishedPath($path)
{
    $path = Yii::getAlias($path);
    if (isset($this->_published[$path])) {
        return $this->_published[$path][0];
    }
    if (is_string($path) && ($path = realpath($path)) !== false) {
        return $this->basePath . DIRECTORY_SEPARATOR . $this->hash($path) . (is_file($path) ? DIRECTORY_SEPARATOR . basename($path) : '');
    }
    return false;
}

            
getPublishedUrl() public method

返回已发布文件路径的 URL。

此方法不执行任何发布操作。它只是告诉你文件路径是否已发布,以及访问它的 URL 将是什么。

public string|false getPublishedUrl ( $path )
$path string

要发布的目录或文件路径

return string|false

字符串,发布后的文件或目录的 URL。如果文件或目录不存在,则为 false。

                public function getPublishedUrl($path)
{
    $path = Yii::getAlias($path);
    if (isset($this->_published[$path])) {
        return $this->_published[$path][1];
    }
    if (is_string($path) && ($path = realpath($path)) !== false) {
        return $this->baseUrl . '/' . $this->hash($path) . (is_file($path) ? '/' . basename($path) : '');
    }
    return false;
}

            
hasEventHandlers() public method

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

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

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

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

如果定义了一个属性,则

  • 该类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
  • 该类具有指定名称的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的属性(当 $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);
}

            
hash() protected method

为目录路径生成 CRC32 哈希值。冲突高于 MD5,但会生成更小的哈希字符串。

protected string hash ( $path )
$path string

要哈希的字符串。

return string

哈希后的字符串。

                protected function hash($path)
{
    if (is_callable($this->hashCallback)) {
        return call_user_func($this->hashCallback, $path);
    }
    $path = (is_file($path) ? dirname($path) : $path) . filemtime($path);
    return sprintf('%x', crc32($path . Yii::getVersion() . '|' . $this->linkAssets));
}

            
init() public method

初始化组件。

public void init ( )
throws yii\base\InvalidConfigException

如果 $basePath 不存在。

                public function init()
{
    parent::init();
    $this->basePath = Yii::getAlias($this->basePath);
    $this->basePath = realpath($this->basePath);
    $this->baseUrl = rtrim(Yii::getAlias($this->baseUrl), '/');
}

            
loadBundle() protected method

按名称加载资产包类。

受保护 yii\web\AssetBundle loadBundle ( $name, $config = [], $publish true )
$name string

捆绑包名称

$config array

捆绑包对象配置

$publish boolean

是否应该发布捆绑包

throws yii\base\InvalidConfigException

如果配置无效

                protected function loadBundle($name, $config = [], $publish = true)
{
    if (!isset($config['class'])) {
        $config['class'] = $name;
    }
    /* @var $bundle AssetBundle */
    $bundle = Yii::createObject($config);
    if ($publish) {
        $bundle->publish($this);
    }
    return $bundle;
}

            
loadDummyBundle() 受保护方法

按名称加载虚拟包。

受保护 yii\web\AssetBundle loadDummyBundle ( $name )
$name string

                protected function loadDummyBundle($name)
{
    if (!isset($this->_dummyBundles[$name])) {
        $bundle = Yii::createObject(['class' => $name]);
        $bundle->sourcePath = null;
        $bundle->js = [];
        $bundle->css = [];
        $this->_dummyBundles[$name] = $bundle;
    }
    return $this->_dummyBundles[$name];
}

            
off() 公共方法

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

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

此方法是 on() 的反操作。

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

另见 on()

公共 布尔值 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()

公共 on ( $name, $handler, $data null, $append true )
$name string

事件名称

$handler 可调用

事件处理程序

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

            
publish() 公共方法

发布文件或目录。

此方法将把指定的文件或目录复制到 $basePath,以便可以通过 Web 服务器访问它。

如果资产是文件,则将检查其文件修改时间,以避免不必要的复制文件。

如果资产是目录,则将递归地发布其下的所有文件和子目录。注意,如果 $forceCopy 为 false,则该方法只会检查目标目录的存在性,以避免重复复制(这非常昂贵)。

默认情况下,发布目录时,名称以点“.”开头的子目录和文件将不会被发布。如果您想更改此行为,您可以指定“beforeCopy”选项,如 $options 参数中所述。

注意:在罕见的情况下,可能会出现竞争条件,这将导致在创建包含已发布资产的目录时出现一次性表现形式的非关键问题。可以通过在系统上线之前,在应用程序部署阶段预先“请求”所有应该触发“publish()”调用的资源来完全避免此问题。在以下讨论中了解更多信息:https://code.google.com/archive/p/yii/issues/2579

公共 数组 publish ( $path, $options = [] )
$path string

要发布的资产(文件或目录路径)

$options array

发布目录时要应用的选项。支持以下选项

  • only:数组,要复制的文件路径应匹配的模式列表。
  • except:数组,要排除的复制文件或目录应匹配的模式列表。
  • caseSensitive:布尔值,“only”或“except”中指定的模式是否区分大小写。默认为 true。
  • beforeCopy:回调,在复制每个子目录或文件之前调用的 PHP 回调。如果设置,这将覆盖 $beforeCopy
  • afterCopy:回调,在成功复制子目录或文件后调用的 PHP 回调。如果设置,这将覆盖 $afterCopy
  • forceCopy:布尔值,即使在目标目录中找到也要复制要发布的目录。此选项仅在发布目录时使用。如果设置,这将覆盖 $forceCopy
return array

发布资产的路径(目录或文件路径)和 URL。

throws yii\base\InvalidArgumentException

如果要发布的资产不存在。

throws yii\base\InvalidConfigException

如果目标目录 $basePath 不可写。

                public function publish($path, $options = [])
{
    $path = Yii::getAlias($path);
    if (isset($this->_published[$path])) {
        return $this->_published[$path];
    }
    if (!is_string($path) || ($src = realpath($path)) === false) {
        throw new InvalidArgumentException("The file or directory to be published does not exist: $path");
    }
    if (!is_readable($path)) {
        throw new InvalidArgumentException("The file or directory to be published is not readable: $path");
    }
    if (is_file($src)) {
        return $this->_published[$path] = $this->publishFile($src);
    }
    return $this->_published[$path] = $this->publishDirectory($src, $options);
}

            
publishDirectory() 受保护方法

发布目录。

受保护 字符串[] publishDirectory ( $src, $options )
$src string

要发布的资产目录

$options array

发布目录时要应用的选项。支持以下选项

  • only:数组,要复制的文件路径应匹配的模式列表。
  • except:数组,要排除的复制文件或目录应匹配的模式列表。
  • caseSensitive:布尔值,“only”或“except”中指定的模式是否区分大小写。默认为 true。
  • beforeCopy:回调,在复制每个子目录或文件之前调用的 PHP 回调。如果设置,这将覆盖 $beforeCopy
  • afterCopy:回调,在成功复制子目录或文件后调用的 PHP 回调。如果设置,这将覆盖 $afterCopy
  • forceCopy:布尔值,即使在目标目录中找到也要复制要发布的目录。此选项仅在发布目录时使用。如果设置,这将覆盖 $forceCopy
return string[]

发布资产的路径目录和 URL。

throws yii\base\InvalidArgumentException

如果要发布的资产不存在。

                protected function publishDirectory($src, $options)
{
    $this->checkBasePathPermission();
    $dir = $this->hash($src);
    $dstDir = $this->basePath . DIRECTORY_SEPARATOR . $dir;
    if ($this->linkAssets) {
        if (!is_dir($dstDir)) {
            FileHelper::createDirectory(dirname($dstDir), $this->dirMode, true);
            try { // fix #6226 symlinking multi threaded
                symlink($src, $dstDir);
            } catch (\Exception $e) {
                if (!is_dir($dstDir)) {
                    throw $e;
                }
            }
        }
    } elseif (!empty($options['forceCopy']) || ($this->forceCopy && !isset($options['forceCopy'])) || !is_dir($dstDir)) {
        $opts = array_merge(
            $options,
            [
                'dirMode' => $this->dirMode,
                'fileMode' => $this->fileMode,
                'copyEmptyDirectories' => false,
            ]
        );
        if (!isset($opts['beforeCopy'])) {
            if ($this->beforeCopy !== null) {
                $opts['beforeCopy'] = $this->beforeCopy;
            } else {
                $opts['beforeCopy'] = function ($from, $to) {
                    return strncmp(basename($from), '.', 1) !== 0;
                };
            }
        }
        if (!isset($opts['afterCopy']) && $this->afterCopy !== null) {
            $opts['afterCopy'] = $this->afterCopy;
        }
        FileHelper::copyDirectory($src, $dstDir, $opts);
    }
    return [$dstDir, $this->baseUrl . '/' . $dir];
}

            
publishFile() 受保护方法

发布文件。

受保护 字符串[] publishFile ( $src )
$src string

要发布的资产文件

return string[]

发布资产的路径和 URL。

throws yii\base\InvalidArgumentException

如果要发布的资产不存在。

                protected function publishFile($src)
{
    $this->checkBasePathPermission();
    $dir = $this->hash($src);
    $fileName = basename($src);
    $dstDir = $this->basePath . DIRECTORY_SEPARATOR . $dir;
    $dstFile = $dstDir . DIRECTORY_SEPARATOR . $fileName;
    if (!is_dir($dstDir)) {
        FileHelper::createDirectory($dstDir, $this->dirMode, true);
    }
    if ($this->linkAssets) {
        if (!is_file($dstFile)) {
            try { // fix #6226 symlinking multi threaded
                symlink($src, $dstFile);
            } catch (\Exception $e) {
                if (!is_file($dstFile)) {
                    throw $e;
                }
            }
        }
    } elseif (@filemtime($dstFile) < @filemtime($src)) {
        copy($src, $dstFile);
        if ($this->fileMode !== null) {
            @chmod($dstFile, $this->fileMode);
        }
    }
    if ($this->appendTimestamp && ($timestamp = @filemtime($dstFile)) > 0) {
        $fileName = $fileName . "?v=$timestamp";
    }
    return [$dstFile, $this->baseUrl . "/$dir/$fileName"];
}

            
resolveAsset() 受保护方法

受保护 字符串|布尔值 resolveAsset ( $bundle, $asset )
$bundle yii\web\AssetBundle
$asset string

                protected function resolveAsset($bundle, $asset)
{
    if (isset($this->assetMap[$asset])) {
        return $this->assetMap[$asset];
    }
    if ($bundle->sourcePath !== null && Url::isRelative($asset)) {
        $asset = $bundle->sourcePath . '/' . $asset;
    }
    $n = mb_strlen($asset, Yii::$app->charset);
    foreach ($this->assetMap as $from => $to) {
        $n2 = mb_strlen($from, Yii::$app->charset);
        if ($n2 <= $n && substr_compare($asset, $from, $n - $n2, $n2) === 0) {
            return $to;
        }
    }
    return false;
}

            
setConverter() 公共方法

设置资产转换器。

公共 setConverter ( $value )
$value 数组|yii\web\AssetConverterInterface

资产转换器。这可以是实现 yii\web\AssetConverterInterface 的对象,也可以是可用于创建资产转换器对象的配置数组。

                public function setConverter($value)
{
    $this->_converter = $value;
}

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