Class yii\web\AssetConverter

Inheritanceyii\web\AssetConverter » yii\base\Component » yii\base\Object
Implementsyii\base\Configurable, yii\web\AssetConverterInterface
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/web/AssetConverter.php

AssetConverter supports conversion of several popular script formats into JS or CSS scripts.

It is used by yii\web\AssetManager to convert files after they have been published.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$commands array The commands that are used to perform the asset conversion. yii\web\AssetConverter
$forceConvert boolean Whether the source asset file should be converted even if its result already exists. yii\web\AssetConverter

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\Object
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
className() Returns the fully qualified name of this class. yii\base\Object
convert() Converts a given asset file into a CSS or JS file. yii\web\AssetConverter
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() Initializes the object. yii\base\Object
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
runCommand() Runs a command to convert asset files. yii\web\AssetConverter

Property Details

$commands public property

The commands that are used to perform the asset conversion. The keys are the asset file extension names, and the values are the corresponding target script types (either "css" or "js") and the commands used for the conversion.

You may also use a path alias to specify the location of the command:

[
    '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 property

Whether the source asset file should be converted even if its result already exists. You may want to set this to be true during the development stage to make sure the converted assets are always up-to-date. Do not set this to true on production servers as it will significantly degrade the performance.

public boolean $forceConvert false

Method Details

convert() public method

Converts a given asset file into a CSS or JS file.

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

The asset file path, relative to $basePath

$basePath string

The directory the $asset is relative to.

return string

The converted asset file path, relative to $basePath.

runCommand() protected method

Runs a command to convert asset files.

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

The command to run. If prefixed with an @ it will be treated as a path alias.

$basePath string

Asset base path and command working directory

$asset string

The name of the asset file

$result string

The name of the file to be generated by the converter command

return boolean

True on success, false on failure. Failures will be logged.

throws yii\base\Exception

when the command fails and YII_DEBUG is true. In production mode the error will be logged.