Class yii\web\AssetConverter

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

AssetConverter 支持将几种流行的脚本格式转换为 JS 或 CSS 脚本.

yii\web\AssetManager 使用他在文件发布后进行转换文件.

公共属性

隐藏继承的属性

属性类型描述定义在
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. 该属性是只读的. yii\base\Component
$commands array 用于执行资源转换的命令. yii\web\AssetConverter
$forceConvert boolean 即使源资源文件的结果已经存在, 是否也应该转换源资源文件. yii\web\AssetConverter

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的指定的方法. yii\base\Component
__clone() 在通过克隆现有对象创建对象之后调用此方法. yii\base\Component
__construct() 构造函数. yii\base\BaseObject
__get() 返回组件属性的值. yii\base\Component
__isset() 检查属性是否已设置, 即已定义且不为null. 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
className() 返回此类的完全限定名称. yii\base\BaseObject
convert() 将给定的资源文件转换为 CSS 或 JS 文件. yii\web\AssetConverter
detachBehavior() 从组件中分离一个行为. yii\base\Component
detachBehaviors() 分离组件中的所有行为. yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件. yii\base\Component
getBehavior() 返回指定的行为对象. yii\base\Component
getBehaviors() 返回附加到此组件的所有行为. yii\base\Component
hasEventHandlers() 返回一个值, 指示是否有任何处理程序附加到指定的事件. yii\base\Component
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\Component
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\Component
init() 初始化对象. yii\base\BaseObject
off() 从该组件分离现有的事件处理程序. yii\base\Component
on() 将事件处理程序附加到事件. yii\base\Component
trigger() 触发事件. yii\base\Component

受保护的方法

隐藏继承的方法

方法描述定义在
runCommand() 运行一个命令来转换资源文件. yii\web\AssetConverter

属性详情

$commands public 属性

用于执行资源转换的命令.

键是资源文件扩展名, 值是相应的目标脚本类型("css"或"js")以及用于转换的命令.

你也可以使用 路径别名 来指定命令的位置:

[
    'styl' => ['css', '@app/node_modules/bin/stylus < {from} > {to}'],
]
public array $commands = ['less' => ['css''lessc {from} {to} --no-color --source-map'], 'scss' => ['css''sass {from} {to} --sourcemap'], 'sass' => ['css''sass {from} {to} --sourcemap'], 'styl' => ['css''stylus < {from} > {to}'], 'coffee' => ['js''coffee -p {from} > {to}'], 'ts' => ['js''tsc --out {to} {from}']]
$forceConvert public 属性

即使源资源文件的结果已经存在, 是否也应该转换源资源文件.

你可能需要在开发阶段将其设置为true, 以确保转换后的资源始终处于最新状态.

请勿在生产服务器上将其设置为true, 因为这会严重降低性能.

public boolean $forceConvert false

方法详情

convert() public 方法

将给定的资源文件转换为 CSS 或 JS 文件.

public string convert ( $asset, $basePath )
$asset string

资源文件路径, 相对于 $basePath.

$basePath string

$asset 相对的目录.

return string

转换后的资源文件路径, 相对于 $basePath.

runCommand() protected 方法

运行一个命令来转换资源文件.

protected boolean runCommand ( $command, $basePath, $asset, $result )
$command string

要运行的命令. 如果以@作为前缀, 则将被视为 路径别名.

$basePath string

资源基础路径和命令工作目录.

$asset string

资源文件的名称.

$result string

由转换器命令生成的文件的名称.

return boolean

成功为true; 失败为false. 失败将被记录.

throws yii\base\Exception

当命令失败并且 YII_DEBUG 为true时. 在生产模式(Production)下, 错误将被记录.