サードパーティのコードを扱う

  1. Yii の中でサードパーティのライブラリを使う
  2. サードパーティのシステムで Yii を使う
  3. Yii 2 を Yii 1 とともに使う

時々、Yii アプリケーションの中でサードパーティのコードを使用する必要があることがあります。 あるいは、サードパーティのシステムの中で Yii をライブラリとして使用したいこともあるでしょう。このセクションでは、こういう目的をどうやって達成するかを説明します。

Yii の中でサードパーティのライブラリを使う

Yii アプリケーションの中でサードパーティのライブラリを使うために主として必要なことは、 そのライブラリのクラスが適切にインクルードされること、または、オートロード可能であることを保証することです。

Composer パッケージを使う

多くのサードパーティ・ライブラリは Composer パッケージの形式でリリースされています。 そのようなライブラリは、次の二つの簡単なステップを踏むことによって、インストールすることが出来ます。

  1. アプリケーションの composer.json ファイルを修正して、どの Composer パッケージをインストールしたいかを指定する。
  2. composer install を実行して、指定したパッケージをインストールする。

インストールされた Composer パッケージ内のクラスは、Composer のオートローダを使ってオートロードすることが出来ます。 アプリケーションの エントリ・スクリプト に、 Composer のオートローダをインストールするための下記の行があることを確認してください。

// Composer のオートローダをインストール
require __DIR__ . '/../vendor/autoload.php';

// Yii クラス・ファイルをインクルード
require __DIR__ . '/../vendor/yiisoft/yii2/Yii.php';

ダウンロードしたライブラリを使う

ライブラリが Composer パッケージとしてリリースされていない場合は、そのライブラリのインストールの指示に従ってインストールしなければなりません。 たいていの場合は、リリース・ファイルを手動でダウンロードし、BasePath/vendor ディレクトリの下に解凍する必要があります。 ここで BasePath は、アプリケーションの base path を表すものです。

ライブラリがそれ自身のオートローダを持っている場合は、それをアプリケーションの エントリ・スクリプト でインストールすることが出来ます。 複数のオートローダ・クラスの中で Yii のクラス・オートローダが優先されるように、 ライブラリのオートローダは Yii.php ファイルをインクルードする前にインストールすることを推奨します。

ライブラリがクラスオートローダを提供していない場合でも、クラスの命名規約が PSR-4 に従っている場合は、ライブラリのクラスをオートロードするのに Yii のクラス・オートローダを使うことが出来ます。 必要なことは、ライブラリのクラスによって使われている全てのルート名前空間に対して ルート・エイリアス を宣言することだけです。 例えば、ライブラリを vendor/foo/bar ディレクトリの下にインストールしたとしましょう。 そしてライブラリのクラスは xyz ルート名前空間の下にあるとします。 この場合、アプリケーションの構成情報において、次のコードを含めれば良いのです。

[
    'aliases' => [
        '@xyz' => '@vendor/foo/bar',
    ],
]

上記のどちらにも当てはまらない場合、おそらくそのライブラリは、クラス・ファイルを探して適切にインクルードするために、PHP の include path 設定に依存しているのでしょう。 この場合は、PHP include path の設定に関するライブラリの指示に従うしかありません。

最悪の場合として、ライブラリが全てのクラス・ファイルを明示的にインクルードすることを要求している場合は、 次の方法を使ってクラスを必要に応じてインクルードすることが出来るようになります。

  • ライブラリに含まれるクラスを特定する。
  • アプリケーションの エントリ・スクリプト において、 クラスと対応するファイル・パスを Yii::$classMap としてリストアップする。例えば、
    Yii::$classMap['Class1'] = 'path/to/Class1.php';
Yii::$classMap['Class2'] = 'path/to/Class2.php';

サードパーティのシステムで Yii を使う

Yii は数多くの優れた機能を提供していますので、サードパーティのシステム (例えば、WordPress、Joomla、または、他の PHP フレームワークを使って開発されるアプリケーション) を開発したり機能拡張したりするのをサポートするために Yii の機能のいくつかを使用したいことがあるでしょう。 例えば、yii\helpers\ArrayHelper クラスや アクティブ・レコード をサードパーティのシステムで使いたいことがあるでしょう。 この目的を達するためには、主として、二つのステップを踏む必要があります。 すなわち、Yii のインストールと、Yii のブートストラップです。

サードパーティのシステムが Composer を使って依存を管理している場合は、 単に下記のコマンドを実行すれば Yii をインストールすることが出来ます。

composer require yiisoft/yii2

データベース抽象レイヤなど、アセットに関係しない Yii の機能だけを使用したい場合は、 Bower および NPM のパッケージのインストールを阻止する特別な composer パッケージが必要になります。 詳細については cebe/assetfree-yii2 を参照して下さい。

Composer に関する更なる情報や、インストールの過程で出現しうる問題に対する解決方法については、 一般的な Composer によるインストール のセクションを参照してください。

そうでない場合は、Yii のリリースを ダウンロード して、 BasePath/vendor ディレクトリに解凍してください。

次に、サードパーティのシステムのエントリ・スクリプトを修正します。次のコードをエントリ・スクリプトの先頭に追加してください。

require __DIR__ . '/../vendor/yiisoft/yii2/Yii.php';

$yiiConfig = require __DIR__ . '/../config/yii/web.php';
new yii\web\Application($yiiConfig); // ここで run() を呼ばない

ごらんのように、上記のコードは典型的な Yii アプリケーションの エントリ・スクリプト と非常に良く似ています。 唯一の違いは、アプリケーションのインスタンスが作成された後に run() メソッドが呼ばれない、という点です。 run() を呼ぶと Yii がリクエスト処理のワークフローを制御するようになりますが、 この場合はリクエストを処理する別のアプリケーションが既に存在していますので、これは必要ではないからです。

Yii アプリケーションでの場合と同じように、サードパーティ・システムが走っている環境に基づいて Yii のアプリケーション・インスタンスを構成する必要があります。 例えば、アクティブ・レコード の機能を使うためには、サードパーティ・システムによって使用されている DB 接続の設定を使って db アプリケーション・コンポーネント を構成しなければなりません。

これで、Yii によって提供されているほとんどの機能を使うことが出来ます。 例えば、アクティブ・レコード・クラスを作成して、それを使ってデータベースを扱うことが出来ます。

Yii 2 を Yii 1 とともに使う

あなたが Yii 1 を前から使っている場合は、たぶん、稼働中の Yii 1 アプリケーションを持っているでしょう。 アプリケーション全体を Yii 2 で書き直す代りに、Yii 2 でのみ利用できる機能を使ってアプリケーションを機能拡張したいこともあるでしょう。 このことは、以下に述べるようにして、実現できます。

Note: Yii 2 は PHP 5.4 以上を必要とします。 あなたのサーバと既存のアプリケーションが PHP 5.4 以上をサポートしていることを確認しなければなりません。

最初に、直前の項 で述べられている指示に従って、Yii 2 を既存のアプリケーションにインストールします。

次に、アプリケーションのエントリ・スクリプトを以下のように修正します。

// カスタマイズされた Yii クラスをインクルード (下記で説明)
require __DIR__ . '/../components/Yii.php';

// Yii 2 アプリケーションの構成
$yii2Config = require __DIR__ . '/../config/yii2/web.php';
new yii\web\Application($yii2Config); // ここで run() を呼ばない。yii2 app はサービス・ロケータとしてのみ使用される。

// Yii 1 アプリケーションの構成
$yii1Config = require __DIR__ . '/../config/yii1/main.php';
Yii::createWebApplication($yii1Config)->run();

Yii 1 と Yii 2 の両者が Yii クラスを持っているため、二つを結合するカスタム・バージョンを作成する必要があります。 上記のコードでカスタマイズされた Yii クラス・ファイルをインクルードしていますが、これは下記のようにして作成することが出来ます。

$yii2path = '/path/to/yii2';
require $yii2path . '/BaseYii.php'; // Yii 2.x

$yii1path = '/path/to/yii1';
require $yii1path . '/YiiBase.php'; // Yii 1.x

class Yii extends \yii\BaseYii
{
    // YiiBase (1.x) のコードをここにコピー・ペースト
}

spl_autoload_unregister(array('YiiBase','autoload'));
spl_autoload_register(array('Yii','autoload'));

Yii::$classMap = include($yii2path . '/classes.php');
// Yii 2 オートローダを Yii 1 によって登録
Yii::registerAutoloader(['yii\BaseYii', 'autoload']);
// 依存注入コンテナを作成
Yii::$container = new yii\di\Container;

以上です。 これで、あなたのコードのどの部分においても、Yii::$app を使って Yii 2 アプリケーション・インスタンスにアクセスすることが出来、Yii::app() によって Yii 1 アプリケーション・インスタンスを取得することが出来ます。

echo get_class(Yii::app()); // 'CWebApplication' を出力
echo get_class(Yii::$app);  // 'yii\web\Application' を出力