php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-11-19 16:01:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

adjusted asset phpdoc after refactoring #996

Browse Source
This commit is contained in:
Carsten Brandt
2013-10-20 12:45:05 +02:00
parent c2dabfa78e
commit 1475b46249
2 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
framework/yii/base/View.php
View File

@@ -540,7 +540,7 @@ class View extends Component
/** /**
* Registers all files provided by an asset bundle including depending bundles files. * Registers all files provided by an asset bundle including depending bundles files.
* Removes a bundle from [[assetBundles]] once registered. * Removes a bundle from [[assetBundles]] once files are registered.
* @param string $name name of the bundle to register * @param string $name name of the bundle to register
*/ */
private function registerAssetFiles($name) private function registerAssetFiles($name)

13
framework/yii/web/AssetBundle.php
View File

@@ -15,8 +15,9 @@ use yii\base\View;
/** /**
* AssetBundle represents a collection of asset files, such as CSS, JS, images. * 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 * Each asset bundle has a unique name that globally identifies it among all asset bundles used in an application.
* used in an application. * The name is the [fully qualified class name](http://php.net/manual/en/language.namespaces.rules.php)
* of the class representing it.
* *
* An asset bundle can depend on other asset bundles. When registering an asset bundle * 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. * with a view, all its dependent asset bundles will be automatically registered.
@@ -130,11 +131,7 @@ class AssetBundle extends Object
/** /**
* Registers the CSS and JS files with the given view. * Registers the CSS and JS files with the given view.
* It will then try to convert non-CSS or JS files (e.g. LESS, Sass) into the corresponding * @param \yii\base\View $view the view that the asset files are to be registered with.
* 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.
*/ */
public function registerAssets($view) public function registerAssets($view)
{ {
@@ -156,6 +153,8 @@ class AssetBundle extends Object
/** /**
* Publishes the asset bundle if its source code is not under Web-accessible directory. * Publishes the asset bundle if its source code is not under Web-accessible directory.
* It will also 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 AssetManager $am the asset manager to perform the asset publishing * @param AssetManager $am the asset manager to perform the asset publishing
* @throws InvalidConfigException if [[baseUrl]] or [[basePath]] is not set when the bundle * @throws InvalidConfigException if [[baseUrl]] or [[basePath]] is not set when the bundle
* contains internal CSS or JS files. * contains internal CSS or JS files.