reference/errorfunc/ini.xml
d4d5216e7a965ca194f6b1c9dee84cecab2674e5
...
...
@@ -19,121 +19,129 @@
19
19
<row>
20
20
<entry><link linkend="ini.error-reporting">error_reporting</link></entry>
21
21
<entry>NULL</entry>
22
-
<entry>PHP_INI_ALL</entry>
22
+
<entry><constant>INI_ALL</constant></entry>
23
23
<entry></entry>
24
24
</row>
25
25
<row>
26
26
<entry><link linkend="ini.display-errors">display_errors</link></entry>
27
27
<entry>"1"</entry>
28
-
<entry>PHP_INI_ALL</entry>
28
+
<entry><constant>INI_ALL</constant></entry>
29
29
<entry></entry>
30
30
</row>
31
31
<row>
32
32
<entry><link linkend="ini.display-startup-errors">display_startup_errors</link></entry>
33
-
<entry>"0"</entry>
34
-
<entry>PHP_INI_ALL</entry>
35
-
<entry></entry>
33
+
<entry>"1"</entry>
34
+
<entry><constant>INI_ALL</constant></entry>
35
+
<entry>
36
+
Prior to PHP 8.0.0, the default value was <literal>"0"</literal>.
37
+
</entry>
36
38
</row>
37
39
<row>
38
40
<entry><link linkend="ini.log-errors">log_errors</link></entry>
39
41
<entry>"0"</entry>
40
-
<entry>PHP_INI_ALL</entry>
42
+
<entry><constant>INI_ALL</constant></entry>
41
43
<entry></entry>
42
44
</row>
43
45
<row>
44
46
<entry><link linkend="ini.log-errors-max-len">log_errors_max_len</link></entry>
45
47
<entry>"1024"</entry>
46
-
<entry>PHP_INI_ALL</entry>
47
-
<entry>Available since PHP 4.3.0.</entry>
48
+
<entry><constant>INI_ALL</constant></entry>
49
+
<entry>Had no effect as of PHP 8.0.0, removed as of PHP 8.1.0.</entry>
48
50
</row>
49
51
<row>
50
52
<entry><link linkend="ini.ignore-repeated-errors">ignore_repeated_errors</link></entry>
51
53
<entry>"0"</entry>
52
-
<entry>PHP_INI_ALL</entry>
53
-
<entry>Available since PHP 4.3.0.</entry>
54
+
<entry><constant>INI_ALL</constant></entry>
55
+
<entry></entry>
54
56
</row>
55
57
<row>
56
58
<entry><link linkend="ini.ignore-repeated-source">ignore_repeated_source</link></entry>
57
59
<entry>"0"</entry>
58
-
<entry>PHP_INI_ALL</entry>
59
-
<entry>Available since PHP 4.3.0.</entry>
60
+
<entry><constant>INI_ALL</constant></entry>
61
+
<entry></entry>
60
62
</row>
61
63
<row>
62
64
<entry><link linkend="ini.report-memleaks">report_memleaks</link></entry>
63
65
<entry>"1"</entry>
64
-
<entry>PHP_INI_ALL</entry>
65
-
<entry>Available since PHP 4.3.0.</entry>
66
+
<entry><constant>INI_ALL</constant></entry>
67
+
<entry></entry>
66
68
</row>
67
69
<row>
68
70
<entry><link linkend="ini.track-errors">track_errors</link></entry>
69
71
<entry>"0"</entry>
70
-
<entry>PHP_INI_ALL</entry>
71
-
<entry></entry>
72
+
<entry><constant>INI_ALL</constant></entry>
73
+
<entry>Deprecated as of PHP 7.2.0, removed as of PHP 8.0.0.</entry>
72
74
</row>
73
75
<row>
74
76
<entry><link linkend="ini.html-errors">html_errors</link></entry>
75
77
<entry>"1"</entry>
76
-
<entry>PHP_INI_ALL</entry>
77
-
<entry>PHP_INI_SYSTEM in PHP &lt;= 4.2.3.</entry>
78
+
<entry><constant>INI_ALL</constant></entry>
79
+
<entry></entry>
78
80
</row>
79
81
<row>
80
82
<entry><link linkend="ini.xmlrpc-errors">xmlrpc_errors</link></entry>
81
83
<entry>"0"</entry>
82
-
<entry>PHP_INI_SYSTEM</entry>
83
-
<entry>Available since PHP 4.1.0.</entry>
84
+
<entry><constant>INI_SYSTEM</constant></entry>
85
+
<entry></entry>
84
86
</row>
85
87
<row>
86
88
<entry><link linkend="ini.xmlrpc-error-number">xmlrpc_error_number</link></entry>
87
89
<entry>"0"</entry>
88
-
<entry>PHP_INI_ALL</entry>
89
-
<entry>Available since PHP 4.1.0.</entry>
90
+
<entry><constant>INI_ALL</constant></entry>
91
+
<entry></entry>
90
92
</row>
91
93
<row>
92
94
<entry><link linkend="ini.docref-root">docref_root</link></entry>
93
95
<entry>""</entry>
94
-
<entry>PHP_INI_ALL</entry>
95
-
<entry>Available since PHP 4.3.0.</entry>
96
+
<entry><constant>INI_ALL</constant></entry>
97
+
<entry></entry>
96
98
</row>
97
99
<row>
98
100
<entry><link linkend="ini.docref-ext">docref_ext</link></entry>
99
101
<entry>""</entry>
100
-
<entry>PHP_INI_ALL</entry>
101
-
<entry>Available since PHP 4.3.2.</entry>
102
+
<entry><constant>INI_ALL</constant></entry>
103
+
<entry></entry>
102
104
</row>
103
105
<row>
104
106
<entry><link linkend="ini.error-prepend-string">error_prepend_string</link></entry>
105
107
<entry>NULL</entry>
106
-
<entry>PHP_INI_ALL</entry>
108
+
<entry><constant>INI_ALL</constant></entry>
107
109
<entry></entry>
108
110
</row>
109
111
<row>
110
112
<entry><link linkend="ini.error-append-string">error_append_string</link></entry>
111
113
<entry>NULL</entry>
112
-
<entry>PHP_INI_ALL</entry>
114
+
<entry><constant>INI_ALL</constant></entry>
113
115
<entry></entry>
114
116
</row>
115
117
<row>
116
118
<entry><link linkend="ini.error-log">error_log</link></entry>
117
119
<entry>NULL</entry>
118
-
<entry>PHP_INI_ALL</entry>
120
+
<entry><constant>INI_ALL</constant></entry>
119
121
<entry></entry>
120
122
</row>
121
123
<row>
124
+
<entry><link linkend="ini.error-log-mode">error_log_mode</link></entry>
125
+
<entry>0o644</entry>
126
+
<entry><constant>INI_ALL</constant></entry>
127
+
<entry>Available as of PHP 8.2.0</entry>
128
+
</row>
129
+
<row>
122
130
<entry><link linkend="ini.syslog.facility">syslog.facility</link></entry>
123
131
<entry>"LOG_USER"</entry>
124
-
<entry>PHP_INI_SYSTEM</entry>
132
+
<entry><constant>INI_SYSTEM</constant></entry>
125
133
<entry>Available as of PHP 7.3.0.</entry>
126
134
</row>
127
135
<row>
128
136
<entry><link linkend="ini.syslog.filter">syslog.filter</link></entry>
129
137
<entry>"no-ctrl"</entry>
130
-
<entry>PHP_INI_ALL</entry>
138
+
<entry><constant>INI_ALL</constant></entry>
131
139
<entry>Available as of PHP 7.3.0.</entry>
132
140
</row>
133
141
<row>
134
142
<entry><link linkend="ini.syslog.ident">syslog.ident</link></entry>
135
143
<entry>"php"</entry>
136
-
<entry>PHP_INI_SYSTEM</entry>
144
+
<entry><constant>INI_SYSTEM</constant></entry>
137
145
<entry>Available as of PHP 7.3.0.</entry>
138
146
</row>
139
147
</tbody>
...
...
@@ -149,7 +157,7 @@
149
157
<varlistentry xml:id="ini.error-reporting">
150
158
<term>
151
159
<parameter>error_reporting</parameter>
152
-
<type>integer</type>
160
+
<type>int</type>
153
161
</term>
154
162
<listitem>
155
163
<para>
...
...
@@ -162,53 +170,23 @@
162
170
<link linkend="ini.display-errors">display_errors</link> directive.
163
171
</para>
164
172
<para>
165
-
PHP 5.3 or later, the default value
166
-
is <constant>E_ALL</constant> &amp;
167
-
~<constant>E_NOTICE</constant> &amp;
168
-
~<constant>E_STRICT</constant> &amp;
169
-
~<constant>E_DEPRECATED</constant>. This setting does not
170
-
show <constant>E_NOTICE</constant>, <constant>E_STRICT</constant>
171
-
and <constant>E_DEPRECATED</constant> level errors. You may want
172
-
to show them during development.
173
-
Prior to PHP 5.3.0, the default value
174
-
is <constant>E_ALL</constant> &amp;
175
-
~<constant>E_NOTICE</constant> &amp;
176
-
~<constant>E_STRICT</constant>.
177
-
In PHP 4 the default value is <constant>E_ALL</constant>
178
-
&amp; ~<constant>E_NOTICE</constant>.
173
+
The default value is <constant>E_ALL</constant>.
174
+
</para>
175
+
<para>
176
+
Prior to PHP 8.0.0, the default value was:
177
+
<userinput><constant>E_ALL</constant> &amp;
178
+
~<constant>E_NOTICE</constant> &amp;
179
+
~<constant>E_STRICT</constant> &amp;
180
+
~<constant>E_DEPRECATED</constant></userinput>.
181
+
This means diagnostics of level <constant>E_NOTICE</constant>,
182
+
<constant>E_STRICT</constant> and <constant>E_DEPRECATED</constant>
183
+
were not shown.
179
184
</para>
180
-
<note>
181
-
<para>Enabling <constant>E_NOTICE</constant> during development has
182
-
some benefits. For debugging purposes: NOTICE messages will warn you
183
-
about possible bugs in your code. For example, use of unassigned values
184
-
is warned. It is extremely useful to find typos and
185
-
to save time for debugging. NOTICE messages will warn you about bad style.
186
-
For example, <literal>$arr[item]</literal> is better to be written as
187
-
<literal>$arr['item']</literal> since PHP tries to treat
188
-
<literal>"item"</literal> as constant. If it is not a constant, PHP assumes
189
-
it is a string index for the array.
190
-
</para>
191
-
</note>
192
-
<note>
193
-
<para>
194
-
In PHP 5 a new error level <constant>E_STRICT</constant> is available.
195
-
Prior to PHP 5.4.0 <constant>E_STRICT</constant> was not included within
196
-
<constant>E_ALL</constant>, so you would have to explicitly enable this kind of
197
-
error level in PHP &lt; 5.4.0. Enabling <constant>E_STRICT</constant> during development
198
-
has some benefits. STRICT messages provide suggestions that can help
199
-
ensure the best interoperability and forward compatibility of your code.
200
-
These messages may include things such as calling non-static methods
201
-
statically, defining properties in a compatible class definition while
202
-
defined in a used trait, and prior to PHP 5.3 some deprecated features
203
-
would issue <constant>E_STRICT</constant> errors such as assigning
204
-
objects by reference upon instantiation.
205
-
</para>
206
-
</note>
207
185
<note>
208
186
<title>PHP Constants outside of PHP</title>
209
187
<para>
210
188
Using PHP Constants outside of PHP, like in <filename>httpd.conf</filename>,
211
-
will have no useful meaning so in such cases the <type>integer</type> values
189
+
will have no useful meaning so in such cases the <type>int</type> values
212
190
are required. And since error levels will be added over time, the maximum
213
191
value (for <constant>E_ALL</constant>) will likely change. So in place of
214
192
<constant>E_ALL</constant> consider using a larger value to cover all bit
...
...
@@ -232,8 +210,7 @@
232
210
</para>
233
211
<para>
234
212
Value <literal>"stderr"</literal> sends the errors to <literal>stderr</literal>
235
-
instead of <literal>stdout</literal>. The value is available as of PHP
236
-
5.2.4. In earlier versions, this directive was of type <type>boolean</type>.
213
+
instead of <literal>stdout</literal>.
237
214
</para>
238
215
<note>
239
216
<para>
...
...
@@ -254,7 +231,7 @@
254
231
<varlistentry xml:id="ini.display-startup-errors">
255
232
<term>
256
233
<parameter>display_startup_errors</parameter>
257
-
<type>boolean</type>
234
+
<type>bool</type>
258
235
</term>
259
236
<listitem>
260
237
<para>
...
...
@@ -268,7 +245,7 @@
268
245
<varlistentry xml:id="ini.log-errors">
269
246
<term>
270
247
<parameter>log_errors</parameter>
271
-
<type>boolean</type>
248
+
<type>bool</type>
272
249
</term>
273
250
<listitem>
274
251
<para>
...
...
@@ -288,7 +265,7 @@
288
265
<varlistentry xml:id="ini.log-errors-max-len">
289
266
<term>
290
267
<parameter>log_errors_max_len</parameter>
291
-
<type>integer</type>
268
+
<type>int</type>
292
269
</term>
293
270
<listitem>
294
271
<para>
...
...
@@ -309,7 +286,7 @@
309
286
<varlistentry xml:id="ini.ignore-repeated-errors">
310
287
<term>
311
288
<parameter>ignore_repeated_errors</parameter>
312
-
<type>boolean</type>
289
+
<type>bool</type>
313
290
</term>
314
291
<listitem>
315
292
<para>
...
...
@@ -324,7 +301,7 @@
324
301
<varlistentry xml:id="ini.ignore-repeated-source">
325
302
<term>
326
303
<parameter>ignore_repeated_source</parameter>
327
-
<type>boolean</type>
304
+
<type>bool</type>
328
305
</term>
329
306
<listitem>
330
307
<para>
...
...
@@ -338,16 +315,16 @@
338
315
<varlistentry xml:id="ini.report-memleaks">
339
316
<term>
340
317
<parameter>report_memleaks</parameter>
341
-
<type>boolean</type>
318
+
<type>bool</type>
342
319
</term>
343
320
<listitem>
344
321
<para>
345
322
If this parameter is set to On (the default), this parameter will show a
346
323
report of memory leaks detected by the Zend memory manager. This report
347
-
will be send to stderr on Posix platforms. On Windows, it will be send
348
-
to the debugger using OutputDebugString(), and can be viewed with tools
324
+
will be sent to stderr on Posix platforms. On Windows, it will be sent
325
+
to the debugger using OutputDebugString() and can be viewed with tools
349
326
like <link xlink:href="&url.dbgview;">DbgView</link>.
350
-
This parameter only has effect in a debug build, and if
327
+
This parameter only has effect in a debug build and if
351
328
error_reporting includes <constant>E_WARNING</constant> in the allowed
352
329
list.
353
330
</para>
...
...
@@ -357,7 +334,7 @@
357
334
<varlistentry xml:id="ini.track-errors">
358
335
<term>
359
336
<parameter>track_errors</parameter>
360
-
<type>boolean</type>
337
+
<type>bool</type>
361
338
</term>
362
339
<listitem>
363
340
<para>
...
...
@@ -370,7 +347,7 @@
370
347
<varlistentry xml:id="ini.html-errors">
371
348
<term>
372
349
<parameter>html_errors</parameter>
373
-
<type>boolean</type>
350
+
<type>bool</type>
374
351
</term>
375
352
<listitem>
376
353
<para>
...
...
@@ -390,7 +367,7 @@
390
367
<varlistentry xml:id="ini.xmlrpc-errors">
391
368
<term>
392
369
<parameter>xmlrpc_errors</parameter>
393
-
<type>boolean</type>
370
+
<type>bool</type>
394
371
</term>
395
372
<listitem>
396
373
<para>
...
...
@@ -403,7 +380,7 @@
403
380
<varlistentry xml:id="ini.xmlrpc-error-number">
404
381
<term>
405
382
<parameter>xmlrpc_error_number</parameter>
406
-
<type>integer</type>
383
+
<type>int</type>
407
384
</term>
408
385
<listitem>
409
386
<para>
...
...
@@ -470,6 +447,8 @@
470
447
<listitem>
471
448
<para>
472
449
String to output before an error message.
450
+
Only used when the error message is displayed on screen. The main purpose
451
+
is to be able to prepend additional HTML markup to the error message.
473
452
</para>
474
453
</listitem>
475
454
</varlistentry>
...
...
@@ -482,6 +461,8 @@
482
461
<listitem>
483
462
<para>
484
463
String to output after an error message.
464
+
Only used when the error message is displayed on screen. The main purpose
465
+
is to be able to append additional HTML markup to the error message.
485
466
</para>
486
467
</listitem>
487
468
</varlistentry>
...
...
@@ -507,6 +488,19 @@
507
488
</listitem>
508
489
</varlistentry>
509
490

491
+
<varlistentry xml:id="ini.error-log-mode">
492
+
<term>
493
+
<parameter>error_log_mode</parameter>
494
+
<type>int</type>
495
+
</term>
496
+
<listitem>
497
+
<para>
498
+
File mode for the file described set in
499
+
<link linkend="ini.error-log">error_log</link>.
500
+
</para>
501
+
</listitem>
502
+
</varlistentry>
503
+

510
504
<varlistentry xml:id="ini.syslog.facility">
511
505
<term>
512
506
<parameter>syslog.facility</parameter>
...
...
@@ -529,21 +523,39 @@
529
523
<para>
530
524
Specifies the filter type to filter the logged messages. Allowed
531
525
characters are passed unmodified; all others are written in their
532
-
hexadecimal representation prefixed with <literal>\x</literal>. There are
533
-
three supported filter types:
526
+
hexadecimal representation prefixed with <literal>\x</literal>.
534
527
<itemizedlist>
535
528
<listitem>
536
-
<simpara><literal>all</literal> – all characters</simpara>
529
+
<simpara><literal>all</literal> – the logged string will be split
530
+
at newline characters, and all characters are passed unaltered
531
+
</simpara>
537
532
</listitem>
538
533
<listitem>
539
-
<simpara><literal>no-ctrl</literal> – all characters except control characters</simpara>
534
+
<simpara><literal>ascii</literal> – the logged string will be split
535
+
at newline characters, and any non-printable 7-bit ASCII characters will be escaped
536
+
</simpara>
540
537
</listitem>
541
538
<listitem>
542
-
<simpara><literal>ascii</literal> – all printable ASCII characters and <literal>NL</literal></simpara>
539
+
<simpara><literal>no-ctrl</literal> – the logged string will be split
540
+
at newline characters, and any non-printable characters will be escaped
541
+
</simpara>
542
+
</listitem>
543
+
<listitem>
544
+
<simpara><literal>raw</literal> – all characters are passed to the system
545
+
logger unaltered, without splitting at newlines (identical to PHP before 7.3)
546
+
</simpara>
543
547
</listitem>
544
548
</itemizedlist>
545
-
Only effective if <link linkend="ini.error-log">error_log</link> is set to "syslog".
549
+
This setting will affect logging via <link linkend="ini.error-log">error_log</link> set to "syslog" and calls to <function>syslog</function>.
546
550
</para>
551
+
<note>
552
+
<para>
553
+
The <literal>raw</literal> filter type is available as of PHP 7.3.8 and PHP 7.4.0.
554
+
</para>
555
+
</note>
556
+
<simpara>
557
+
This directive is not supported on Windows.
558
+
</simpara>
547
559
</listitem>
548
560
</varlistentry>
549
561

550
562