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

namespace yii\web;

Qiang Xue committed
10
use Yii;
Qiang Xue committed
11
use yii\base\InvalidConfigException;
Qiang Xue committed
12 13 14
use yii\base\Object;

/**
15 16 17 18 19 20 21 22
 * AssetBundle represents a collection of asset files, such as CSS, JS, images.
 *
 * Each asset bundle has a unique name that globally identifies it among all asset bundles
 * used in an application.
 *
 * An asset bundle can depend on other asset bundles. When registering an asset bundle
 * with a view, all its dependent asset bundles will be automatically registered.
 *
Qiang Xue committed
23 24 25 26 27
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class AssetBundle extends Object
{
Qiang Xue committed
28
	/**
Qiang Xue committed
29 30 31 32 33 34 35 36 37 38
	 * @var string the root directory of the source asset files. A source asset file
	 * is a file that is part of your source code repository of your Web application.
	 *
	 * You must set this property if the directory containing the source asset files
	 * is not Web accessible (this is usually the case for extensions).
	 *
	 * By setting this property, the asset manager will publish the source asset files
	 * to a Web-accessible directory [[basePath]].
	 *
	 * You can use either a directory or an alias of the directory.
Qiang Xue committed
39 40 41
	 */
	public $sourcePath;
	/**
Qiang Xue committed
42 43 44 45 46 47 48 49 50 51
	 * @var string the Web-accessible directory that contains the asset files in this bundle.
	 *
	 * If [[sourcePath]] is set, this property will be *overwritten* by [[AssetManager]]
	 * when it publishes the asset files from [[sourcePath]].
	 *
	 * If the bundle contains any assets that are specified in terms of relative file path,
	 * then this property must be set either manually or automatically (by asset manager via
	 * asset publishing).
	 *
	 * You can use either a directory or an alias of the directory.
Qiang Xue committed
52
	 */
Qiang Xue committed
53
	public $basePath;
Qiang Xue committed
54
	/**
Qiang Xue committed
55 56 57 58 59 60 61 62 63 64 65
	 * @var string the base URL that will be prefixed to the asset files for them to
	 * be accessed via Web server.
	 *
	 * If [[sourcePath]] is set, this property will be *overwritten* by [[AssetManager]]
	 * when it publishes the asset files from [[sourcePath]].
	 *
	 * If the bundle contains any assets that are specified in terms of relative file path,
	 * then this property must be set either manually or automatically (by asset manager via
	 * asset publishing).
	 *
	 * You can use either a URL or an alias of the URL.
Qiang Xue committed
66 67
	 */
	public $baseUrl;
Qiang Xue committed
68 69 70 71
	/**
	 * @var array list of the bundle names that this bundle depends on
	 */
	public $depends = array();
Qiang Xue committed
72 73
	/**
	 * @var array list of JavaScript files that this bundle contains. Each JavaScript file can
Qiang Xue committed
74 75
	 * be either a file path (without leading slash) relative to [[basePath]] or a URL representing
	 * an external JavaScript file.
Qiang Xue committed
76
	 *
Qiang Xue committed
77
	 * Note that only forward slash "/" can be used as directory separator.
Qiang Xue committed
78
	 */
Qiang Xue committed
79
	public $js = array();
80 81
	/**
	 * @var array list of CSS files that this bundle contains. Each CSS file can
Qiang Xue committed
82 83
	 * be either a file path (without leading slash) relative to [[basePath]] or a URL representing
	 * an external CSS file.
84
	 *
Qiang Xue committed
85
	 * Note that only forward slash "/" can be used as directory separator.
86
	 */
Qiang Xue committed
87
	public $css = array();
Qiang Xue committed
88
	/**
Qiang Xue committed
89 90
	 * @var array the options that will be passed to [[\yii\base\View::registerJsFile()]]
	 * when registering the JS files in this bundle.
Qiang Xue committed
91
	 */
Qiang Xue committed
92 93 94 95 96 97
	public $jsOptions = array();
	/**
	 * @var array the options that will be passed to [[\yii\base\View::registerCssFile()]]
	 * when registering the CSS files in this bundle.
	 */
	public $cssOptions = array();
Qiang Xue committed
98 99 100 101
	/**
	 * @var array the options to be passed to [[AssetManager::publish()]] when the asset bundle
	 * is being published.
	 */
102
	public $publishOptions = array();
Qiang Xue committed
103

Qiang Xue committed
104 105 106
	/**
	 * Initializes the bundle.
	 */
Qiang Xue committed
107
	public function init()
Qiang Xue committed
108
	{
Qiang Xue committed
109 110
		if ($this->sourcePath !== null) {
			$this->sourcePath = rtrim(Yii::getAlias($this->sourcePath), '/\\');
Qiang Xue committed
111
		}
Qiang Xue committed
112 113 114 115 116 117
		if ($this->basePath !== null) {
			$this->basePath = rtrim(Yii::getAlias($this->basePath), '/\\');
		}
		if ($this->baseUrl !== null) {
			$this->baseUrl = rtrim(Yii::getAlias($this->baseUrl), '/');
		}
Qiang Xue committed
118 119
	}

Qiang Xue committed
120
	/**
121 122 123 124 125 126 127
	 * Registers the CSS and JS files with the given view.
	 * This method will first register all dependent asset bundles.
	 * It will then try to convert non-CSS or JS files (e.g. LESS, Sass) into the corresponding
	 * CSS or JS files using [[AssetManager::converter|asset converter]].
	 * @param \yii\base\View $view the view that the asset files to be registered with.
	 * @throws InvalidConfigException if [[baseUrl]] or [[basePath]] is not set when the bundle
	 * contains internal CSS or JS files.
Qiang Xue committed
128
	 */
129
	public function registerAssets($view)
Qiang Xue committed
130 131
	{
		foreach ($this->depends as $name) {
132
			$view->registerAssetBundle($name);
Qiang Xue committed
133 134
		}

Qiang Xue committed
135
		$this->publish($view->getAssetManager());
Qiang Xue committed
136

Qiang Xue committed
137 138 139 140 141 142 143
		foreach ($this->js as $js) {
			$view->registerJsFile($js, $this->jsOptions);
		}
		foreach ($this->css as $css) {
			$view->registerCssFile($css, $this->cssOptions);
		}
	}
Qiang Xue committed
144

Qiang Xue committed
145 146 147 148 149 150 151 152 153 154 155 156 157
	/**
	 * Publishes the asset bundle if its source code is not under Web-accessible directory.
	 * @param AssetManager $am the asset manager to perform the asset publishing
	 * @throws InvalidConfigException if [[baseUrl]] or [[basePath]] is not set when the bundle
	 * contains internal CSS or JS files.
	 */
	public function publish($am)
	{
		if ($this->sourcePath !== null) {
			list ($this->basePath, $this->baseUrl) = $am->publish($this->sourcePath, $this->publishOptions);
		}
		$converter = $am->getConverter();
		foreach ($this->js as $i => $js) {
Qiang Xue committed
158 159
			if (strpos($js, '/') !== 0 && strpos($js, '://') === false) {
				if (isset($this->basePath, $this->baseUrl)) {
Qiang Xue committed
160
					$this->js[$i] = $converter->convert($js, $this->basePath, $this->baseUrl);
Qiang Xue committed
161 162 163
				} else {
					throw new InvalidConfigException('Both of the "baseUrl" and "basePath" properties must be set.');
				}
Qiang Xue committed
164 165
			}
		}
Qiang Xue committed
166
		foreach ($this->css as $i => $css) {
167
			if (strpos($css, '/') !== 0 && strpos($css, '://') === false) {
Qiang Xue committed
168
				if (isset($this->basePath, $this->baseUrl)) {
Qiang Xue committed
169
					$this->css[$i] = $converter->convert($css, $this->basePath, $this->baseUrl);
Qiang Xue committed
170 171 172
				} else {
					throw new InvalidConfigException('Both of the "baseUrl" and "basePath" properties must be set.');
				}
Qiang Xue committed
173
			}
Qiang Xue committed
174 175
		}
	}
Zander Baldwin committed
176
}