You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

188 lines
6.4 KiB

12 years ago
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\web;
12 years ago
use Yii;
12 years ago
use yii\base\InvalidConfigException;
12 years ago
use yii\base\Object;
use yii\base\View;
12 years ago
/**
* 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.
*
12 years ago
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/
class AssetBundle extends Object
{
12 years ago
/**
12 years ago
* @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.
12 years ago
*/
public $sourcePath;
/**
12 years ago
* @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 [[AssetManager]] via
12 years ago
* asset publishing).
*
* You can use either a directory or an alias of the directory.
12 years ago
*/
12 years ago
public $basePath;
12 years ago
/**
12 years ago
* @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.
12 years ago
*/
public $baseUrl;
/**
12 years ago
* @var array list of the bundle names that this bundle depends on
*/
public $depends = array();
/**
12 years ago
* @var array list of JavaScript files that this bundle contains. Each JavaScript file can
12 years ago
* be either a file path (without leading slash) relative to [[basePath]] or a URL representing
* an external JavaScript file.
12 years ago
*
12 years ago
* Note that only forward slash "/" can be used as directory separator.
12 years ago
*/
12 years ago
public $js = array();
/**
* @var array list of CSS files that this bundle contains. Each CSS file can
12 years ago
* be either a file path (without leading slash) relative to [[basePath]] or a URL representing
* an external CSS file.
*
12 years ago
* Note that only forward slash "/" can be used as directory separator.
*/
12 years ago
public $css = array();
12 years ago
/**
12 years ago
* @var array the options that will be passed to [[\yii\base\View::registerJsFile()]]
* when registering the JS files in this bundle.
12 years ago
*/
12 years ago
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();
12 years ago
/**
* @var array the options to be passed to [[AssetManager::publish()]] when the asset bundle
* is being published.
*/
public $publishOptions = array();
12 years ago
12 years ago
/**
* @param View $view
* @return AssetBundle the registered asset bundle instance
*/
public static function register($view)
{
return $view->registerAssetBundle(get_called_class());
}
/**
12 years ago
* Initializes the bundle.
* If you override this method, make sure you call the parent implementation in the last.
12 years ago
*/
12 years ago
public function init()
12 years ago
{
12 years ago
if ($this->sourcePath !== null) {
$this->sourcePath = rtrim(Yii::getAlias($this->sourcePath), '/\\');
12 years ago
}
12 years ago
if ($this->basePath !== null) {
$this->basePath = rtrim(Yii::getAlias($this->basePath), '/\\');
}
if ($this->baseUrl !== null) {
$this->baseUrl = rtrim(Yii::getAlias($this->baseUrl), '/');
}
12 years ago
}
12 years ago
/**
* 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.
12 years ago
*/
public function registerAssets($view)
12 years ago
{
foreach ($this->depends as $name) {
$view->registerAssetBundle($name);
12 years ago
}
12 years ago
$this->publish($view->getAssetManager());
12 years ago
12 years ago
foreach ($this->js as $js) {
$view->registerJsFile($this->baseUrl . '/' . $js, $this->jsOptions);
12 years ago
}
foreach ($this->css as $css) {
$view->registerCssFile($this->baseUrl . '/' . $css, $this->cssOptions);
12 years ago
}
}
12 years ago
/**
* 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 && !isset($this->basePath, $this->baseUrl)) {
12 years ago
list ($this->basePath, $this->baseUrl) = $am->publish($this->sourcePath, $this->publishOptions);
}
$converter = $am->getConverter();
foreach ($this->js as $i => $js) {
12 years ago
if (strpos($js, '/') !== 0 && strpos($js, '://') === false) {
if (isset($this->basePath, $this->baseUrl)) {
12 years ago
$this->js[$i] = $converter->convert($js, $this->basePath, $this->baseUrl);
12 years ago
} else {
throw new InvalidConfigException('Both of the "baseUrl" and "basePath" properties must be set.');
}
12 years ago
}
}
12 years ago
foreach ($this->css as $i => $css) {
if (strpos($css, '/') !== 0 && strpos($css, '://') === false) {
12 years ago
if (isset($this->basePath, $this->baseUrl)) {
12 years ago
$this->css[$i] = $converter->convert($css, $this->basePath, $this->baseUrl);
12 years ago
} else {
throw new InvalidConfigException('Both of the "baseUrl" and "basePath" properties must be set.');
}
12 years ago
}
}
}
}