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.

158 lines
5.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;
/**
* @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 asset manager via
* 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;
/**
* @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
*
* Each JavaScript file may be associated with options. In this case, the array key
* should be the JavaScript file path, while the corresponding array value should
* be the option array. The options will be passed to [[ViewContent::registerJsFile()]].
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.
*
* Each CSS file may be associated with options. In this case, the array key
* should be the CSS file path, while the corresponding array value should
* be the option array. The options will be passed to [[ViewContent::registerCssFile()]].
*/
12 years ago
public $css = array();
12 years ago
/**
* @var array list of the bundle names that this bundle depends on
*/
12 years ago
public $depends = array();
12 years ago
/**
* Initializes the bundle.
*/
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
/**
12 years ago
* @param \yii\base\ViewContent $page
* @param AssetManager $am
* @throws InvalidConfigException
12 years ago
*/
12 years ago
public function registerAssets($page, $am)
12 years ago
{
foreach ($this->depends as $name) {
12 years ago
$page->registerAssetBundle($name);
}
if ($this->sourcePath !== null) {
list ($this->basePath, $this->baseUrl) = $am->publish($this->sourcePath);
12 years ago
}
12 years ago
12 years ago
foreach ($this->js as $js => $options) {
12 years ago
$js = is_string($options) ? $options : $js;
12 years ago
if (strpos($js, '/') !== 0 && strpos($js, '://') === false) {
if (isset($this->basePath, $this->baseUrl)) {
$js = $this->processAsset(ltrim($js, '/'), $this->basePath, $this->baseUrl);
} else {
throw new InvalidConfigException('Both of the "baseUrl" and "basePath" properties must be set.');
}
12 years ago
}
12 years ago
$page->registerJsFile($js, is_array($options) ? $options : array());
12 years ago
}
foreach ($this->css as $css => $options) {
12 years ago
$css = is_string($options) ? $options : $css;
if (strpos($css, '//') !== 0 && strpos($css, '://') === false) {
12 years ago
if (isset($this->basePath, $this->baseUrl)) {
$css = $this->processAsset(ltrim($css, '/'), $this->basePath, $this->baseUrl);
} else {
throw new InvalidConfigException('Both of the "baseUrl" and "basePath" properties must be set.');
}
12 years ago
}
12 years ago
$page->registerCssFile($css, is_array($options) ? $options : array());
12 years ago
}
}
12 years ago
/**
12 years ago
* Processes the given asset file and returns a URL to the processed one.
* This method can be overwritten to support various types of asset files, such as LESS, Sass, TypeScript.
*
* Note that if the asset file is converted into another file, the new file must reside under the same
* directory as the given asset file.
*
* @param string $asset the asset file path to be processed.
* @return string the processed asset file path.
12 years ago
*/
12 years ago
protected function processAsset($asset, $basePath, $baseUrl)
12 years ago
{
12 years ago
return $this->baseUrl . '/' . $asset;
12 years ago
}
12 years ago
}