How do I manage assets in Yii2?

Question

For example, I created a new page, and I'd like to use, for example, backbone.js, custom css file and some collection of images. Where should I declare all this stuff in Yii2? I found the AppAsset.php module, but this is only for css/js files and I haven't noticed any changes when my css/js files and path were declared there:

class AppAsset extends AssetBundle {
    public $basePath = '@webroot';
    public $baseUrl = '@web';
    public $css = [
        'css/site.css',
        'js/jquery.mobile-1.4.2.min.css',
    ];
    public $js = [
        'js/jsquery-2.1.0.min.js',
        'js/jquery.mobile-1.4.2.min.js',
        'js/script.js',
    ];

    public $depends = [
        'yii\web\YiiAsset',
        'yii\bootstrap\BootstrapAsset',
    ];
}

What am I doing wrong?

`...and I haven't noticed any changes when my css/js files and path were declared there` well did you register the bundle? — Cthulhu, Sep 05 '14 at 13:28
Yes, in target .php module i write: use frontend\assets\AppAsset; AppAsset::register($this); and nothing changes. — Павел Иванов, Sep 05 '14 at 13:51
Well, the structure of my project is following (approximately): assets are existing in several incarnations: @root/frontend/web/assets/[there are hash code like 4cd64e87]/[css, fonts, js]/ ; @root/frontend/web/css ; @root/frontend/web/js ; and I'm trying to figure out where to place my files. I placed my jquery and script.js files into web/js directory, but it had no much effect on view, where these files are registered and after reloading my page is still without styling, like it has no links to css file. — Павел Иванов, Sep 06 '14 at 11:07

Ivo Renkema · Accepted Answer · 2014-12-03T15:28:23.280

It took me a while to figure it out, but below is the relevant part of the Yii2 source code

if ($this->sourcePath !== null && !isset($this->basePath, $this->baseUrl)) {
    list ($this->basePath, $this->baseUrl) = $am->publish($this->sourcePath, $this->publishOptions);
}

So Yii2 will publish assets only if $sourcePath is set, and $basePath and $baseUrl are not set(!). The latter tripped me up, and it looks like the same goes for you.

So I have this AppAsset, which duly publishes

use yii\web\AssetBundle;


class AppAsset extends AssetBundle
{
public $sourcePath = '@app/assets/app';

public $css = [
    'css/openbook.css',
    'fontello/css/fontello.css',
    'fontello/css/animation.css'
];
public $js = [
    'js/plug.openbook.js',
    'js/plug.interpret.js',
    'js/plug.drop.message.js'
];
public $depends = [
   // 'yii\web\YiiAsset', 
   // 'yii\bootstrap\BootstrapAsset',
];
}

Of course, I have in the main layout

use frontend\assets\AppAsset;
...
AppAsset::register($this);

I would add this answer into "Golden recommendations for Yii2"! — abr_stackoverflow, Jun 12 '16 at 18:35
Well, your conclusion that Yii2 publishes assets only when `sourcePath` is set isn't correct. `sourcePath` is required when the assets aren't inside a web accessible folder. However if the assets are inside a web accessible folder then you don't need to set `sourcePath`, instead you need to set `basePath` and `baseUrl`. — yetanotherse, Jul 15 '16 at 10:11

score 4 · Answer 2 · answered Nov 06 '14 at 04:57

4

to use this AppAsset or any other you should register it in the view

use app\assets\AppAsset;
AppAsset::register($this);

answered Nov 06 '14 at 04:57

Herokiller

2,891
5
32
50

Correcter · Answer 3 · 2018-01-21T09:26:38.040

0

At first, you should create SomeAsset class in your app/assets/ folder with your new js and css files. You can extend your AppAsset overloading its properties.

Next use this in SomeController

use Yii;
use app\assets\SomeAsset;

and in actionSome like this:

SomeAsset::register(Yii::$app->view);

edited Jan 21 '18 at 09:26

answered Jan 21 '18 at 09:20

Correcter

3,466
1
16
14

Please post the `SomeAsset` file too. – Ilyas karim Mar 26 '18 at 15:23

score -4 · Answer 4 · edited Jan 29 '15 at 18:23

-4

From personal experience, assets are one of the parts of Yii that I found extremely frustrating.

It is hard to reliably find out where the file is going to be and the switching back and forth with debug mode on and off will create further frustration.

I suggest scrapping the asset handling and just keep all your JS files in a folder, then it can be included like this:

Yii::app()->clientScript->registerScriptFile('/js/jquery.jeditable.mini.js');

edited Jan 29 '15 at 18:23

felipe.zkn

2,012
7
31
63

answered Sep 05 '14 at 23:05

Keith Grey

151
7

1

I am sorry, but your script seems to be referring to Yii 1.1 assets. Assets are handled much differently (as Bundles, which can state other required assets) in Yii2. – Snivs Jul 08 '15 at 17:05

How do I manage assets in Yii2?

4 Answers4

Linked