From ac1b25395563cf34dd94e12396bb3387d6e62aa6 Mon Sep 17 00:00:00 2001 From: Nobuo Kihara Date: Sun, 26 Oct 2014 23:04:40 +0900 Subject: [PATCH] docs/guide-ja/structure-entry-scripts.md added --- docs/guide-ja/structure-entry-scripts.md | 119 +++++++++++++++++++++++ docs/guide-ja/structure-overview.md | 2 +- 2 files changed, 120 insertions(+), 1 deletion(-) create mode 100644 docs/guide-ja/structure-entry-scripts.md diff --git a/docs/guide-ja/structure-entry-scripts.md b/docs/guide-ja/structure-entry-scripts.md new file mode 100644 index 0000000000..21afbe2347 --- /dev/null +++ b/docs/guide-ja/structure-entry-scripts.md @@ -0,0 +1,119 @@ +エントリスクリプト +================== + +エントリスクリプトは、アプリケーションのブートストラップ過程のチェーンにおける最初の環です。 +アプリケーションは (ウェブアプリケーションであれ、コンソールアプリケーションであれ)単一のエントリスクリプトを持ちます。 +エンドユーザはエントリスクリプトに対してリクエストを発行し、エントリスクリプトはアプリケーションのインスタンスを作成して、 +それにリクエストを送付します。 + +ウェブアプリケーションのエントリスクリプトは、エンドユーザからアクセス出来るように、 +ウェブからのアクセスが可能なディレクトリの下に保管されなければなりません。 +大抵は `index.php` と名付けられますが、ウェブサーバが見つけることが出来る限り、どのような名前を使っても構いません。 + +コンソールアプリケーションのエントリスクリプトは、通常は、アプリケーションの [ベースパス](structure-applications.md) の +下に保管され、`yii` と名付けられます (`.php` の拡張子を伴います) 。 +これは、ユーザが `./yii [引数] [オプション]` というコマンドによってコンソールアプリケーションを走らせることが出来るようにするためのスクリプトであり、実行可能なパーミッションを与えられるべきものです。 + +エントリスクリプトは主として次の仕事をします: + +* グローバルな定数を定義する; +* [Composer のオートローダ](http://getcomposer.org/doc/01-basic-usage.md#autoloading) を登録する; +* [[Yii]] クラスファイルをインクルードする; +* アプリケーション設定を読み出す; +* [アプリケーション](structure-applications.md) のインスタンスを生成して構成する; +* [[yii\base\Application::run()]] を呼んで、受け取ったリクエストを処理する。 + + +## ウェブアプリケーション + +次に示すのが、[ベーシックウェブアプリケーションテンプレート](start-installation.md) のエントリスクリプトです: + +```php +run(); +``` + + +## コンソールアプリケーション + +同様に、下記がコンソールアプリケーションのエントリスクリプトです:le application: + +```php +#!/usr/bin/env php +run(); +exit($exitCode); +``` + + +## 定数を定義する + +グローバルな定数を定義するには、エントリスクリプトが最善の場所です。 +Yii は下記の三つの定数をサポートしています: + +* `YII_DEBUG`: アプリケーションがデバッグモードで走るかどうかを規定します。 + デバッグモードにおいては、アプリケーションはより多くのログ情報を保持し、 + 例外が投げられたときに、より詳細なエラーのコールスタックを表示します。 + この理由により、デバッグモードは主として開発時に使用されるべきものとなります。 + `YII_DEBUG` の既定値は false です。 +* `YII_ENV`: どういう環境でアプリケーションが走るかを規定します。 + 詳細については、[設定](concept-configurations.md#environment-constants) の節で説明されます。 + `YII_ENV` の既定値は `'prod'` です。これはアプリケーションが実運用環境で走ることを意味します。 +* `YII_ENABLE_ERROR_HANDLER`: Yii によって提供されるエラーハンドラを有効にするかどうかを規定します。 + この定数の既定値は true です。 + +定数を定義するときには、しばしば次のようなコードを用います: + +```php +defined('YII_DEBUG') or define('YII_DEBUG', true); +``` + +これは下記のコードと同じ意味のものです: + +```php +if (!defined('YII_DEBUG')) { + define('YII_DEBUG', true); +} +``` + +明らかに前者の方が簡潔で理解しやすいでしょう。 + +PHP ファイルがインクルードされる時に定数の効力が生じるようにするために、定数の定義はエントリスクリプトの冒頭でなされるべきです。 diff --git a/docs/guide-ja/structure-overview.md b/docs/guide-ja/structure-overview.md index 62b81ea98d..ae3ac0194f 100644 --- a/docs/guide-ja/structure-overview.md +++ b/docs/guide-ja/structure-overview.md @@ -15,7 +15,7 @@ MVC 以外にも、Yii のアプリケーションは下記の要素を持って * [アプリケーションコンポーネント](structure-application-components.md): アプリケーションと共に登録されたオブジェクトであり、リクエストに応えるための様々なサービスを提供します。 * [モジュール](structure-modules.md): それ自身に完全な MVC を含む自己完結的なパッケージです。 アプリケーションは複数のモジュールとして組織することが出来ます。 -* [フィルター](structure-filters.md): コントローラが各リクエストを実際に処理する前後に呼び出される必要があるコードを表現します。 +* [フィルター](structure-filters.md): 各リクエストが実際に処理される前と後に、コントローラから呼び出される必要があるコードを表現します。 * [ウィジェット](structure-widgets.md): [ビュー](structure-views.md) に埋め込むことが出来るオブジェクトです。コントローラのロジックを含むことが可能で、異なるビューで再利用することが出来ます。 下の図がアプリケーションの静的な構造を示すものです: