• Home
• yii
• console
• controllers
• AssetController

PHP Class yii\console\controllers\AssetController

Usage: 1. Create a configuration file using the template action: yii asset/template /path/to/myapp/config.php 2. Edit the created config file, adjusting it for your web application needs. 3. Run the 'compress' action, using created config: yii asset /path/to/myapp/config.php /path/to/myapp/config/assets_compressed.php 4. Adjust your web application config to use compressed assets. Note: in the console environment some path aliases like @webroot and @web may not exist, so corresponding paths inside the configuration should be specified directly. Note: by default this command relies on an external tools to perform actual files compression, check [[jsCompressor]] and [[cssCompressor]] for more details. Datei anzeigen Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property	Type	Description
$bundles		list of asset bundles to be compressed.
$cssCompressor		CSS file compressor. If a string, it is treated as shell command template, which should contain placeholders {from} - source file name - and {to} - output file name. Otherwise, it is treated as PHP callback, which should perform the compression. Default value relies on usage of "YUI Compressor"
$defaultAction		controller default action ID.
$deleteSource		whether to delete asset source files after compression. This option affects only those bundles, which have [[\yii\web\AssetBundle::sourcePath]] is set.
$jsCompressor		JavaScript file compressor. If a string, it is treated as shell command template, which should contain placeholders {from} - source file name - and {to} - output file name. Otherwise, it is treated as PHP callback, which should perform the compression. Default value relies on usage of "Closure Compiler"
$targets		list of asset bundles, which represents output compressed files. You can specify the name of the output compressed file using 'css' and 'js' keys: For example: php 'app\config\AllAsset' => [ 'js' => 'js/all-{hash}.js', 'css' => 'css/all-{hash}.css', 'depends' => [ ... ], ] File names can contain placeholder "{hash}", which will be filled by the hash of the resulting file. You may specify several target bundles in order to compress different groups of assets. In this case you should use 'depends' key to specify, which bundles should be covered with particular target bundle. You may leave 'depends' to be empty for single bundle, which will compress all remaining bundles in this case. For example: php 'allShared' => [ 'js' => 'js/all-shared-{hash}.js', 'css' => 'css/all-shared-{hash}.css', 'depends' => [ Include all assets shared between 'backend' and 'frontend' 'yii\web\YiiAsset', 'app\assets\SharedAsset', ], ], 'allBackEnd' => [ 'js' => 'js/all-{hash}.js', 'css' => 'css/all-{hash}.css', 'depends' => [ Include only 'backend' assets: 'app\assets\AdminAsset' ], ], 'allFrontEnd' => [ 'js' => 'js/all-{hash}.js', 'css' => 'css/all-{hash}.css', 'depends' => [], // Include all remaining assets ],

Public Methods

Method	Description
actionCompress ( string $configFile, string $bundleFile )	Combines and compresses the asset files according to the given configuration.
actionTemplate ( string $configFile ) : integer	Creates template of configuration file for [[actionCompress]].
combineCssFiles ( array $inputFiles, string $outputFile )	Combines CSS files into a single one.
combineJsFiles ( array $inputFiles, string $outputFile )	Combines JavaScript files into a single one.
getAssetManager ( ) : AssetManager	Returns the asset manager instance.
setAssetManager ( AssetManager | array $assetManager )	Sets asset manager instance or configuration.

Protected Methods

Method	Description
adjustCssUrl ( string $cssContent, string $inputFilePath, string $outputFilePath ) : string	Adjusts CSS content allowing URL references pointing to the original resources.
adjustDependency ( AssetBundle[] $targets, AssetBundle[] $bundles ) : AssetBundle[]	Adjust dependencies between asset bundles in the way source bundles begin to depend on output ones.
buildTarget ( AssetBundle $target, string $type, AssetBundle[] $bundles )	Builds output asset bundle.
compressCssFiles ( array $inputFiles, string $outputFile )	Compresses given CSS files and combines them into the single one.
compressJsFiles ( array $inputFiles, string $outputFile )	Compresses given JavaScript files and combines them into the single one.
loadBundles ( string[] $bundles ) : AssetBundle[]	Creates full list of source asset bundles.
loadConfiguration ( string $configFile )	Applies configuration from the given file to self instance.
loadDependency ( AssetBundle $bundle, array &$result )	Loads asset bundle dependencies recursively.
loadTargets ( array $targets, AssetBundle[] $bundles ) : AssetBundle[]	Creates full list of output asset bundles.
registerBundle ( AssetBundle[] $bundles, string $name, array &$registered )	Registers asset bundles including their dependencies.
saveTargets ( AssetBundle[] $targets, string $bundleFile )	Saves new asset bundles configuration.

Private Methods

Method	Description
composeBundleConfig ( AssetBundle $bundle ) : array
composeCircularDependencyTrace ( string $circularDependencyName, array $registered ) : string	Composes trace info for bundle circular dependency.
deletePublishedAssets ( AssetBundle[] $bundles )	Deletes bundle asset files, which have been published from sourcePath.
findRealPath ( string $path ) : string	Returns canonicalized absolute pathname.
isBundleExternal ( AssetBundle $bundle ) : boolean

Method Details

Property Details