AssetController.php 19.4 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\console\controllers;

use Yii;
use yii\console\Exception;
use yii\console\Controller;

/**
15 16
 * This command allows you to combine and compress your JavaScript and CSS files.
 *
17 18 19 20 21 22 23 24
 * Usage:
 * 1. Create a configuration file using '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.
 *
25
 * Note: in the console environment some path aliases like '@webroot' and '@web' may not exist,
26 27 28 29 30
 * 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.
 *
31 32
 * @property \yii\web\AssetManager $assetManager Asset manager instance. Note that the type of this property
 * differs in getter and setter. See [[getAssetManager()]] and [[setAssetManager()]] for details.
33
 *
Qiang Xue committed
34 35 36
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
37
class AssetController extends Controller
Qiang Xue committed
38
{
39 40 41
	/**
	 * @var string controller default action ID.
	 */
Qiang Xue committed
42
	public $defaultAction = 'compress';
43 44 45
	/**
	 * @var array list of asset bundles to be compressed.
	 */
Alexander Makarov committed
46
	public $bundles = [];
Qiang Xue committed
47
	/**
48 49 50
	 * @var array 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:
Qiang Xue committed
51
	 *
Qiang Xue committed
52
	 * ~~~
Alexander Makarov committed
53
	 * 'app\config\AllAsset' => [
Qiang Xue committed
54 55
	 *     'js' => 'js/all-{ts}.js',
	 *     'css' => 'css/all-{ts}.css',
Alexander Makarov committed
56 57
	 *     'depends' => [ ... ],
	 * ]
Qiang Xue committed
58
	 * ~~~
Qiang Xue committed
59
	 *
60 61
	 * File names can contain placeholder "{ts}", which will be filled by current timestamp, while
	 * file creation.
Qiang Xue committed
62
	 */
Alexander Makarov committed
63
	public $targets = [];
64
	/**
65
	 * @var string|callback JavaScript file compressor.
66 67
	 * If a string, it is treated as shell command template, which should contain
	 * placeholders {from} - source file name - and {to} - output file name.
68
	 * Otherwise, it is treated as PHP callback, which should perform the compression.
69 70 71 72
	 *
	 * Default value relies on usage of "Closure Compiler"
	 * @see https://developers.google.com/closure/compiler/
	 */
73
	public $jsCompressor = 'java -jar compiler.jar --js {from} --js_output_file {to}';
74 75 76 77
	/**
	 * @var string|callback 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.
78
	 * Otherwise, it is treated as PHP callback, which should perform the compression.
79 80 81 82
	 *
	 * Default value relies on usage of "YUI Compressor"
	 * @see https://github.com/yui/yuicompressor/
	 */
83
	public $cssCompressor = 'java -jar yuicompressor.jar {from} -o {to}';
Qiang Xue committed
84

Qiang Xue committed
85 86 87 88
	/**
	 * @var array|\yii\web\AssetManager [[yii\web\AssetManager]] instance or its array configuration, which will be used
	 * for assets processing.
	 */
Alexander Makarov committed
89
	private $_assetManager = [];
Qiang Xue committed
90

91
	/**
92 93
	 * Returns the asset manager instance.
	 * @throws \yii\console\Exception on invalid configuration.
94 95 96 97 98 99 100 101 102
	 * @return \yii\web\AssetManager asset manager instance.
	 */
	public function getAssetManager()
	{
		if (!is_object($this->_assetManager)) {
			$options = $this->_assetManager;
			if (!isset($options['class'])) {
				$options['class'] = 'yii\\web\\AssetManager';
			}
103 104 105 106 107 108
			if (!isset($options['basePath'])) {
				throw new Exception("Please specify 'basePath' for the 'assetManager' option.");
			}
			if (!isset($options['baseUrl'])) {
				throw new Exception("Please specify 'baseUrl' for the 'assetManager' option.");
			}
109 110 111 112 113 114
			$this->_assetManager = Yii::createObject($options);
		}
		return $this->_assetManager;
	}

	/**
115
	 * Sets asset manager instance or configuration.
116 117 118 119 120 121 122 123 124 125 126
	 * @param \yii\web\AssetManager|array $assetManager asset manager instance or its array configuration.
	 * @throws \yii\console\Exception on invalid argument type.
	 */
	public function setAssetManager($assetManager)
	{
		if (is_scalar($assetManager)) {
			throw new Exception('"' . get_class($this) . '::assetManager" should be either object or array - "' . gettype($assetManager) . '" given.');
		}
		$this->_assetManager = $assetManager;
	}

127
	/**
128
	 * Combines and compresses the asset files according to the given configuration.
129 130
	 * During the process new asset bundle configuration file will be created.
	 * You should replace your original asset bundle configuration with this file in order to use compressed files.
131
	 * @param string $configFile configuration file name.
132
	 * @param string $bundleFile output asset bundles configuration file name.
133
	 */
Qiang Xue committed
134 135 136
	public function actionCompress($configFile, $bundleFile)
	{
		$this->loadConfiguration($configFile);
Qiang Xue committed
137
		$bundles = $this->loadBundles($this->bundles);
Qiang Xue committed
138
		$targets = $this->loadTargets($this->targets, $bundles);
Qiang Xue committed
139
		$timestamp = time();
140 141
		foreach ($targets as $name => $target) {
			echo "Creating output bundle '{$name}':\n";
Qiang Xue committed
142
			if (!empty($target->js)) {
Qiang Xue committed
143 144
				$this->buildTarget($target, 'js', $bundles, $timestamp);
			}
Qiang Xue committed
145
			if (!empty($target->css)) {
Qiang Xue committed
146 147
				$this->buildTarget($target, 'css', $bundles, $timestamp);
			}
148
			echo "\n";
Qiang Xue committed
149 150 151
		}

		$targets = $this->adjustDependency($targets, $bundles);
Qiang Xue committed
152
		$this->saveTargets($targets, $bundleFile);
Qiang Xue committed
153 154
	}

155 156 157 158 159
	/**
	 * Applies configuration from the given file to self instance.
	 * @param string $configFile configuration file name.
	 * @throws \yii\console\Exception on failure.
	 */
Qiang Xue committed
160 161
	protected function loadConfiguration($configFile)
	{
162
		echo "Loading configuration from '{$configFile}'...\n";
Qiang Xue committed
163
		foreach (require($configFile) as $name => $value) {
164
			if (property_exists($this, $name) || $this->canSetProperty($name)) {
Qiang Xue committed
165 166
				$this->$name = $value;
			} else {
Qiang Xue committed
167
				throw new Exception("Unknown configuration option: $name");
Qiang Xue committed
168 169 170
			}
		}

171
		$this->getAssetManager(); // check if asset manager configuration is correct
Qiang Xue committed
172 173
	}

174
	/**
175
	 * Creates full list of source asset bundles.
Qiang Xue committed
176
	 * @param string[] $bundles list of asset bundle names
177
	 * @return \yii\web\AssetBundle[] list of source asset bundles.
178
	 */
Qiang Xue committed
179
	protected function loadBundles($bundles)
Qiang Xue committed
180
	{
181
		echo "Collecting source bundles information...\n";
182

Qiang Xue committed
183
		$am = $this->getAssetManager();
Alexander Makarov committed
184
		$result = [];
Qiang Xue committed
185 186
		foreach ($bundles as $name) {
			$result[$name] = $am->getBundle($name);
Qiang Xue committed
187
		}
Qiang Xue committed
188 189
		foreach ($result as $bundle) {
			$this->loadDependency($bundle, $result);
190 191
		}

Qiang Xue committed
192 193 194
		return $result;
	}

195 196 197 198
	/**
	 * Loads asset bundle dependencies recursively.
	 * @param \yii\web\AssetBundle $bundle bundle instance
	 * @param array $result already loaded bundles list.
Qiang Xue committed
199
	 * @throws Exception on failure.
200
	 */
Qiang Xue committed
201
	protected function loadDependency($bundle, &$result)
resurtm committed
202
	{
Qiang Xue committed
203 204 205 206 207 208 209 210 211
		$am = $this->getAssetManager();
		foreach ($bundle->depends as $name) {
			if (!isset($result[$name])) {
				$dependencyBundle = $am->getBundle($name);
				$result[$name] = false;
				$this->loadDependency($dependencyBundle, $result);
				$result[$name] = $dependencyBundle;
			} elseif ($result[$name] === false) {
				throw new Exception("A circular dependency is detected for bundle '$name'.");
212 213 214 215
			}
		}
	}

216
	/**
217 218 219 220
	 * Creates full list of output asset bundles.
	 * @param array $targets output asset bundles configuration.
	 * @param \yii\web\AssetBundle[] $bundles list of source asset bundles.
	 * @return \yii\web\AssetBundle[] list of output asset bundles.
Qiang Xue committed
221
	 * @throws Exception on failure.
222
	 */
Qiang Xue committed
223 224
	protected function loadTargets($targets, $bundles)
	{
225
		// build the dependency order of bundles
Alexander Makarov committed
226
		$registered = [];
Qiang Xue committed
227 228 229 230
		foreach ($bundles as $name => $bundle) {
			$this->registerBundle($bundles, $name, $registered);
		}
		$bundleOrders = array_combine(array_keys($registered), range(0, count($bundles) - 1));
231 232

		// fill up the target which has empty 'depends'.
Alexander Makarov committed
233
		$referenced = [];
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
		foreach ($targets as $name => $target) {
			if (empty($target['depends'])) {
				if (!isset($all)) {
					$all = $name;
				} else {
					throw new Exception("Only one target can have empty 'depends' option. Found two now: $all, $name");
				}
			} else {
				foreach ($target['depends'] as $bundle) {
					if (!isset($referenced[$bundle])) {
						$referenced[$bundle] = $name;
					} else {
						throw new Exception("Target '{$referenced[$bundle]}' and '$name' cannot contain the bundle '$bundle' at the same time.");
					}
				}
			}
		}
		if (isset($all)) {
			$targets[$all]['depends'] = array_diff(array_keys($registered), array_keys($referenced));
		}

		// adjust the 'depends' order for each target according to the dependency order of bundles
		// create an AssetBundle object for each target
Qiang Xue committed
257 258 259 260 261 262 263 264 265 266 267 268 269 270
		foreach ($targets as $name => $target) {
			if (!isset($target['basePath'])) {
				throw new Exception("Please specify 'basePath' for the '$name' target.");
			}
			if (!isset($target['baseUrl'])) {
				throw new Exception("Please specify 'baseUrl' for the '$name' target.");
			}
			usort($target['depends'], function ($a, $b) use ($bundleOrders) {
				if ($bundleOrders[$a] == $bundleOrders[$b]) {
					return 0;
				} else {
					return $bundleOrders[$a] > $bundleOrders[$b] ? 1 : -1;
				}
			});
Qiang Xue committed
271
			$target['class'] = $name;
Qiang Xue committed
272 273 274 275 276
			$targets[$name] = Yii::createObject($target);
		}
		return $targets;
	}

Qiang Xue committed
277
	/**
278 279
	 * Builds output asset bundle.
	 * @param \yii\web\AssetBundle $target output asset bundle
280
	 * @param string $type either 'js' or 'css'.
281 282 283
	 * @param \yii\web\AssetBundle[] $bundles source asset bundles.
	 * @param integer $timestamp current timestamp.
	 * @throws Exception on failure.
Qiang Xue committed
284
	 */
Qiang Xue committed
285
	protected function buildTarget($target, $type, $bundles, $timestamp)
Qiang Xue committed
286
	{
Alexander Makarov committed
287
		$outputFile = strtr($target->$type, [
Qiang Xue committed
288
			'{ts}' => $timestamp,
Alexander Makarov committed
289 290
		]);
		$inputFiles = [];
Qiang Xue committed
291 292

		foreach ($target->depends as $name) {
Qiang Xue committed
293 294
			if (isset($bundles[$name])) {
				foreach ($bundles[$name]->$type as $file) {
295
					$inputFiles[] = $bundles[$name]->basePath . '/' . $file;
Qiang Xue committed
296 297
				}
			} else {
298
				throw new Exception("Unknown bundle: '{$name}'");
Qiang Xue committed
299 300 301
			}
		}
		if ($type === 'js') {
Qiang Xue committed
302
			$this->compressJsFiles($inputFiles, $target->basePath . '/' . $outputFile);
Qiang Xue committed
303
		} else {
Qiang Xue committed
304
			$this->compressCssFiles($inputFiles, $target->basePath . '/' . $outputFile);
Qiang Xue committed
305
		}
Alexander Makarov committed
306
		$target->$type = [$outputFile];
Qiang Xue committed
307 308
	}

309
	/**
310 311 312 313
	 * Adjust dependencies between asset bundles in the way source bundles begin to depend on output ones.
	 * @param \yii\web\AssetBundle[] $targets output asset bundles.
	 * @param \yii\web\AssetBundle[] $bundles source asset bundles.
	 * @return \yii\web\AssetBundle[] output asset bundles.
314
	 */
Qiang Xue committed
315 316
	protected function adjustDependency($targets, $bundles)
	{
317 318
		echo "Creating new bundle configuration...\n";

Alexander Makarov committed
319
		$map = [];
Qiang Xue committed
320 321
		foreach ($targets as $name => $target) {
			foreach ($target->depends as $bundle) {
322
				$map[$bundle] = $name;
Qiang Xue committed
323 324 325 326
			}
		}

		foreach ($targets as $name => $target) {
Alexander Makarov committed
327
			$depends = [];
Qiang Xue committed
328 329 330 331 332 333 334 335 336 337 338
			foreach ($target->depends as $bn) {
				foreach ($bundles[$bn]->depends as $bundle) {
					$depends[$map[$bundle]] = true;
				}
			}
			unset($depends[$name]);
			$target->depends = array_keys($depends);
		}

		// detect possible circular dependencies
		foreach ($targets as $name => $target) {
Alexander Makarov committed
339
			$registered = [];
Qiang Xue committed
340 341 342 343
			$this->registerBundle($targets, $name, $registered);
		}

		foreach ($map as $bundle => $target) {
Alexander Makarov committed
344
			$targets[$bundle] = Yii::createObject([
Qiang Xue committed
345
				'class' => 'yii\\web\\AssetBundle',
Alexander Makarov committed
346 347
				'depends' => [$target],
			]);
Qiang Xue committed
348
		}
Qiang Xue committed
349 350 351
		return $targets;
	}

352 353 354 355 356
	/**
	 * Registers asset bundles including their dependencies.
	 * @param \yii\web\AssetBundle[] $bundles asset bundles list.
	 * @param string $name bundle name.
	 * @param array $registered stores already registered names.
Qiang Xue committed
357
	 * @throws Exception if circular dependency is detected.
358
	 */
Qiang Xue committed
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
	protected function registerBundle($bundles, $name, &$registered)
	{
		if (!isset($registered[$name])) {
			$registered[$name] = false;
			$bundle = $bundles[$name];
			foreach ($bundle->depends as $depend) {
				$this->registerBundle($bundles, $depend, $registered);
			}
			unset($registered[$name]);
			$registered[$name] = true;
		} elseif ($registered[$name] === false) {
			throw new Exception("A circular dependency is detected for target '$name'.");
		}
	}

374 375 376 377
	/**
	 * Saves new asset bundles configuration.
	 * @param \yii\web\AssetBundle[] $targets list of asset bundles to be saved.
	 * @param string $bundleFile output file name.
378
	 * @throws \yii\console\Exception on failure.
379
	 */
Qiang Xue committed
380 381
	protected function saveTargets($targets, $bundleFile)
	{
Alexander Makarov committed
382
		$array = [];
Qiang Xue committed
383
		foreach ($targets as $name => $target) {
Alexander Makarov committed
384
			foreach (['js', 'css', 'depends', 'basePath', 'baseUrl'] as $prop) {
Qiang Xue committed
385 386 387 388 389 390 391
				if (!empty($target->$prop)) {
					$array[$name][$prop] = $target->$prop;
				}
			}
		}
		$array = var_export($array, true);
		$version = date('Y-m-d H:i:s', time());
392
		$bundleFileContent = <<<EOD
Qiang Xue committed
393 394
<?php
/**
395
 * This file is generated by the "yii {$this->id}" command.
396
 * DO NOT MODIFY THIS FILE DIRECTLY.
397
 * @version {$version}
Qiang Xue committed
398
 */
399
return {$array};
400 401
EOD;
		if (!file_put_contents($bundleFile, $bundleFileContent)) {
402 403 404
			throw new Exception("Unable to write output bundle configuration at '{$bundleFile}'.");
		}
		echo "Output bundle configuration created at '{$bundleFile}'.\n";
Qiang Xue committed
405 406
	}

407
	/**
408
	 * Compresses given JavaScript files and combines them into the single one.
409 410
	 * @param array $inputFiles list of source file names.
	 * @param string $outputFile output file name.
411
	 * @throws \yii\console\Exception on failure
412
	 */
Qiang Xue committed
413 414
	protected function compressJsFiles($inputFiles, $outputFile)
	{
415 416 417 418
		if (empty($inputFiles)) {
			return;
		}
		echo "  Compressing JavaScript files...\n";
419 420 421
		if (is_string($this->jsCompressor)) {
			$tmpFile = $outputFile . '.tmp';
			$this->combineJsFiles($inputFiles, $tmpFile);
Alexander Makarov committed
422
			echo shell_exec(strtr($this->jsCompressor, [
423 424
				'{from}' => escapeshellarg($tmpFile),
				'{to}' => escapeshellarg($outputFile),
Alexander Makarov committed
425
			]));
426 427
			@unlink($tmpFile);
		} else {
428
			call_user_func($this->jsCompressor, $this, $inputFiles, $outputFile);
429
		}
430 431 432 433
		if (!file_exists($outputFile)) {
			throw new Exception("Unable to compress JavaScript files into '{$outputFile}'.");
		}
		echo "  JavaScript files compressed into '{$outputFile}'.\n";
Qiang Xue committed
434 435
	}

436 437 438 439
	/**
	 * Compresses given CSS files and combines them into the single one.
	 * @param array $inputFiles list of source file names.
	 * @param string $outputFile output file name.
440
	 * @throws \yii\console\Exception on failure
441
	 */
Qiang Xue committed
442 443
	protected function compressCssFiles($inputFiles, $outputFile)
	{
444 445 446 447
		if (empty($inputFiles)) {
			return;
		}
		echo "  Compressing CSS files...\n";
448 449 450
		if (is_string($this->cssCompressor)) {
			$tmpFile = $outputFile . '.tmp';
			$this->combineCssFiles($inputFiles, $tmpFile);
Alexander Makarov committed
451
			echo shell_exec(strtr($this->cssCompressor, [
452 453
				'{from}' => escapeshellarg($tmpFile),
				'{to}' => escapeshellarg($outputFile),
Alexander Makarov committed
454
			]));
455
			@unlink($tmpFile);
456
		} else {
457
			call_user_func($this->cssCompressor, $this, $inputFiles, $outputFile);
458
		}
459 460 461 462
		if (!file_exists($outputFile)) {
			throw new Exception("Unable to compress CSS files into '{$outputFile}'.");
		}
		echo "  CSS files compressed into '{$outputFile}'.\n";
463 464
	}

465
	/**
466
	 * Combines JavaScript files into a single one.
467 468
	 * @param array $inputFiles source file names.
	 * @param string $outputFile output file name.
469
	 * @throws \yii\console\Exception on failure.
470 471
	 */
	public function combineJsFiles($inputFiles, $outputFile)
472 473
	{
		$content = '';
474
		foreach ($inputFiles as $file) {
475 476 477 478
			$content .= "/*** BEGIN FILE: $file ***/\n"
				. file_get_contents($file)
				. "/*** END FILE: $file ***/\n";
		}
479
		if (!file_put_contents($outputFile, $content)) {
480
			throw new Exception("Unable to write output JavaScript file '{$outputFile}'.");
481
		}
482 483
	}

484 485 486 487
	/**
	 * Combines CSS files into a single one.
	 * @param array $inputFiles source file names.
	 * @param string $outputFile output file name.
488
	 * @throws \yii\console\Exception on failure.
489 490
	 */
	public function combineCssFiles($inputFiles, $outputFile)
491 492
	{
		$content = '';
493
		foreach ($inputFiles as $file) {
494
			$content .= "/*** BEGIN FILE: $file ***/\n"
495
				. $this->adjustCssUrl(file_get_contents($file), dirname($file), dirname($outputFile))
496 497
				. "/*** END FILE: $file ***/\n";
		}
498 499 500
		if (!file_put_contents($outputFile, $content)) {
			throw new Exception("Unable to write output CSS file '{$outputFile}'.");
		}
501 502
	}

503 504 505 506 507 508 509 510 511
	/**
	 * Adjusts CSS content allowing URL references pointing to the original resources.
	 * @param string $cssContent source CSS content.
	 * @param string $inputFilePath input CSS file name.
	 * @param string $outputFilePath output CSS file name.
	 * @return string adjusted CSS content.
	 */
	protected function adjustCssUrl($cssContent, $inputFilePath, $outputFilePath)
	{
Alexander Makarov committed
512
		$sharedPathParts = [];
513 514 515 516 517 518 519 520
		$inputFilePathParts = explode('/', $inputFilePath);
		$inputFilePathPartsCount = count($inputFilePathParts);
		$outputFilePathParts = explode('/', $outputFilePath);
		$outputFilePathPartsCount = count($outputFilePathParts);
		for ($i =0; $i < $inputFilePathPartsCount && $i < $outputFilePathPartsCount; $i++) {
			if ($inputFilePathParts[$i] == $outputFilePathParts[$i]) {
				$sharedPathParts[] = $inputFilePathParts[$i];
			} else {
521 522 523
				break;
			}
		}
524 525
		$sharedPath = implode('/', $sharedPathParts);

526 527 528 529 530
		$inputFileRelativePath = trim(str_replace($sharedPath, '', $inputFilePath), '/');
		$outputFileRelativePath = trim(str_replace($sharedPath, '', $outputFilePath), '/');
		$inputFileRelativePathParts = explode('/', $inputFileRelativePath);
		$outputFileRelativePathParts = explode('/', $outputFileRelativePath);

resurtm committed
531
		$callback = function ($matches) use ($inputFileRelativePathParts, $outputFileRelativePathParts) {
532 533 534
			$fullMatch = $matches[0];
			$inputUrl = $matches[1];

535 536 537 538
			if (preg_match('/https?:\/\//is', $inputUrl)) {
				return $fullMatch;
			}

539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
			$outputUrlParts = array_fill(0, count($outputFileRelativePathParts), '..');
			$outputUrlParts = array_merge($outputUrlParts, $inputFileRelativePathParts);

			if (strpos($inputUrl, '/') !== false) {
				$inputUrlParts = explode('/', $inputUrl);
				foreach ($inputUrlParts as $key => $inputUrlPart) {
					if ($inputUrlPart == '..') {
						array_pop($outputUrlParts);
						unset($inputUrlParts[$key]);
					}
				}
				$outputUrlParts[] = implode('/', $inputUrlParts);
			} else {
				$outputUrlParts[] = $inputUrl;
			}
			$outputUrl = implode('/', $outputUrlParts);
555 556

			return str_replace($inputUrl, $outputUrl, $fullMatch);
557
		};
558

559
		$cssContent = preg_replace_callback('/url\(["\']?([^"]*)["\']?\)/is', $callback, $cssContent);
560 561 562 563

		return $cssContent;
	}

564 565 566
	/**
	 * Creates template of configuration file for [[actionCompress]].
	 * @param string $configFile output file name.
567
	 * @throws \yii\console\Exception on failure.
568
	 */
569 570 571 572
	public function actionTemplate($configFile)
	{
		$template = <<<EOD
<?php
573 574
/**
 * Configuration file for the "yii asset" console command.
575
 * Note that in the console environment, some path aliases like '@webroot' and '@web' may not exist.
Qiang Xue committed
576
 * Please define these missing path aliases.
577
 */
Alexander Makarov committed
578
return [
579
	// The list of asset bundles to compress:
Alexander Makarov committed
580
	'bundles' => [
Qiang Xue committed
581 582
		// 'yii\web\YiiAsset',
		// 'yii\web\JqueryAsset',
Alexander Makarov committed
583
	],
584
	// Asset bundle for compression output:
Alexander Makarov committed
585 586
	'targets' => [
		'app\config\AllAsset' => [
587
			'basePath' => 'path/to/web',
Qiang Xue committed
588 589 590
			'baseUrl' => '',
			'js' => 'js/all-{ts}.js',
			'css' => 'css/all-{ts}.css',
Alexander Makarov committed
591 592
		],
	],
593
	// Asset manager configuration:
Alexander Makarov committed
594
	'assetManager' => [
595
		'basePath' => __DIR__,
Qiang Xue committed
596
		'baseUrl' => '',
Alexander Makarov committed
597
	],
Qiang Xue committed
598
];
599
EOD;
600 601 602 603 604
		if (file_exists($configFile)) {
			if (!$this->confirm("File '{$configFile}' already exists. Do you wish to overwrite it?")) {
				return;
			}
		}
605 606
		if (!file_put_contents($configFile, $template)) {
			throw new Exception("Unable to write template file '{$configFile}'.");
607 608 609
		} else {
			echo "Configuration file template created at '{$configFile}'.\n\n";
		}
Qiang Xue committed
610
	}
Zander Baldwin committed
611
}