AssetBundle.php 6.29 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
use yii\base\Object;
13
use yii\base\View;
Qiang Xue committed
14 15

/**
16 17 18 19 20 21 22 23
 * 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
24 25 26 27 28
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class AssetBundle extends Object
{
Qiang Xue committed
29
	/**
Qiang Xue committed
30 31 32 33 34 35 36 37 38 39
	 * @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
40 41 42
	 */
	public $sourcePath;
	/**
Qiang Xue committed
43 44 45 46 47 48
	 * @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,
Qiang Xue committed
49
	 * then this property must be set either manually or automatically (by [[AssetManager]] via
Qiang Xue committed
50 51 52
	 * asset publishing).
	 *
	 * You can use either a directory or an alias of the directory.
Qiang Xue committed
53
	 */
Qiang Xue committed
54
	public $basePath;
Qiang Xue committed
55
	/**
Qiang Xue committed
56 57 58 59 60 61 62 63 64 65 66
	 * @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
67 68
	 */
	public $baseUrl;
Qiang Xue committed
69 70 71 72
	/**
	 * @var array list of the bundle names that this bundle depends on
	 */
	public $depends = array();
Qiang Xue committed
73 74
	/**
	 * @var array list of JavaScript files that this bundle contains. Each JavaScript file can
Qiang Xue committed
75 76
	 * be either a file path (without leading slash) relative to [[basePath]] or a URL representing
	 * an external JavaScript file.
Qiang Xue committed
77
	 *
Qiang Xue committed
78
	 * Note that only forward slash "/" can be used as directory separator.
Qiang Xue committed
79
	 */
Qiang Xue committed
80
	public $js = array();
81 82
	/**
	 * @var array list of CSS files that this bundle contains. Each CSS file can
Qiang Xue committed
83 84
	 * be either a file path (without leading slash) relative to [[basePath]] or a URL representing
	 * an external CSS file.
85
	 *
Qiang Xue committed
86
	 * Note that only forward slash "/" can be used as directory separator.
87
	 */
Qiang Xue committed
88
	public $css = array();
Qiang Xue committed
89
	/**
Qiang Xue committed
90 91
	 * @var array the options that will be passed to [[\yii\base\View::registerJsFile()]]
	 * when registering the JS files in this bundle.
Qiang Xue committed
92
	 */
Qiang Xue committed
93 94 95 96 97 98
	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
99 100 101 102
	/**
	 * @var array the options to be passed to [[AssetManager::publish()]] when the asset bundle
	 * is being published.
	 */
103
	public $publishOptions = array();
Qiang Xue committed
104

105 106 107 108 109 110 111 112 113
	/**
	 * @param View $view
	 * @return AssetBundle the registered asset bundle instance
	 */
	public static function register($view)
	{
		return $view->registerAssetBundle(get_called_class());
	}

Qiang Xue committed
114 115 116
	/**
	 * Initializes the bundle.
	 */
Qiang Xue committed
117
	public function init()
Qiang Xue committed
118
	{
Qiang Xue committed
119 120
		if ($this->sourcePath !== null) {
			$this->sourcePath = rtrim(Yii::getAlias($this->sourcePath), '/\\');
Qiang Xue committed
121
		}
Qiang Xue committed
122 123 124 125 126 127
		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
128 129
	}

Qiang Xue committed
130
	/**
131 132 133 134 135 136 137
	 * 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
138
	 */
139
	public function registerAssets($view)
Qiang Xue committed
140 141
	{
		foreach ($this->depends as $name) {
142
			$view->registerAssetBundle($name);
Qiang Xue committed
143 144
		}

Qiang Xue committed
145
		$this->publish($view->getAssetManager());
Qiang Xue committed
146

Qiang Xue committed
147
		foreach ($this->js as $js) {
148
			$view->registerJsFile($this->baseUrl . '/' . $js, $this->jsOptions);
Qiang Xue committed
149 150
		}
		foreach ($this->css as $css) {
151
			$view->registerCssFile($this->baseUrl . '/' . $css, $this->cssOptions);
Qiang Xue committed
152 153
		}
	}
Qiang Xue committed
154

Qiang Xue committed
155 156 157 158 159 160 161 162
	/**
	 * 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)
	{
163
		if ($this->sourcePath !== null && !isset($this->basePath, $this->baseUrl)) {
Qiang Xue committed
164 165 166 167
			list ($this->basePath, $this->baseUrl) = $am->publish($this->sourcePath, $this->publishOptions);
		}
		$converter = $am->getConverter();
		foreach ($this->js as $i => $js) {
Qiang Xue committed
168 169
			if (strpos($js, '/') !== 0 && strpos($js, '://') === false) {
				if (isset($this->basePath, $this->baseUrl)) {
Qiang Xue committed
170
					$this->js[$i] = $converter->convert($js, $this->basePath, $this->baseUrl);
Qiang Xue committed
171 172 173
				} else {
					throw new InvalidConfigException('Both of the "baseUrl" and "basePath" properties must be set.');
				}
Qiang Xue committed
174 175
			}
		}
Qiang Xue committed
176
		foreach ($this->css as $i => $css) {
177
			if (strpos($css, '/') !== 0 && strpos($css, '://') === false) {
Qiang Xue committed
178
				if (isset($this->basePath, $this->baseUrl)) {
Qiang Xue committed
179
					$this->css[$i] = $converter->convert($css, $this->basePath, $this->baseUrl);
Qiang Xue committed
180 181 182
				} else {
					throw new InvalidConfigException('Both of the "baseUrl" and "basePath" properties must be set.');
				}
Qiang Xue committed
183
			}
Qiang Xue committed
184 185
		}
	}
Zander Baldwin committed
186
}