installation.md

インストール

Composer パッケージを取得する

このエクステンションをインストールするのに推奨される方法は composer によるものです。

下記のコマンドを実行してください。

php composer.phar require --prefer-dist yiisoft/yii2-debug

または、あなたの composer.json ファイルの require セクションに、下記を追加してください。

"yiisoft/yii2-debug": "~2.0.0"

アプリケーションを構成する

エクステンションを有効にするためには、構成情報ファイルに以下の行を追加してデバッグ・モジュールを有効にします。

'bootstrap' => ['debug'],
'modules' => [
    'debug' => 'yii\debug\Module',
]

デフォルトでは、デバッグ・モジュールはウェブサイトをローカル・ホストから閲覧した場合にだけ動作します。 これをリモート・サーバ (ステージング・サーバ) で使いたい場合は、パラメータ allowedIPs を構成情報に追加して、あなたの IP をホワイトリストに加えてください。

'bootstrap' => ['debug'],
'modules' => [
    'debug' => [
        'class' => 'yii\debug\Module',
        'allowedIPs' => ['1.2.3.4', '127.0.0.1', '::1']
    ]
]

URL マネージャで enableStrictParsing オプションを使っている場合は、rules に次の行を追加してください。

'urlManager' => [
    'enableStrictParsing' => true,
    'rules' => [
        // ...
        'debug/<controller>/<action>' => 'debug/<controller>/<action>',
    ],
],

Note|注意: デバッガは各リクエストに関する情報を @runtime/debug ディレクトリに保存します。 デバッガを使用するのに問題が生じたとき、例えば、デバッガを使おうとするとおかしなエラー・メッセージが出たり、ツールバーが表示されなかったり、リクエストの情報が何も表示されなかったりしたときは、ウェブサーバがこのディレクトリとその中に置かれるファイルに対して十分なアクセス権限を持っているかどうかを確認してください。

ロギングとプロファイリングのための追加の構成

ロギングとプロファイリングは、フレームワークとアプリケーションの両方の実行フローを理解するのを助けてくれる、単純ながら強力なツールです。これらのツールは、開発環境でも本番環境でも役に立ちます。

本番環境では、ロギング のガイドの節で説明されているように、著しく重要なメッセージを手動でログに取るだけにとどめるべきです。 本番環境で全てのメッセージをログに取り続けるのは、パフォーマンスへの損害が大きすぎます。

開発環境では、ログは多く取れば取るほど良いでしょう。とりわけ、実行トレースの記録は有用です。

フレームワークのフードの下で何が起っているかを理解する手助けとなるトレース・メッセージを見るためには、構成情報ファイルでトレース・レベルを設定する必要があります。

return [
    // ...
    'components' => [
        'log' => [
            'traceLevel' => YII_DEBUG ? 3 : 0, // <-- ここ

デフォルトでは、Yii がデバッグ・モードで走っている場合のトレース・レベルは自動的に 3 に設定されます。 デバッグ・モードは index.php ファイルに次の行が存在することによって決定されます。

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

Note|注意: デバッグ・モードはパフォーマンスに著しい悪影響を及ぼし得ますので、本番環境では必ずデバッグ・モードを無効にしてください。 更に、デバッグ・モードは公開すべきでない情報をエンド・ユーザに曝露することがあり得ます。