File: ini.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (345 lines) | stat: -rw-r--r-- 10,494 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<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 configuration options</title>
   <tgroup cols="4">
    <thead>
     <row>
      <entry>Name</entry>
      <entry>Default</entry>
      <entry>Changeable</entry>
      <entry>Changelog</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry><link linkend="ini.mbstring.language">mbstring.language</link></entry>
      <entry>"neutral"</entry>
      <entry>PHP_INI_PERDIR</entry>
      <entry>Available since PHP 4.3.0.</entry>
     </row>
     <row>
      <entry><link linkend="ini.mbstring.detect-order">mbstring.detect_order</link></entry>
      <entry>NULL</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Available since PHP 4.0.6.</entry>
     </row>
     <row>
      <entry><link linkend="ini.mbstring.http-input">mbstring.http_input</link></entry>
      <entry>"pass"</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Available since PHP 4.0.6.</entry>
     </row>
     <row>
      <entry><link linkend="ini.mbstring.http-output">mbstring.http_output</link></entry>
      <entry>"pass"</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Available since PHP 4.0.6.</entry>
     </row>
     <row>
      <entry><link linkend="ini.mbstring.internal-encoding">mbstring.internal_encoding</link></entry>
      <entry>NULL</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Available since PHP 4.0.6.</entry>
     </row>
     <row>
      <entry>mbstring.script_encoding</entry>
      <entry>NULL</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Available since PHP 4.3.0.</entry>
     </row>
     <row>
      <entry><link linkend="ini.mbstring.substitute-character">mbstring.substitute_character</link></entry>
      <entry>NULL</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Available since PHP 4.0.6.</entry>
     </row>
     <row>
      <entry><link linkend="ini.mbstring.func-overload">mbstring.func_overload</link></entry>
      <entry>"0"</entry>
      <entry>PHP_INI_SYSTEM</entry>
      <entry>
       PHP_INI_SYSTEM in PHP &lt;= 4.2.3; PHP_INI_SYSTEM | PHP_INI_PERDIR from PHP 4.3
       through 5.2.6. Available since PHP 4.2.0.
      </entry>
     </row>
     <row>
      <entry><link linkend="ini.mbstring.encoding-translation">mbstring.encoding_translation</link></entry>
      <entry>"0"</entry>
      <entry>PHP_INI_PERDIR</entry>
      <entry>Available since PHP 4.3.0.</entry>
     </row>
     <row>
      <entry><link linkend="ini.mbstring.strict-detection">mbstring.strict_detection</link></entry>
      <entry>"0"</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Available since PHP 5.1.2.</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>
      The default national language setting (NLS) used in mbstring. Note that this option
      automagically defines <literal>mbstring.internal_encoding</literal> and
      <literal>mbstring.internal_encoding</literal> should be placed
      after <literal>mbstring.language</literal> in &php.ini;
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.encoding-translation">
    <term>
     <parameter>mbstring.encoding_translation</parameter>
     <type>boolean</type>
    </term>
    <listitem>
     <para>
      Enables the transparent character encoding filter for the incoming HTTP queries,
      which performs detection and conversion of the input encoding to the
      internal character encoding. 
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.internal-encoding">
    <term>
     <parameter>mbstring.internal_encoding</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      Defines the default internal character encoding.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.http-input">
    <term>
     <parameter>mbstring.http_input</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      Defines the default HTTP input character encoding.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.http-output">
    <term>
     <parameter>mbstring.http_output</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      Defines the default HTTP output character encoding.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.detect-order">
    <term>
     <parameter>mbstring.detect_order</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      Defines default character code detection order. See also
      <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>
      Defines character to substitute for invalid character encoding.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.func-overload">
    <term>
     <parameter>mbstring.func_overload</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      Overloads a set of single byte functions by the mbstring counterparts. See
      <link linkend="mbstring.overload">Function overloading</link> for more
      information.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.mbstring.strict-detection">
    <term>
     <parameter>mbstring.strict_detection</parameter>
     <type>boolean</type>
    </term>
    <listitem>
     <para>
      Enables the strict encoding detection.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </para>

 <para>
  According to the <link xlink:href="&url.spec.html401.accept-charset;">HTML 4.01 specification</link>,
  Web browsers are allowed to encode a form being submitted with a character
  encoding different from the one used for the page.
  See <function>mb_http_input</function> to detect character encoding
  used by browsers.
 </para>
 <para>
  Although popular browsers are capable of giving a reasonably accurate guess
  to the character encoding of a given HTML document, it would be better to
  set the <literal>charset</literal> parameter in the
  <literal>Content-Type</literal> HTTP header to the appropriate value by
  <function>header</function> or
  <link linkend="ini.sect.data-handling">default_charset</link> ini setting.
 </para>
 <para>
  <example>
  <title>&php.ini; setting examples</title>
   <programlisting>
<![CDATA[
; Set default language
mbstring.language        = Neutral; Set default language to Neutral(UTF-8) (default)
mbstring.language        = English; Set default language to English 
mbstring.language        = Japanese; Set default language to Japanese

;; Set default internal encoding
;; Note: Make sure to use character encoding works with PHP
mbstring.internal_encoding    = UTF-8  ; Set internal encoding to UTF-8

;; HTTP input encoding translation is enabled.
mbstring.encoding_translation = On

;; Set default HTTP input character encoding
;; Note: Script cannot change http_input setting.
mbstring.http_input           = pass    ; No conversion. 
mbstring.http_input           = auto    ; Set HTTP input to auto
                                ; "auto" is expanded to "ASCII,JIS,UTF-8,EUC-JP,SJIS"
mbstring.http_input           = SJIS    ; Set HTTP2 input to  SJIS
mbstring.http_input           = UTF-8,SJIS,EUC-JP ; Specify order

;; Set default HTTP output character encoding 
mbstring.http_output          = pass    ; No conversion
mbstring.http_output          = UTF-8   ; Set HTTP output encoding to UTF-8

;; Set default character encoding detection order
mbstring.detect_order         = auto    ; Set detect order to auto
mbstring.detect_order         = ASCII,JIS,UTF-8,SJIS,EUC-JP ; Specify order

;; Set default substitute character
mbstring.substitute_character = 12307   ; Specify Unicode value
mbstring.substitute_character = none    ; Do not print character
mbstring.substitute_character = long    ; Long Example: U+3000,JIS+7E7E
]]>
   </programlisting>
  </example>
 </para>
 <para>
  <example>
   <title>&php.ini; setting for <literal>EUC-JP</literal> users</title>
   <programlisting>
<![CDATA[
;; Disable Output Buffering
output_buffering      = Off

;; Set HTTP header charset
default_charset       = EUC-JP    

;; Set default language to Japanese
mbstring.language = Japanese

;; HTTP input encoding translation is enabled.
mbstring.encoding_translation = On

;; Set HTTP input encoding conversion to auto
mbstring.http_input   = auto 

;; Convert HTTP output to EUC-JP
mbstring.http_output  = EUC-JP    

;; Set internal encoding to EUC-JP
mbstring.internal_encoding = EUC-JP    

;; Do not print invalid characters
mbstring.substitute_character = none   
]]>
   </programlisting>
  </example>
 </para>
 <para>
  <example>
   <title>&php.ini; setting for <literal>SJIS</literal> users</title>
   <programlisting>
<![CDATA[
;; Enable Output Buffering
output_buffering     = On

;; Set mb_output_handler to enable output conversion
output_handler       = mb_output_handler

;; Set HTTP header charset
default_charset      = Shift_JIS

;; Set default language to Japanese
mbstring.language = Japanese

;; Set http input encoding conversion to auto
mbstring.http_input  = auto 

;; Convert to SJIS
mbstring.http_output = SJIS    

;; Set internal encoding to EUC-JP
mbstring.internal_encoding = EUC-JP    

;; Do not print invalid characters
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
-->