Класс yii\web\AssetConverter
| Наследование | yii\web\AssetConverter » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | 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 | массив | Команды, используемые для преобразования активов. | yii\web\AssetConverter |
| $forceConvert | boolean | Преобразовывать ли исходный файл актива, даже если его результат уже существует. | yii\web\AssetConverter |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Component |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __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\Object |
| 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\Object |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| trigger() | Вызывает событие. | yii\base\Component |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| runCommand() | Выполняет команду для преобразования файлов активов. | yii\web\AssetConverter |
Подробное описание свойств
$commands публичное свойство
Команды, используемые для преобразования активов. Ключи — имена расширений файлов активов, а значения — соответствующие типы целевых скриптов («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 публичное свойство
Преобразовывать ли исходный файл актива, даже если его результат уже существует. Возможно, вам захочется установить это значение в true во время этапа разработки, чтобы убедиться, что преобразованные активы всегда актуальны. Не устанавливайте это значение в true на производственных серверах, так как это значительно ухудшит производительность.
public boolean $forceConvert = false
Подробное описание методов
convert() public method
Преобразует заданный файл ресурса в файл CSS или JS.
| public string convert ( $asset, $basePath ) | ||
|---|---|---|
| $asset | string |
Путь к файлу ресурса, относительно $basePath |
| $basePath | string |
Директория, относительно которой задан $asset. |
| return | string |
Путь к преобразованному файлу ресурса, относительно $basePath. |
runCommand() protected method
Выполняет команду для преобразования файлов ресурсов.
| 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 включен. В режиме производства ошибка будет залогирована. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-web-assetconverter.html
