archived-doc-ja/reference/errorfunc/ini.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 72a6f3d35e914602703b698a5d8f52732b61ed3e Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<section xml:id="errorfunc.configuration" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 &reftitle.runtime;
 &extension.runtime;
 <para>
  <table>
   <title>エラーおよびロギング設定オプション</title>
   <tgroup cols="3">
    <thead>
     <row>
      <entry>&Name;</entry>
      <entry>&Default;</entry>
      <entry>&Changeable;</entry>
      <entry>&Changelog;</entry>
     </row>
    </thead>
    <tbody>
    <row>
     <entry><link linkend="ini.error-reporting">error_reporting</link></entry>
     <entry>NULL</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.display-errors">display_errors</link></entry>
     <entry>"1"</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.display-startup-errors">display_startup_errors</link></entry>
     <entry>"1"</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry>
       PHP 8.0.0 より前のバージョンでは、デフォルト値は <literal>"0"</literal> でした。
     </entry>
    </row>
    <row>
     <entry><link linkend="ini.log-errors">log_errors</link></entry>
     <entry>"0"</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.log-errors-max-len">log_errors_max_len</link></entry>
     <entry>"1024"</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry>PHP 8.0.0 以降は意味をなさなくなり、PHP 8.1.0 で削除されました。</entry>
    </row>
    <row>
     <entry><link linkend="ini.ignore-repeated-errors">ignore_repeated_errors</link></entry>
     <entry>"0"</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.ignore-repeated-source">ignore_repeated_source</link></entry>
     <entry>"0"</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.report-memleaks">report_memleaks</link></entry>
     <entry>"1"</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.track-errors">track_errors</link></entry>
     <entry>"0"</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry>PHP 7.2.0 以降で非推奨になり、PHP 8.0.0 で削除されました。</entry>
    </row>
    <row>
     <entry><link linkend="ini.html-errors">html_errors</link></entry>
     <entry>"1"</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.xmlrpc-errors">xmlrpc_errors</link></entry>
     <entry>"0"</entry>
     <entry><constant>INI_SYSTEM</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.xmlrpc-error-number">xmlrpc_error_number</link></entry>
     <entry>"0"</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.docref-root">docref_root</link></entry>
     <entry>""</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.docref-ext">docref_ext</link></entry>
     <entry>""</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.error-prepend-string">error_prepend_string</link></entry>
     <entry>NULL</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.error-append-string">error_append_string</link></entry>
     <entry>NULL</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.error-log">error_log</link></entry>
     <entry>NULL</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.error-log-mode">error_log_mode</link></entry>
     <entry>0o644</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry>PHP 8.2.0 以降で有効です。</entry>
    </row>
    <row>
     <entry><link linkend="ini.syslog.facility">syslog.facility</link></entry>
     <entry>"LOG_USER"</entry>
     <entry><constant>INI_SYSTEM</constant></entry>
     <entry>PHP 7.3.0 以降で有効です。</entry>
    </row>
    <row>
     <entry><link linkend="ini.syslog.filter">syslog.filter</link></entry>
     <entry>"no-ctrl"</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry>PHP 7.3.0 以降で有効です。</entry>
    </row>
    <row>
     <entry><link linkend="ini.syslog.ident">syslog.ident</link></entry>
     <entry>"php"</entry>
     <entry><constant>INI_SYSTEM</constant></entry>
     <entry>PHP 7.3.0 以降で有効です。</entry>
    </row>
    </tbody>
   </tgroup>
  </table>
  &ini.php.constants;
 </para>
 <para>
  以下に設定ディレクティブの簡単な説明を示します。
  <variablelist>
   <varlistentry xml:id="ini.error-reporting">
    <term>
     <parameter>error_reporting</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      エラー出力レベルを設定します。パラメータは、あるビットフィールドを表
      す整数か定数名で指定します。このerror_reportingのレベルと定数は、
      <link linkend="errorfunc.constants">定義済の定数</link>および
      &php.ini;に記述されています。 実行時に設定するには、
      <function>error_reporting</function> 関数を指定してください。
      <link linkend="ini.display-errors">display_errors</link> 
      ディレクティブも参照ください。
     </para>
     <para>
      デフォルト値は
      <constant>E_ALL</constant> です。
     </para>
     <para>
      PHP 8.0.0 より前のバージョンでは、
      <constant>E_ALL</constant> &amp;
      ~<constant>E_NOTICE</constant> &amp;
      ~<constant>E_STRICT</constant> &amp;
      ~<constant>E_DEPRECATED</constant> でした。
      これは、<constant>E_NOTICE</constant>、
      <constant>E_STRICT</constant>、
      そして <constant>E_DEPRECATED</constant>
      レベルのエラーが出力されないということです。
     </para>
     <note>
      <title>PHP 定数の、PHP 以外での使用</title>
      <para>
       PHP の定数を、<filename>httpd.conf</filename> など PHP
       の外部で使用しても何の意味もありません。外部で使用する場合には、
       <type>int</type> 型の値を指定しなければなりません。
       また、エラーレベルはこれからも追加されることがあるので、
       最大値 (<constant>E_ALL</constant> に対応する値)
       は変わる可能性があります。そこで、<constant>E_ALL</constant>
       を指定する場面では <literal>2147483647</literal>
       (<constant>E_ALL</constant> だけではなくすべてのエラーを含める)
       のような数を指定するようにしましょう。
       これは現状の全ビットに対応した上で、かつ値が将来追加された場合にも対応できます。
      </para>
     </note>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.display-errors">
    <term>
     <parameter>display_errors</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      エラーをHTML出力の一部として画面に出力するかどうかを定義します。
     </para>
     <para>
      "stderr" を指定すると、エラーの内容を <literal>stdout</literal>
      (標準出力) ではなく <literal>stderr</literal> (標準エラー出力)
      に送ります。
     </para>
     <note>
      <para>
      開発をサポートする仕組みであり、本番のシステムでは
      使用すべきではありません (例えばインターネットに接続されたシステムなど)。
      </para>
     </note>
     <note>
      <para>
       display_errors は実行時にも設定可能（<function>ini_set</function>
       関数を用いて）ですが、スクリプトが致命的（fatal）なエラーを発生した場合は
       その設定は反映されません。なぜなら、要求されたアクションは
       実行されなかったからです。
      </para>
     </note>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.display-startup-errors">
    <term>
     <parameter>display_startup_errors</parameter>
     <type>bool</type>
    </term>
    <listitem>
     <para>
      display_errorsをonにした場合でも、PHPの起動シーケンスにおいて発
      生したエラーは表示されません。デバッグ時を除き、
      display_startup_errorsをoffにしておくことが強く推奨されます。
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.log-errors">
    <term>
     <parameter>log_errors</parameter>
     <type>bool</type>
    </term>
    <listitem>
     <para>
      エラーメッセージを、サーバーのエラーログまたは<link
      linkend="ini.error-log">error_log</link>に記録するかどうかを指定
      します。このオプションはサーバーに依存します。
     </para>
     <note>
      <para>
       実用Webサイトではエラー表示を行う代わりにエラーを記録することを
       強く推奨します。
      </para>
     </note>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.log-errors-max-len">
    <term>
     <parameter>log_errors_max_len</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      log_errorsの最大長をバイト単位で設定します。
      <link linkend="ini.error-log">error_log</link> には、
      この設定で情報が追加されます。デフォルトは 1024 で、0 を指定すると
      最大長の制限は全く適用されなくなります。
      この長さはエラーログへの記録や
      エラーの表示、そして
      <varname>$php_errormsg</varname>
      に適用されます。
      しかし、明示的に呼び出される <function>error_log</function> のような関数には適用されません。
     </para>

     &ini.shorthandbytes;

    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.ignore-repeated-errors">
    <term>
     <parameter>ignore_repeated_errors</parameter>
     <type>bool</type>
    </term>
    <listitem>
     <para>
      繰り返されるメッセージを記録しません。エラーの繰り返しは、
      <link
      linkend="ini.ignore-repeated-source">ignore_repeated_source</link>が
      trueに設定されるまで同じファイルの同じ行で発生します。
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.ignore-repeated-source">
    <term>
     <parameter>ignore_repeated_source</parameter>
     <type>bool</type>
    </term>
    <listitem>
     <para>
      メッセージの繰り返しを無視する場合にメッセージのソースを無視しま
      す。この設定をOnにすると、異なるファイルまたはソース行からの同じ
      エラーメッセージの繰り返しを記録しなくなります。
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.report-memleaks">
    <term>
     <parameter>report_memleaks</parameter>
     <type>bool</type>
    </term>
    <listitem>
     <para>
      このパラメータを On (デフォルト) にすると、Zend メモリマネージャーが検出した
      メモリリークの報告を表示します。この報告は、Posix プラットフォームでは標準エラー出力に送られます。
      Windows では、デバッガに OutputDebugString() を使って送られ、
      <link xlink:href="&url.dbgview;">DbgView</link> のようなツールで見ることができます。
      このパラメータが使えるのはデバッグビルドだけであり、かつ
      error_reporting で <constant>E_WARNING</constant> を有効にしている場合のみです。
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.track-errors">
    <term>
     <parameter>track_errors</parameter>
     <type>bool</type>
    </term>
    <listitem>
     <para>
      有効にした場合、直近のエラーメッセージが、
      <varname>$php_errormsg</varname>
      変数に常に代入されます。
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.html-errors">
    <term>
     <parameter>html_errors</parameter>
     <type>bool</type>
    </term>
    <listitem>
     <para>
      有効にすると、エラーメッセージにHTMLタグが含まれるようになります。
      HTML形式のエラーメッセージでは、ユーザーがエラーまたはエラーを発生した関数を説明するページ
      に導くようクリック可能なメッセージを出力します。これらのリファレ
      ンスは、<link linkend="ini.docref-root">docref_root</link> およ
      び <link linkend="ini.docref-ext">docref_ext</link>の設定に依存
      します。
     </para>
     <para>
      無効にすると、エラーメッセージは単なるプレーンテキストになります。
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.xmlrpc-errors">
    <term>
     <parameter>xmlrpc_errors</parameter>
     <type>bool</type>
    </term>
    <listitem>
     <para>
      有効にすると、通常のエラー報告を無効にして XML-RPC 形式のエラーメッセージとします。
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.xmlrpc-error-number">
    <term>
     <parameter>xmlrpc_error_number</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      XML-RPC の faultCode 要素の値として使用します。
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.docref-root">
    <term>
     <parameter>docref_root</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      新しいエラーフォーマットはエラーやエラーの原因となった関数に関するマニュアル
      のページの情報を含んでいます。マニュアルのページによっては母国語でダウンロードが
      可能であり、このiniディレクティブをマニュアルのローカルコピーのURLにセット
      することができます。
      マニュアルのローカルコピーが <literal>"/manual/"</literal> でアクセスできるとすると、単に
      <userinput>docref_root=/manual/</userinput>とするだけです。
      ローカルコピーのファイルの拡張子は<userinput>docref_ext=.html</userinput>
      で指定できます。拡張リファレンスを使用することもできます。例えば
      <userinput>docref_root=http://manual/en/</userinput>または
      <userinput>docref_root="http://landonize.it/?how=url&amp;theme=classic&amp;filter=Landon&amp;url=http%3A%2F%2Fwww.php.net%2F"</userinput>が使用できます。
     </para>
     <para>
      ほとんどの場合 docref_root の値の最後を <literal>"/"</literal> にしようと思うでしょう。
      しかし上の二つ目の例を見ではその必要はありません。
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.docref-ext">
    <term>
     <parameter>docref_ext</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      <link linkend="ini.docref-root">docref_root</link>を参照して下さ
      い。
     </para>
     <note>
      <para>
       docref_extの値はドット <literal>"."</literal> で始まる必要があります。
      </para>
     </note>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.error-prepend-string">
    <term>
     <parameter>error_prepend_string</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      エラーメッセージの前に出力する文字列。
      エラーメッセージを画面に表示する時にだけ使います。
      主な目的は、
      エラーメッセージの先頭に追加のHTMLマークアップを付加できるようにすることです。
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.error-append-string">
    <term>
     <parameter>error_append_string</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      エラーメッセージの後に出力する文字列。
      エラーメッセージを画面に表示する時にだけ使います。
      主な目的は、
      エラーメッセージに追加のHTMLマークアップを付加できるようにすることです。
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.error-log">
    <term>
     <parameter>error_log</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      スクリプトエラーが記録されるファイル名です。
      ファイルはウェブサーバーユーザーで書き込めなければなりません。
      <literal>syslog</literal> が指定されると、エラーはファイルではなく
      システムロガーに送られます。これは Unix では syslog(3) であり
      Windows ではイベントログのことです。
      <function>syslog</function> も参照ください。
      このディレクティブが設定されていない場合、エラーは SAPI
      エラーロガーに送信されます。これは、例えば Apache のエラーログ、
      あるいは CLI なら <literal>stderr</literal> になります。
      <function>error_log</function> も参照ください。
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.error-log-mode">
    <term>
     <parameter>error_log_mode</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      <link linkend="ini.error-log">error_log</link> で設定されたファイルのモード(パーミッション)。
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.syslog.facility">
    <term>
     <parameter>syslog.facility</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      どの種類のプログラムがメッセージを記録するのかを指定します。
      <link linkend="ini.error-log">error_log</link> が "syslog" の場合にだけ有効です。
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.syslog.filter">
    <term>
     <parameter>syslog.filter</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      記録されたメッセージをフィルタリングするフィルターの種類を指定します。
      フィルターで許可された文字はそのまま記録されますが、許可されていない文字は
      <literal>\x</literal> で始まる十六進表記に変換して記録されます。
      <itemizedlist>
       <listitem>
        <simpara><literal>all</literal> –
        ロギングされる文字列は改行文字で分割され、すべての文字は変更せずに渡されます。</simpara>
       </listitem>
       <listitem>
        <simpara><literal>ascii</literal> –
        ロギングされる文字列は改行文字で分割され、
        印刷可能な 7bit ASCII 文字以外の文字は全てエスケープされます。</simpara>
       </listitem>
       <listitem>
        <simpara><literal>no-ctrl</literal> –
        ロギングされる文字列は改行文字で分割され、
        印刷可能な文字以外は全てエスケープされます。</simpara>
       </listitem>
       <listitem>
        <simpara><literal>raw</literal> –
        全ての文字はシステムロガーに変更せずに渡されます。
        改行文字で分割されることもありません(PHP 7.3 より前の振る舞いと同等です)
        </simpara>
       </listitem>
      </itemizedlist>
      この設定は、<link linkend="ini.error-log">error_log</link> を "syslog" に設定し、
      <function>syslog</function> をコールした場合にのみ影響します。
     </para>
     <note>
      <para>
       <literal>raw</literal> フィルタタイプは、PHP 7.3.8 および PHP 7.4.0 以降で使えます。
      </para>
     </note>
     <simpara>
      このディレクティブは、Windows ではサポートされていません。
     </simpara>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.syslog.ident">
    <term>
     <parameter>syslog.ident</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      すべての文字列の先頭に追加する識別用文字列を指定します。
      <link linkend="ini.error-log">error_log</link> が "syslog" の場合にだけ有効です。
     </para>
    </listitem>
   </varlistentry>

  </variablelist>
 </para>
</section>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->