構成情報

  1. 構成情報の形式
  2. 構成情報を使用する
  3. 構成情報ファイル
  4. デフォルト設定
  5. 環境定数

新しいオブジェクトを作成したり、既存のオブジェクトを初期化するとき、Yii では構成情報が広く使用されています。 構成情報は通常、作成されるオブジェクトのクラス名、およびオブジェクトの プロパティ に割り当てられる初期値のリストを含みます。 構成情報は、オブジェクトの イベント にアタッチされるハンドラのリストや、オブジェクトにアタッチされる ビヘイビア のリストを含むこともできます。

以下では、データベース接続を作成して初期化するために、構成情報が使用されています:

$config = [
    'class' => 'yii\db\Connection',
    'dsn' => 'mysql:host=127.0.0.1;dbname=demo',
    'username' => 'root',
    'password' => '',
    'charset' => 'utf8',
];

$db = Yii::createObject($config);

Yii::createObject() メソッドは引数に構成情報の配列を受け取り、構成情報で名前指定されたクラスをインスタンス化してオブジェクトを作成します。 オブジェクトがインスタンス化されるとき、構成情報の残りの部分を使って、 オブジェクトのプロパティ、イベント・ハンドラ、およびビヘイビアが初期化されます。

すでにオブジェクトがある場合は、構成情報配列でオブジェクトのプロパティを初期化するのに Yii::configure() を使用することができます:

Yii::configure($object, $config);

なお、この場合には、構成情報配列に class 要素を含んではいけません。

構成情報の形式

構成情報の形式は、フォーマルには次のように説明できます:

[
    'class' => 'ClassName',
    'propertyName' => 'propertyValue',
    'on eventName' => $eventHandler,
    'as behaviorName' => $behaviorConfig,
]

ここで

  • class 要素は、作成されるオブジェクトの完全修飾クラス名を指定します。
  • propertyName 要素は、名前で指定されたプロパティの初期値を指定します。 キーはプロパティ名で、値はそれに対応する初期値です。 パブリック・メンバ変数と getter/setter によって定義されている プロパティ のみを設定することができます。
  • on eventName 要素は、どのようなハンドラがオブジェクトの イベント にアタッチされるかを指定します。 配列のキーが on に続けてイベント名という書式になることに注意してください。サポートされているイベント・ハンドラの形式については、 イベント のセクションを参照してください。
  • as behaviorName 要素は、どのような ビヘイビア がオブジェクトにアタッチされるかを指定します。 配列のキーが as に続けてビヘイビア名という書式になり、$behaviorConfig で示される値が、ここで説明する一般的な構成情報のような、 ビヘイビアを作成するための構成情報になることに注意してください。

下記は、初期プロパティ値、イベント・ハンドラ、およびビヘイビアでの構成を示した例です:

[
    'class' => 'app\components\SearchEngine',
    'apiKey' => 'xxxxxxxx',
    'on search' => function ($event) {
        Yii::info("Keyword searched: " . $event->keyword);
    },
    'as indexer' => [
        'class' => 'app\components\IndexerBehavior',
        // ... プロパティ初期値 ...
    ],
]

構成情報を使用する

構成情報は Yii の多くの場所で使用されています。このセクションの冒頭では、 Yii::createObject() を使って、構成情報に応じてオブジェクトを作成する方法を示しました。この項では、 アプリケーションの構成とウィジェットの構成という、二つの主要な構成情報の用途を説明します。

アプリケーションの構成

アプリケーション の構成情報は、おそらく Yii の中で最も複雑な配列のひとつです。 それは アプリケーション クラスが、設定可能なプロパティとイベントを数多く持つためです。 さらに重要なことは、その yii\web\Application::components プロパティが、アプリケーションに登録されている コンポーネントの生成用の構成情報配列を受け取ることができることです。以下は、 ベーシック・プロジェクト・テンプレート のアプリケーション構成ファイルの概要です。

$config = [
    'id' => 'basic',
    'basePath' => dirname(__DIR__),
    'extensions' => require __DIR__ . '/../vendor/yiisoft/extensions.php',
    'components' => [
        'cache' => [
            'class' => 'yii\caching\FileCache',
        ],
        'mailer' => [
            'class' => 'yii\swiftmailer\Mailer',
        ],
        'log' => [
            'class' => 'yii\log\Dispatcher',
            'traceLevel' => YII_DEBUG ? 3 : 0,
            'targets' => [
                [
                    'class' => 'yii\log\FileTarget',
                ],
            ],
        ],
        'db' => [
            'class' => 'yii\db\Connection',
            'dsn' => 'mysql:host=localhost;dbname=stay2',
            'username' => 'root',
            'password' => '',
            'charset' => 'utf8',
        ],
    ],
];

この構成情報には、 class キーがありません。それは、エントリ・スクリプト で以下のように、 クラス名が既に与えられて使用されているためです。

(new yii\web\Application($config))->run();

アプリケーションの components プロパティ構成の詳細については、 アプリケーション のセクションと サービス・ロケータ のセクションにあります。

バージョン 2.0.11 以降では、アプリケーション構成で container プロパティを使って 依存注入コンテナ を構成することがサポートされています。例えば、

$config = [
    'id' => 'basic',
    'basePath' => dirname(__DIR__),
    'extensions' => require __DIR__ . '/../vendor/yiisoft/extensions.php',
    'container' => [
        'definitions' => [
            'yii\widgets\LinkPager' => ['maxButtonCount' => 5]
        ],
        'singletons' => [
            // 依存注入コンテナのシングルトンの構成
        ]
    ]
];

definitions と singletons の構成情報配列に使用できる値とその実例についてさらに知るためには、 依存注入コンテナ の記事の 高度な実際の使用方法 のセクションを読んでください。

ウィジェットの構成

ウィジェット を使用するときは、多くの場合、ウィジェットのプロパティをカスタマイズするために、構成情報を使用する必要があります。 yii\base\Widget::widget() と yii\base\Widget::begin() の両メソッドを使って、ウィジェットを作成できます。 それらは、以下のような構成情報配列を取ります。

use yii\widgets\Menu;

echo Menu::widget([
    'activateItems' => false,
    'items' => [
        ['label' => 'ホーム', 'url' => ['site/index']],
        ['label' => '製品', 'url' => ['product/index']],
        ['label' => 'ログイン', 'url' => ['site/login'], 'visible' => Yii::$app->user->isGuest],
    ],
]);

上記のコードは、 Menu ウィジェットを作成し、その activateItems プロパティが false になるよう初期化します。 items プロパティも、表示されるメニュー項目で構成されます。

クラス名がすでに与えられているので、構成情報配列が class キーを持つべきではないことに注意してください。

構成情報ファイル

構成情報がとても複雑になる場合、一般的な方法は、 構成情報ファイル と呼ばれる、ひとつまたは複数の PHP ファイルにそれを格納することです。 構成情報ファイルは、構成情報を表す PHP 配列を返します。 たとえば、次のように、 web.php と名づけたファイルにアプリケーションの構成情報を保持することができます。

return [
    'id' => 'basic',
    'basePath' => dirname(__DIR__),
    'extensions' => require __DIR__ . '/../vendor/yiisoft/extensions.php',
    'components' => require __DIR__ . '/components.php',
];

components の構成情報もまた複雑になるため、上記のように、 components.php と呼ぶ別のファイルにそれを格納し web.php でそのファイルを "require" しています。 この components.php の内容は、次のようになっています。

return [
    'cache' => [
        'class' => 'yii\caching\FileCache',
    ],
    'mailer' => [
        'class' => 'yii\swiftmailer\Mailer',
    ],
    'log' => [
        'class' => 'yii\log\Dispatcher',
        'traceLevel' => YII_DEBUG ? 3 : 0,
        'targets' => [
            [
                'class' => 'yii\log\FileTarget',
            ],
        ],
    ],
    'db' => [
        'class' => 'yii\db\Connection',
        'dsn' => 'mysql:host=localhost;dbname=stay2',
        'username' => 'root',
        'password' => '',
        'charset' => 'utf8',
    ],
];

構成情報ファイルに格納されている構成情報を取得するには、以下のように、それを "require" するだけです:

$config = require 'path/to/web.php';
(new yii\web\Application($config))->run();

デフォルト設定

Yii::createObject() メソッドは、 依存性注入コンテナ をベースに実装されています。 そのため、指定されたクラスが Yii::createObject() を使用して作成されるとき、そのすべてのインスタンスに適用される、 いわゆる デフォルト設定 のセットを指定することができます。デフォルト設定は、 ブートストラップ 段階のコード内で Yii::$container->set() を呼び出すことで指定することができます。

たとえばあなたが、すべてのリンク・ページャが最大で5つのページ・ボタン (デフォルト値は10) を伴って表示されるよう yii\widgets\LinkPager をカスタマイズしたいとき、その目標を達成するには次のコードを使用することができます。

\Yii::$container->set('yii\widgets\LinkPager', [
    'maxButtonCount' => 5,
]);

デフォルト設定を使用しなければ、あなたは、リンク・ページャを使うすべての箇所で maxButtonCount を設定しなければなりません。

環境定数

構成情報は、多くの場合、アプリケーションが実行される環境に応じて変化します。たとえば、 開発環境では mydb_dev という名前のデータベースを使用し、本番サーバ上では mydb_prod データベースを 使用したいかもしれません。環境の切り替えを容易にするために、Yii は、あなたのアプリケーションの エントリ・スクリプト で定義可能な YII_ENV という名前の定数を提供します。 たとえば:

defined('YII_ENV') or define('YII_ENV', 'dev');

YII_ENV を次のいずれかの値と定義することができます:

  • prod: 本番環境。定数 YII_ENV_PROD が true と評価されます。 とくに定義しない場合、これが YII_ENV のデフォルト値です。
  • dev: 開発環境。定数 YII_ENV_DEV が true と評価されます。
  • test: テスト環境。定数 YII_ENV_TEST が true と評価されます。

これらの環境定数を使用すると、現在の環境に基づいて条件付きで構成情報を指定することもできます。 たとえば、アプリケーション構成情報には、開発環境での デバッグ・ツールバーとデバッガ を有効にするために、次のコードを含むことができます。

$config = [...];

if (YII_ENV_DEV) {
    // 'dev' 環境用に構成情報を調整
    $config['bootstrap'][] = 'debug';
    $config['modules']['debug'] = 'yii\debug\Module';
}

return $config;