ini.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: af844f698b38d1460464bf913a80f2397980c534 Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa,mumumu -->
<section xml:id="mbstring.configuration" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 &reftitle.runtime;
 &extension.runtime;
 <para>
 <table>
  <title>mbstring 設定オプション</title>
  <tgroup cols="4">
   <thead>
    <row>
      <entry>&Name;</entry>
      <entry>&Default;</entry>
      <entry>&Changeable;</entry>
      <entry>&Changelog;</entry>
    </row>
   </thead>
   <tbody xml:id="mbstring.configuration.list">
    <row>
      <entry><link linkend="ini.mbstring.language">mbstring.language</link></entry>
     <entry>"neutral"</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
      <entry><link linkend="ini.mbstring.detect-order">mbstring.detect_order</link></entry>
     <entry>NULL</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
      <entry><link linkend="ini.mbstring.http-input">mbstring.http_input</link></entry>
     <entry>"pass"</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry>非推奨になりました。</entry>
    </row>
    <row>
      <entry><link linkend="ini.mbstring.http-output">mbstring.http_output</link></entry>
     <entry>"pass"</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry>非推奨になりました。</entry>
    </row>
    <row>
      <entry><link linkend="ini.mbstring.internal-encoding">mbstring.internal_encoding</link></entry>
     <entry>NULL</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry>非推奨になりました。</entry>
    </row>
    <row>
      <entry><link linkend="ini.mbstring.substitute-character">mbstring.substitute_character</link></entry>
     <entry>NULL</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
      <entry><link linkend="ini.mbstring.func-overload">mbstring.func_overload</link></entry>
     <entry>"0"</entry>
     <entry><constant>INI_SYSTEM</constant></entry>
     <entry>
       PHP 7.2.0 で非推奨になり、PHP 8.0.0 で削除されました。
     </entry>
    </row>
    <row>
      <entry><link linkend="ini.mbstring.encoding-translation">mbstring.encoding_translation</link></entry>
     <entry>"0"</entry>
     <entry><constant>INI_PERDIR</constant></entry>
     <entry></entry>
    </row>
      <row>
      <entry><link linkend="ini.mbstring.http-output-conv-mimetypes">mbstring.http_output_conv_mimetypes</link></entry>
      <entry>"^(text/|application/xhtml\+xml)"</entry>
      <entry><constant>INI_ALL</constant></entry>
      <entry></entry>
     </row>
    <row>
      <entry><link linkend="ini.mbstring.strict-detection">mbstring.strict_detection</link></entry>
     <entry>"0"</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
     <row>
      <entry><link linkend="ini.mbstring.regex-retry-limit">mbstring.regex_retry_limit</link></entry>
      <entry>"1000000"</entry>
      <entry><constant>INI_ALL</constant></entry>
      <entry>PHP 7.4.0 以降で利用可能です。</entry>
     </row>
     <row>
      <entry><link linkend="ini.mbstring.regex-stack-limit">mbstring.regex_stack_limit</link></entry>
      <entry>"100000"</entry>
      <entry><constant>INI_ALL</constant></entry>
      <entry>PHP 7.3.5 以降で利用可能です。</entry>
     </row>
   </tbody>
  </tgroup>
 </table>
  &ini.php.constants;
 </para>

 &ini.descriptions.title;

 <para>
  <variablelist>
   <varlistentry xml:id="ini.mbstring.language">
    <term>
     <parameter>mbstring.language</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      mbstring で使用される言語設定(NLS)のデフォルト値。
      この設定は <literal>mbstring.internal_encoding</literal> を定義するため、
      &php.ini; の中で <literal>mbstring.internal_encoding</literal> は、
      <literal>mbstring.language</literal> の後に置く必要があることに注意してください。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.encoding-translation">
    <term>
     <parameter>mbstring.encoding_translation</parameter>
     <type>bool</type>
    </term>
    <listitem>
     <para>
      入力される HTTP クエリに関して、
      文字エンコーディング検出および内部文字エンコーディングへの変換を行う
      透過的な文字エンコーディングフィルタを有効にします。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.internal-encoding">
    <term>
     <parameter>mbstring.internal_encoding</parameter>
     <type>string</type>
    </term>
    <listitem>
     <warning>
      <para>&removed.php.future;</para>
     </warning>
     <para>
      内部文字エンコーディングのデフォルト値を定義します。
     </para>
     <para>
      この値は空のままにしておいて、代わりに
      <link linkend="ini.default-charset"><parameter>default_charset</parameter></link>
      を設定すべきです。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.http-input">
    <term>
     <parameter>mbstring.http_input</parameter>
     <type>string</type>
    </term>
    <listitem>
     <warning>
      <para>&removed.php.future;</para>
     </warning>
     <para>
      HTTP 入力文字エンコーディングのデフォルト値を定義します。
     </para>
     <para>
      この値は空のままにしておいて、代わりに
      <link linkend="ini.default-charset"><parameter>default_charset</parameter></link>
      を設定すべきです。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.http-output">
    <term>
     <parameter>mbstring.http_output</parameter>
     <type>string</type>
    </term>
    <listitem>
     <warning>
      <para>&removed.php.future;</para>
     </warning>
     <para>
      HTTP 出力文字エンコーディングのデフォルト値を定義します
      (出力は、内部エンコーディングから HTTP 出力エンコーディングに変換された上で出力されます)。
     </para>
     <para>
      この値は空のままにしておいて、代わりに
      <link linkend="ini.default-charset"><parameter>default_charset</parameter></link>
      を設定すべきです。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.detect-order">
    <term>
     <parameter>mbstring.detect_order</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      文字コード検出のデフォルト値を定義します。
      <function>mb_detect_order</function>も参照ください。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.substitute-character">
    <term>
     <parameter>mbstring.substitute_character</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      無効な文字を代替する文字を定義します。
      サポートされる値は、<function>mb_substitute_character</function> を参照ください。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.func-overload">
    <term>
     <parameter>mbstring.func_overload</parameter>
     <type>string</type>
    </term>
    <listitem>
     &warn.deprecated.feature-7-2-0.removed-8-0-0;
     <para>
      シングルバイト対応の関数を mbstring 関数の対応する関数でオーバーロード
      (置換)します。詳細は、
      <link linkend="mbstring.overload">関数のオーバーロード</link>
      を参照ください。
     </para>
     <para>
      この設定は、&php.ini; でしか変更できません。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.http-output-conv-mimetypes">
    <term>
     <parameter>mbstring.http_output_conv_mimetypes</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.strict-detection">
    <term>
     <parameter>mbstring.strict_detection</parameter>
     <type>bool</type>
    </term>
    <listitem>
     <para>
      厳密なエンコーディング検出を有効にします。
      詳しい説明と例は、<function>mb_detect_encoding</function> を参照ください。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.regex-retry-limit">
    <term>
     <parameter>mbstring.regex_retry_limit</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      mbregex のマッチングの間に行われる、バックトラッキングの量を制限します。
     </para>
     <para>
      この設定は、oniguruma >= 6.8.0 と PHP をリンクした場合にのみ利用可能です。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.regex-stack-limit">
    <term>
     <parameter>mbstring.regex_stack_limit</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      mbstring の正規表現エンジンの、スタックの深さを制限します。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </para>

 <para>
  <link xlink:href="&url.spec.html401.accept-charset;">HTML 4.01 の仕様</link>
  によると、Web ブラウザは、
  フォームのデータを投稿する際にページで使用される文字エンコーディングと
  異なるエンコーディングを使用することができます。
  ブラウザで使用される文字エンコーディングを検出するには、
  <function>mb_http_input</function>
  を参照ください。
 </para>
 <para>
  一般的に使用されるブラウザでは、
  指定したHTML文書の文字エンコーディングをかなり正確に推定することができますが、
  <function>header</function> または設定パラメータ
  <link linkend="ini.sect.data-handling">default_charset</link> により、
  <literal>Content-Type</literal> HTTP ヘッダで <literal>charset</literal>
  を設定する方がより良いでしょう。
 </para>
 <para>
  <example>
  <title>&php.ini; 設定の例</title>
   <programlisting>
<![CDATA[
; デフォルトの言語を設定
mbstring.language        = neutral; デフォルト言語を中立(UTF-8)に設定 (デフォルト)
mbstring.language        = English; デフォルト言語を英語に設定
mbstring.language        = Japanese; デフォルト言語を日本語に設定

;; デフォルトの内部エンコーディングを設定
;; 注意: PHPで動作する文字エンコーディングを使用すること
mbstring.internal_encoding    = UTF-8  ; 内部エンコーディングを UTF-8 に設定

;; HTTP入力エンコーディング変換を有効にする
mbstring.encoding_translation = On

;; デフォルトのHTTP入力文字エンコーディングを設定
;; 注意: スクリプトではhttp_inputの設定は変更できません。
mbstring.http_input           = pass    ; 変換しない。
mbstring.http_input           = auto    ; HTTP 入力を auto に設定
                                ; "auto" は mbstring.language の設定を使って展開されます
mbstring.http_input           = SJIS    ; HTTP入力をSJISに設定
mbstring.http_input           = UTF-8,SJIS,EUC-JP ; 順番を指定

;; デフォルトのHTTP出力文字エンコーディングを設定
mbstring.http_output          = pass    ; 変換しない
mbstring.http_output          = UTF-8   ; HTTP出力エンコーディングを
                                        ;  UTF-8 に指定

;; デフォルトの文字エンコーディング検出順序を設定
mbstring.detect_order         = auto    ; デフォルトの順番を auto に設定
mbstring.detect_order         = ASCII,JIS,UTF-8,SJIS,EUC-JP ; 順番を指定

;; 代替文字のデフォルト値を設定
mbstring.substitute_character = 12307   ; Unicode 値を指定
mbstring.substitute_character = none    ; 文字を出力しない
mbstring.substitute_character = long    ; long の例: U+3000,JIS+7E7E
]]>
   </programlisting>
  </example>
 </para>
 <para>
  <example>
   <title><literal>EUC-JP</literal> ユーザー用の &php.ini; の設定</title>
   <programlisting>
<![CDATA[
;; 出力バッファリングを無効にする
output_buffering      = Off

;; HTTP charsetヘッダを設定
default_charset       = EUC-JP    

;; デフォルトの言語を日本語にする
mbstring.language = Japanese

;; HTTP 入力変換を有効にする
mbstring.encoding_translation = On

;; HTTP 入力エンコーディング変換を auto に設定
mbstring.http_input   = auto 

;; HTTP 出力を EUC-JP に設定
mbstring.http_output  = EUC-JP    

;; 内部エンコーディングを EUC-JP に設定
mbstring.internal_encoding = EUC-JP    

;; 無効な文字を出力しない
mbstring.substitute_character = none
]]>
   </programlisting>
  </example>
 </para>
 <para>
  <example>
   <title><literal>SJIS</literal> ユーザー用の &php.ini;の 設定</title>
   <programlisting>
<![CDATA[
;; 出力のバッファリングを有効に
output_buffering     = On

;; 出力の変換を有効にするために mb_output_handler を設定
output_handler       = mb_output_handler

;; HTTPヘッダ charset を設定
default_charset      = Shift_JIS

;; デフォルトの言語を日本語に設定
mbstring.language = Japanese

;; HTTP 入力変換を有効にする
mbstring.encoding_translation = On

;; HTTP 入力エンコーディング変換を auto に設定
mbstring.http_input  = auto 

;; SJIS に変換
mbstring.http_output = SJIS    

;; 内部エンコーディングを EUC-JP に設定
mbstring.internal_encoding = EUC-JP    

;; 無効な文字を出力しない
mbstring.substitute_character = none

]]>
   </programlisting>
  </example>
 </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
-->