エントリ・スクリプト ¶

エントリ・スクリプトは、アプリケーションのブートストラップの過程における最初のステップです。 アプリケーションは (ウェブ・アプリケーションであれ、コンソール・アプリケーションであれ）単一のエントリ・スクリプトを持ちます。 エンド・ユーザはエントリ・スクリプトに対してリクエストを発行し、エントリ・スクリプトはアプリケーションのインスタンスを作成して、それにリクエストを送付します。

ウェブ・アプリケーションのエントリ・スクリプトは、エンド・ユーザからアクセス出来るように、 ウェブからのアクセスが可能なディレクトリの下に保管されなければなりません。 たいていは index.php と名付けられますが、ウェブ・サーバが見つけることが出来る限り、どのような名前を使っても構いません。

コンソール・アプリケーションのエントリ・スクリプトは、通常は、アプリケーションの ベース・パス の下に保管され、yii と名付けられます (.php の拡張子を伴います) 。 これは、ユーザが ./yii <route> [引数] [オプション] というコマンドによってコンソール・アプリケーションを走らせることが出来るようにするためのスクリプトであり、 実行可能なパーミッションを与えられるべきものです。

エントリ・スクリプトは主として次の仕事をします。

• グローバルな定数を定義する。
• Composer のオートローダ を登録する。
• Yii クラス・ファイルをインクルードする。
• アプリケーションの構成情報を読み出す。
• アプリケーション のインスタンスを生成して構成する。
• yii\base\Application::run() を呼んで、受け取ったリクエストを処理する。

ウェブ・アプリケーション ¶

次に示すのが、ベーシック・ウェブ・プロジェクト・テンプレート のエントリ・スクリプトです。

<?php

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

// Composer のオートローダを登録
require __DIR__ . '/../vendor/autoload.php';

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

// アプリケーションの構成情報を読み出す
$config = require __DIR__ . '/../config/web.php';

// アプリケーションを作成し、構成して、走らせる
(new yii\web\Application($config))->run();

コンソール・アプリケーション ¶

同様に、下記がコンソール・アプリケーションのエントリ・スクリプトです。

#!/usr/bin/env php
<?php
/**
 * Yii console bootstrap file.
 *
 * @link https://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license https://www.yiiframework.com/license/
 */

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

// Composer のオートローダを登録
require __DIR__ . '/vendor/autoload.php';

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

// アプリケーションの構成情報を読み出す
$config = require __DIR__ . '/config/console.php';

$application = new yii\console\Application($config);
$exitCode = $application->run();
exit($exitCode);

定数を定義する ¶

グローバルな定数を定義するには、エントリ・スクリプトが最善の場所です。Yii は下記の三つの定数をサポートしています。

• YII_DEBUG: アプリケーションがデバッグ・モードで走るかどうかを指定します。 デバッグ・モードにおいては、アプリケーションはより多くのログ情報を保持し、例外が投げられたときに、より詳細なエラーのコール・スタックを表示します。 この理由により、デバッグ・モードは主として開発時に使用されるべきものとなります。YII_DEBUG のデフォルト値は false です。
• YII_ENV: どういう環境でアプリケーションが走っているかを指定します。 詳細は、構成情報 のセクションで説明されます。 YII_ENV のデフォルト値は 'prod' であり、アプリケーションが本番環境で走っていることを意味します。
• YII_ENABLE_ERROR_HANDLER: Yii によって提供されるエラー・ハンドラを有効にするかどうかを指定します。 この定数のデフォルト値は true です。

定数を定義するときには、しばしば次のようなコードを用います。

defined('YII_DEBUG') or define('YII_DEBUG', true);

これは下記のコードと同じ意味のものです。

if (!defined('YII_DEBUG')) {
    define('YII_DEBUG', true);
}

明らかに前者の方が簡潔で理解しやすいでしょう。

他のPHP ファイルがインクルードされる時に定数の効力が生じるようにするために、 定数はエントリ・スクリプトの冒頭で定義されなければなりません。