PHP の Yii フレームワークに付属するフロントエンド リソース パッケージの使用に関する分析

不言
リリース: 2023-04-01 13:42:01
オリジナル
1107 人が閲覧しました

この記事では、主に PHP の Yii フレームワークでのフロントエンド リソース パッケージの使用方法を紹介し、Yii で一般的に使用される JavaScript および CSS リソースをいくつかリストします。必要な方は、次の

Yii のリソースを参照してください。 Web ページに関連するファイルは、CSS ファイル、JavaScript ファイル、写真、ビデオなどです。リソースは Web にアクセスできるディレクトリに配置され、Web サーバーによって直接呼び出されます。

たとえば、ページ内で yii\jui\DatePicker ウィジェットを使用すると、必要な CSS ファイルと JavaScript ファイルが自動的に組み込まれ、それらを見つける必要がなくなります。このチュートリアルでは、Yii が提供する強力なリソース管理機能について詳しく説明します。

リソース パッケージ

Yii はリソースをリソース パッケージで管理します。リソース パッケージは、リソースがビュー パッケージに登録されると、単にリソースの集合になります。パッケージ内の CSS ファイルと JavaScript ファイルは、Web ページのレンダリング時に組み込まれます。

リソース パッケージの定義

リソース パッケージは、yii\web\AssetBundle を継承する PHP クラスとして指定されます。パッケージ名は、自動的に生成される PHP クラス名です。リソース パッケージ クラスでは、リソースの場所、リソースに含まれる CSS ファイルと JavaScript ファイル、および他のパッケージへの依存関係を指定する必要があります。

次のコードは、基本的なアプリケーション テンプレートで使用されるメイン リソース パッケージを定義します。

<?php

namespace app\assets;

use yii\web\AssetBundle;

class AppAsset extends AssetBundle
{
 public $basePath = &#39;@webroot&#39;;
 public $baseUrl = &#39;@web&#39;;
 public $css = [
  &#39;css/site.css&#39;,
 ];
 public $js = [
 ];
 public $depends = [
  &#39;yii\web\YiiAsset&#39;,
  &#39;yii\bootstrap\BootstrapAsset&#39;,
 ];
}
ログイン後にコピー

上記と同様、AppAsset によって指定されるリソース ファイル対応する URL は @web です。リソース バンドルには CSS ファイル css/site.css が含まれています。他の 2 つのパッケージ yii\web\Yii\ には依存しません。 bootstrap\BootstrapAsset yii\web\AssetBundle のプロパティについて 詳細は以下で説明します:

  • yii\web\AssetBundle::sourcePath: リソース ファイルを含むバンドルのルート ディレクトリを指定します。 Web からルート ディレクトリにアクセスできない場合は、このプロパティを設定する必要があります。それ以外の場合は、yii\web\AssetBundle::basePath プロパティと yii\web\AssetBundle::baseUrl を設定する必要があります。ここではパス エイリアスを使用できます。

  • yii\web\AssetBundle::basePath: 指定するときに、リソース バンドル内のリソース ファイルが含まれ、Web からアクセスできるディレクトリを指定します。 yii\web\AssetBundle ::sourcePath 属性を使用すると、リソース マネージャーはパッケージのリソースを Web アクセス可能なディレクトリに公開し、この属性をオーバーライドします。リソース ファイルが Web アクセス可能なディレクトリにある場合は、この属性を設定する必要があります。再度公開する必要はありません。ここではパスのエイリアスを使用できます。

yii\web\AssetBundle::baseUrl: yii\web\AssetBundle::basePath と同様に、yii\web\AssetBundle::basePath ディレクトリに対応する URL を指定します。 yii\web\AssetBundle::sourcePath プロパティを指定すると、アセット マネージャーはこれらのリソースを公開し、このプロパティをオーバーライドします。ここでパス エイリアスを使用できます。
yii\web\AssetBundle::js: リソース バンドルの JavaScript ファイルを含む配列。各 JavaScript ファイルは次のいずれかで指定できます。 2 つの形式:

  • 相対パスはローカル JavaScript ファイル (js/main.js など) として表され、ファイルの実際のパスの前に yii\web\AssetManager が付きます。ファイルの実際のパスは、URL のパスの前に yii\web\AssetManager::baseUrl が付いています。

  • 絶対 URL アドレスは、http://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js などの外部 JavaScript ファイルとして表されます。または // ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js.

  • yii\web\AssetBundle::css: を含む JavaScript ファイルリソースバンドル配列。配列形式は yii\web\AssetBundle::js と同じです。

  • yii\web\AssetBundle::depends: このリソース バンドルが依存する他のリソース バンドルのリスト (詳細は次の 2 つのセクションで説明します)。

  • yii\web\AssetBundle::jsOptions: yii\web\View::registerJsFile() を呼び出してバンドル内の各 JavaScript ファイルを登録するときに、このメソッドに渡されるオプションを指定します。

  • yii\web\AssetBundle::cssOptions: yii\web\View::registerCssFile() を呼び出してバンドル内の各 CSS ファイルを登録するときに、このメソッドに渡されるオプションを指定します。

  • yii\web\AssetBundle::publishOptions: yii\web\AssetManager::publish() を呼び出してパッケージ リソース ファイルを Web ディレクトリに公開するときに、このメソッドに渡されるオプションを指定します。 yii\web\AssetBundle::sourcePath 属性が指定されている場合にのみ使用されます。

リソースの場所

リソースは場所に従って分割できます:

ソース リソース: リソース ファイルと PHP ソース コードつまり、これらのソース リソースを Web から使用するには、Web からアクセスできる Web ディレクトリにコピーする必要があり、このプロセスはリソースの公開と呼ばれます。後ほど詳しく紹介します。
リソースの公開: リソース ファイルは、Web 経由で直接アクセスできる Web ディレクトリに配置されます。
外部リソース: リソース ファイルは、Web アプリケーションとは別の Web サーバーに配置されます。 package クラスで、yii\web\AssetBundle::sourcePath 属性を指定すると、相対パスを使用するリソースはすべてソース リソースとみなされます。この属性を指定しない場合は、これらのリソースが公開リソースであることを意味します。 yii\web\ AssetBundle::basePath と yii\web\AssetBundle::baseUrl を指定して Yii に位置を知らせる必要があります)。

推荐将资源文件放到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 = [&#39;condition&#39; => &#39;lte IE9&#39;];
ログイン後にコピー

这会是包中的CSS文件使用以下HTML标签包含进来:

<!--[if lte IE9]>
<link rel="stylesheet" href="path/to/foo.css">
<![endif]-->
ログイン後にコピー

为链接标签包含

public $cssOptions = [&#39;noscript&#39; => true];
ログイン後にコピー

为使JavaScript文件包含在页面head区域(JavaScript文件默认包含在body的结束处)使用以下选项:

public $jsOptions = [&#39;position&#39; => \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文件对应的

人気のチュートリアル
詳細>
最新のダウンロード
詳細>
ウェブエフェクト
公式サイト
サイト素材
フロントエンドテンプレート
私たちについて 免責事項 Sitemap
PHP中国語ウェブサイト:福祉オンライン PHP トレーニング,PHP 学習者の迅速な成長を支援します!