documentation/manual/ja/module_specs/Zend_Log-Writers-Firebug.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <!-- EN-Revision: 20792 -->
   4 <sect2 id="zend.log.writers.firebug">
   5     <title>Firebug への書き込み</title>
   6     <para>
   7       <classname>Zend_Log_Writer_Firebug</classname> は、ログデータを
   8       <ulink url="http://www.getfirebug.com/">Firebug</ulink>
   9       <ulink url="http://getfirebug.com/logging.html">コンソール</ulink>
  10       に送信します。
  11     </para>
  12     <para>
  13       <inlinegraphic fileref="figures/zend.wildfire.firebug.console.png" format="PNG" scale="100" width="310" />
  14     </para>
  15     <para>
  16       すべてのデータの送信には <classname>Zend_Wildfire_Channel_HttpHeaders</classname>
  17       コンポーネントを使用します。これは <acronym>HTTP</acronym> ヘッダを使用するので、
  18       ページのコンテンツには何も影響を及ぼしません。
  19       この方式なら、<acronym>AJAX</acronym> リクエストのようにクリーンな <acronym>JSON</acronym>
  20       および <acronym>XML</acronym> レスポンスを要求するリクエストのデバッグも行えます。
  21     </para>
  22     <para>
  23       要件:
  24     </para>
  25     <itemizedlist>
  26       <listitem>
  27         <para>
  28           Firefox ブラウザ。バージョン 3 が最適ですがバージョン 2 にも対応しています。
  29         </para>
  30       </listitem>
  31       <listitem>
  32         <para>
  33           Firebug 拡張。
  34           <ulink url="https://addons.mozilla.org/ja/firefox/addon/1843">https://addons.mozilla.org/ja/firefox/addon/1843</ulink>
  35           からダウンロードできます。
  36         </para>
  37       </listitem>
  38       <listitem>
  39         <para>
  40           FirePHP 拡張。
  41           <ulink url="https://addons.mozilla.org/ja/firefox/addon/6149">https://addons.mozilla.org/ja/firefox/addon/6149</ulink>
  42           からダウンロードできます。
  43         </para>
  44       </listitem>
  45     </itemizedlist>
  46
  47     <example id="zend.log.writers.firebug.example.with_front_controller">
  48       <title>Zend_Controller_Front を使ったログ記録</title>
  49
  50       <programlisting language="php"><![CDATA[
  51 // 起動ファイルで、フロントコントローラのディスパッチの前に記述します
  52 $writer = new Zend_Log_Writer_Firebug();
  53 $logger = new Zend_Log($writer);
  54
  55 // モデル、ビューおよびコントローラのファイル内でこれを使用します
  56 $logger->log('This is a log message!', Zend_Log::INFO);
  57 ]]></programlisting>
  58     </example>
  59
  60     <example id="zend.log.writers.firebug.example.without_front_controller">
  61       <title>Zend_Controller_Front を使わないログ記録</title>
  62
  63       <programlisting language="php"><![CDATA[
  64 $writer = new Zend_Log_Writer_Firebug();
  65 $logger = new Zend_Log($writer);
  66
  67 $request = new Zend_Controller_Request_Http();
  68 $response = new Zend_Controller_Response_Http();
  69 $channel = Zend_Wildfire_Channel_HttpHeaders::getInstance();
  70 $channel->setRequest($request);
  71 $channel->setResponse($response);
  72
  73 // 出力バッファリングを開始します
  74 ob_start();
  75
  76 // ロガーをコールします
  77
  78 $logger->log('This is a log message!', Zend_Log::INFO);
  79
  80 // ログデータをブラウザに送ります
  81 $channel->flush();
  82 $response->sendHeaders();
  83 ]]></programlisting>
  84     </example>
  85
  86     <sect3 id="zend.log.writers.firebug.priority-styles">
  87
  88       <title>優先度のスタイルの設定</title>
  89
  90       <para>
  91         組み込みの優先度やユーザ定義の優先度を使うには
  92         <methodname>setPriorityStyle()</methodname> メソッドを使用します。
  93       </para>
  94       <programlisting language="php"><![CDATA[
  95 $logger->addPriority('FOO', 8);
  96 $writer->setPriorityStyle(8, 'TRACE');
  97 $logger->foo('Foo Message');
  98 ]]></programlisting>
  99       <para>
 100         ユーザ定義の優先度用のデフォルトのスタイルを設定するには
 101         <methodname>setDefaultPriorityStyle()</methodname> メソッドを使用します。
 102       </para>
 103       <programlisting language="php"><![CDATA[
 104 $writer->setDefaultPriorityStyle('TRACE');
 105 ]]></programlisting>
 106       <para>
 107         サポートしているスタイルは次のとおりです。
 108         <table id="zend.log.writers.firebug.priority-styles.table">
 109             <title>Firebug Logging Styles</title>
 110             <tgroup cols="2">
 111                 <thead>
 112                     <row>
 113                         <entry>スタイル</entry>
 114                         <entry>説明</entry>
 115                     </row>
 116                 </thead>
 117                 <tbody>
 118                     <row>
 119                         <entry><constant>LOG</constant></entry>
 120                         <entry>通常のログメッセージを表示します</entry>
 121                     </row>
 122                     <row>
 123                         <entry><constant>INFO</constant></entry>
 124                         <entry>情報ログメッセージを表示します</entry>
 125                     </row>
 126                     <row>
 127                         <entry><constant>WARN</constant></entry>
 128                         <entry>警告ログメッセージを表示します</entry>
 129                     </row>
 130                     <row>
 131                         <entry><constant>ERROR</constant></entry>
 132                         <entry>エラーログメッセージを表示し、Firebug のエラーカウントをひとつ増やします</entry>
 133                     </row>
 134                     <row>
 135                         <entry><constant>TRACE</constant></entry>
 136                         <entry>拡張スタックトレースつきのログメッセージを表示します</entry>
 137                     </row>
 138                     <row>
 139                         <entry><constant>EXCEPTION</constant></entry>
 140                         <entry>拡張スタックトレースつきのエラーログメッセージを表示します</entry>
 141                     </row>
 142                     <row>
 143                         <entry><constant>TABLE</constant></entry>
 144                         <entry>拡張テーブルつきのログメッセージを表示します</entry>
 145                     </row>
 146                 </tbody>
 147             </tgroup>
 148         </table>
 149       </para>
 150     </sect3>
 151
 152     <sect3 id="zend.log.writers.firebug.preparing-data">
 153
 154       <title>ログ記録用のデータの準備</title>
 155
 156       <para>
 157         任意の <acronym>PHP</acronym> の変数を組み込みの優先度でログに記録できますが、
 158         特殊なログ形式を使う場合は、何らかの書式変換が必要となります。
 159       </para>
 160       <para>
 161         <constant>LOG</constant>、<constant>INFO</constant>、<constant>WARN</constant>、<constant>ERROR</constant>
 162         そして <constant>TRACE</constant> については特別な書式変換は不要です。
 163       </para>
 164     </sect3>
 165
 166     <sect3 id="zend.log.writers.firebug.preparing-data.exception">
 167
 168       <title>例外のログ記録</title>
 169
 170       <para>
 171         <classname>Zend_Exception</classname> のログを記録するには、
 172         単にその例外オブジェクトをロガーに渡すだけです。
 173         設定している優先度やスタイルにかかわらず、
 174         例外は自動的に例外と判断されます。
 175       </para>
 176       <programlisting language="php"><![CDATA[
 177 $exception = new Zend_Exception('Test exception');
 178 $logger->err($exception);
 179 ]]></programlisting>
 180     </sect3>
 181
 182     <sect3 id="zend.log.writers.firebug.preparing-data.table">
 183
 184       <title>表形式のログ</title>
 185
 186       <para>
 187         ログを表形式で記録できます。カラムは自動検出され、
 188         データの最初の行がヘッダと見なされます。
 189       </para>
 190       <programlisting language="php"><![CDATA[
 191 $writer->setPriorityStyle(8, 'TABLE');
 192 $logger->addPriority('TABLE', 8);
 193
 194 $table = array('Summary line for the table',
 195              array(
 196                  array('Column 1', 'Column 2'),
 197                  array('Row 1 c 1',' Row 1 c 2'),
 198                  array('Row 2 c 1',' Row 2 c 2')
 199              )
 200             );
 201 $logger->table($table);
 202 ]]></programlisting>
 203     </sect3>
 204 </sect2>