Cet article présente principalement l'utilisation de packages de ressources front-end dans le framework Yii de PHP, et répertorie quelques ressources JavaScript et CSS courantes dans Yii. Les amis dans le besoin peuvent s'y référer
Les ressources de Yii. Les fichiers liés aux pages Web peuvent être des fichiers CSS, des fichiers JavaScript, des images ou des vidéos, etc. Les ressources sont placées dans un répertoire accessible au Web et sont directement appelées par le serveur Web.
Il est préférable de gérer automatiquement les ressources via des programmes. Par exemple, lorsque vous utilisez le widget yiijuiDatePicker dans une page, il inclura automatiquement les fichiers CSS et JavaScript requis au lieu de vous obliger à rechercher manuellement ces fichiers et à les inclure. eux. Lorsque vous mettrez à niveau le widget, il utilisera automatiquement la nouvelle version du fichier de ressources. Dans ce tutoriel, nous détaillerons les puissantes fonctions de gestion des ressources fournies par Yii.
Package de ressources
Yii gère les ressources dans des packages de ressources. Les packages de ressources sont simplement une collection de ressources placées dans un répertoire lors de l'enregistrement d'une ressource dans un package de vue. Les fichiers CSS et JavaScript du package seront inclus lors du rendu de la page Web.
Définir le package de ressources
Le package de ressources est spécifié comme une classe PHP qui hérite de yiiwebAssetBundle. Le nom du package est le nom de la classe PHP qui peut être automatiquement chargé dans. la classe du package de ressources, vous devez spécifier l'emplacement de la ressource, les fichiers CSS et JavaScript qu'elle contient et ses dépendances sur d'autres packages.
Le code suivant définit le package de ressources principal utilisé par le modèle d'application de base :
<?php namespace app\assets; use yii\web\AssetBundle; class AppAsset extends AssetBundle { public $basePath = '@webroot'; public $baseUrl = '@web'; public $css = [ 'css/site.css', ]; public $js = [ ]; public $depends = [ 'yii\web\YiiAsset', 'yii\bootstrap\BootstrapAsset', ]; }
Comme ci-dessus, les fichiers de ressources spécifiés par la classe AppAsset sont placées dans le répertoire @webroot Ci-dessous, l'URL correspondante est @web. Le bundle de ressources contient un fichier CSS css/site.css et aucun fichier JavaScript. Cela dépend des deux autres packages yiiwebYiiAsset et yiibootstrapBootstrapAsset. les propriétés de yiiwebAssetBundle sont les suivantes :
yiiwebAssetBundle::sourcePath : Spécifie le répertoire racine du bundle contenant les fichiers de ressources. Cette propriété doit être définie lorsque le répertoire racine n'est pas accessible par le. Web. Sinon, la propriété yiiwebAssetBundle::basePath et yiiwebAssetBundle::baseUrl doivent être définies. Les alias de chemin peuvent être utilisés ici ;
yiiwebAssetBundle::basePath : spécifie le répertoire qui contient les fichiers de ressources dans le bundle de ressources et est accessible sur le Web. Lors de la spécification de l'attribut yiiwebAssetBundle::sourcePath, le gestionnaire de ressources publiera les ressources du package dans un répertoire accessible par le Web et remplacera cet attribut. Si vos fichiers de ressources se trouvent dans un répertoire accessible par le Web, vous devez définir cet attribut afin qu'ils n'aient pas besoin d'être publiés à nouveau. Les alias de chemin peuvent être utilisés ici.
yiiwebAssetBundle::baseUrl : Spécifie l'URL correspondant au répertoire yiiwebAssetBundle::basePath. Semblable à yiiwebAssetBundle::basePath, si vous spécifiez l'attribut yiiwebAssetBundle::sourcePath, le gestionnaire de ressources le fera. publiez ces ressources et remplacez cette propriété, les alias de chemin peuvent être utilisés ici.
yiiwebAssetBundle::js : Un tableau contenant les fichiers JavaScript du bundle de ressources. Notez que la barre oblique "/" doit être utilisée comme séparateur de répertoire. Chaque fichier JavaScript peut être spécifié dans l'un des deux formats suivants :
Le chemin relatif est exprimé sous forme de fichier JavaScript local (tel que js/main.js). Le chemin réel du fichier est précédé de yiiwebAssetManager::basePath. Le fichier est précédé de yiiwebAssetManager ::baseUrl.
L'adresse URL absolue est représentée sous la forme d'un fichier JavaScript externe, tel que http://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min. js ou // ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js.
yiiwebAssetBundle::css : Un tableau contenant les fichiers JavaScript de ce regroupement de ressources. Le format du tableau est le même que celui de yiiwebAssetBundle::js.
yiiwebAssetBundle::depends : Une liste d'autres ensembles de ressources dont dépend cet ensemble de ressources (introduction détaillée dans les deux sections suivantes).
yiiwebAssetBundle::jsOptions : Spécifie les options transmises à cette méthode lors de l'appel de yiiwebView::registerJsFile() pour enregistrer chaque fichier JavaScript dans le bundle.
yiiwebAssetBundle::cssOptions : Spécifie les options transmises à cette méthode lors de l'appel de yiiwebView::registerCssFile() pour enregistrer chaque fichier CSS dans le bundle.
yiiwebAssetBundle::publishOptions : Spécifie les options transmises à cette méthode lors de l'appel de yiiwebAssetManager::publish() pour publier le fichier de ressources du package dans le répertoire Web uniquement lorsque yiiwebAssetBundle::sourcePath est. propriétés spécifiées utilisées.
Emplacement des ressources
Les ressources peuvent être divisées selon leur emplacement :
Ressources sources : fichiers de ressources et code source PHP Ensemble, elles ne sont pas directement accessibles par le Web. Pour utiliser ces ressources sources, elles doivent être copiées dans un répertoire Web accessible par le Web et devenir des ressources publiées. Ce processus est appelé ressources de publication, qui seront. présenté en détail ultérieurement.
Publier les ressources : les fichiers de ressources sont placés dans un répertoire Web accessible directement via le Web ;
Ressources externes : les fichiers de ressources sont placés sur un serveur Web différent pour votre application Web
Lors de la définition d'une ressource ; package class, si vous spécifiez l'attribut yiiwebAssetBundle::sourcePath, cela signifie que toutes les ressources utilisant des chemins relatifs seront traitées comme des ressources source ; si vous ne spécifiez pas cet attribut, cela signifie que ces ressources sont des ressources publiées (vous devez donc spécifier yiiwebAssetBundle ; ::basePath et yiiwebAssetBundle:: baseUrl permet à Yii de connaître leur emplacement).
推荐将资源文件放到Web目录以避免不必要的发布资源过程,这就是之前的例子指定 yii\web\AssetBundle::basePath 而不是 yii\web\AssetBundle::sourcePath.
对于 扩展来说,由于它们的资源和源代码都在不能Web访问的目录下, 在定义资源包类时必须指定yii\web\AssetBundle::sourcePath属性。
注意: yii\web\AssetBundle::sourcePath 属性不要用@webroot/assets,该路径默认为 yii\web\AssetManager资源管理器将源资源发布后存储资源的路径,该路径的所有内容会认为是临时文件, 可能会被删除。
资源依赖
当Web页面包含多个CSS或JavaScript文件时,它们有一定的先后顺序以避免属性覆盖, 例如,Web页面在使用jQuery UI小部件前必须确保jQuery JavaScript文件已经被包含了, 我们称这种资源先后次序称为资源依赖。
资源依赖主要通过yii\web\AssetBundle::depends 属性来指定, 在AppAsset 示例中,资源包依赖其他两个资源包: yii\web\YiiAsset 和 yii\bootstrap\BootstrapAsset 也就是该资源包的CSS和JavaScript文件要在这两个依赖包的文件包含 之后 才包含。
资源依赖关系是可传递,也就是人说A依赖B,B依赖C,那么A也依赖C。
资源选项
可指定yii\web\AssetBundle::cssOptions 和 yii\web\AssetBundle::jsOptions 属性来自定义页面包含CSS和JavaScript文件的方式, 这些属性值会分别传递给 yii\web\View::registerCssFile() 和 yii\web\View::registerJsFile() 方法, 在视图 调用这些方法包含CSS和JavaScript文件时。
注意: 在资源包类中设置的选项会应用到该包中 每个 CSS/JavaScript 文件,如果想对每个文件使用不同的选项, 应创建不同的资源包并在每个包中使用一个选项集。
例如,只想IE9或更高的浏览器包含一个CSS文件,可以使用如下选项:
public $cssOptions = ['condition' => 'lte IE9'];
这会是包中的CSS文件使用以下HTML标签包含进来:
<!--[if lte IE9]> <link rel="stylesheet" href="path/to/foo.css"> <![endif]-->
为链接标签包含
public $cssOptions = ['noscript' => true];
为使JavaScript文件包含在页面head区域(JavaScript文件默认包含在body的结束处)使用以下选项:
public $jsOptions = ['position' => \yii\web\View::POS_HEAD];
Bower 和 NPM 资源
大多数 JavaScript/CSS 包通过Bower 和/或 NPM管理, 如果你的应用或扩展使用这些包,推荐你遵循以下步骤来管理库中的资源:
修改应用或扩展的 composer.json 文件将包列入require 中, 应使用bower-asset/PackageName (Bower包) 或 npm-asset/PackageName (NPM包)来对应库。
创建一个资源包类并将你的应用或扩展要使用的JavaScript/CSS 文件列入到类中, 应设置 yii\web\AssetBundle::sourcePath 属性为@bower/PackageName 或 @npm/PackageName, 因为根据别名Composer会安装Bower或NPM包到对应的目录下。
注意: 一些包会将它们分布式文件放到一个子目录中,对于这种情况,应指定子目录作为 yii\web\AssetBundle::sourcePath属性值,例如,yii\web\JqueryAsset使用 @bower/jquery/dist 而不是 @bower/jquery。
使用资源包
为使用资源包,在视图中调用yii\web\AssetBundle::register()方法先注册资源, 例如,在视图模板可使用如下代码注册资源包:
use app\assets\AppAsset; AppAsset::register($this); // $this 代表视图对象
如果在其他地方注册资源包,应提供视图对象,如在 小部件 类中注册资源包, 可以通过 $this->view 获取视图对象。
当在视图中注册一个资源包时,在背后Yii会注册它所依赖的资源包,如果资源包是放在Web不可访问的目录下,会被发布到可访问的目录, 后续当视图渲染页面时,会生成这些注册包包含的CSS和JavaScript文件对应的 和