Commit 61b70799 by Qiang Xue

Fixes #6007: added doc about asset bundle name [skip ci]

parent 112ad80d
...@@ -21,9 +21,9 @@ JavaScript files in the bundle in the rendered Web page. ...@@ -21,9 +21,9 @@ JavaScript files in the bundle in the rendered Web page.
## Defining Asset Bundles <a name="defining-asset-bundles"></a> ## Defining Asset Bundles <a name="defining-asset-bundles"></a>
Asset bundles are specified as PHP classes extending from [[yii\web\AssetBundle]]. The name of a bundle is simply Asset bundles are specified as PHP classes extending from [[yii\web\AssetBundle]]. The name of a bundle is simply
its corresponding PHP class name which should be [autoloadable](concept-autoloading.md). In an asset bundle class, its corresponding fully qualified PHP class name (without the leading backslash). An asset bundle class should
you would typically specify where the assets are located, what CSS and JavaScript files the bundle contains, and should be [autoloadable](concept-autoloading.md). It usually specifies where the assets are located, what CSS and
how the bundle depends on other bundles. JavaScript files the bundle contains, and how the bundle depends on other bundles.
The following code defines the main asset bundle used by [the basic application template](start-installation.md): The following code defines the main asset bundle used by [the basic application template](start-installation.md):
......
...@@ -178,7 +178,7 @@ class AssetManager extends Component ...@@ -178,7 +178,7 @@ class AssetManager extends Component
* This method will first look for the bundle in [[bundles]]. If not found, * This method will first look for the bundle in [[bundles]]. If not found,
* it will treat `$name` as the class of the asset bundle and create a new instance of it. * it will treat `$name` as the class of the asset bundle and create a new instance of it.
* *
* @param string $name the class name of the asset bundle * @param string $name the class name of the asset bundle (without the leading backslash)
* @param boolean $publish whether to publish the asset files in the asset bundle before it is returned. * @param boolean $publish whether to publish the asset files in the asset bundle before it is returned.
* If you set this false, you must manually call `AssetBundle::publish()` to publish the asset files. * If you set this false, you must manually call `AssetBundle::publish()` to publish the asset files.
* @return AssetBundle the asset bundle instance * @return AssetBundle the asset bundle instance
......
...@@ -269,7 +269,7 @@ class View extends \yii\base\View ...@@ -269,7 +269,7 @@ class View extends \yii\base\View
/** /**
* Registers the named asset bundle. * Registers the named asset bundle.
* All dependent asset bundles will be registered. * All dependent asset bundles will be registered.
* @param string $name the name of the asset bundle. * @param string $name the class name of the asset bundle (without the leading backslash)
* @param integer|null $position if set, this forces a minimum position for javascript files. * @param integer|null $position if set, this forces a minimum position for javascript files.
* This will adjust depending assets javascript file position or fail if requirement can not be met. * This will adjust depending assets javascript file position or fail if requirement can not be met.
* If this is null, asset bundles position settings will not be changed. * If this is null, asset bundles position settings will not be changed.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment