reference/info/functions/php-ini-scanned-files.xml
8dd14a886c7e954cef181c374b6f05cc7149e643
...
...
@@ -9,33 +9,37 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>string</type><methodname>php_ini_scanned_files</methodname>
12
+
<type class="union"><type>string</type><type>false</type></type><methodname>php_ini_scanned_files</methodname>
13
13
<void/>
14
14
</methodsynopsis>
15
15
<para>
16
16
<function>php_ini_scanned_files</function> returns a comma-separated
17
-
list of configuration files parsed after &php.ini;. These files are
18
-
found in a directory defined by the
19
-
<option role="configure">--with-config-file-scan-dir</option> option
20
-
which is set during compilation.
17
+
list of configuration files parsed after &php.ini;. The directories
18
+
searched are set by a compile time option and, optionally, by an
19
+
environment variable at run time: more information can be found in the
20
+
<link linkend="configuration.file.scan">installation guide</link>.
21
21
</para>
22
22
<para>
23
-
The returned configuration files also include the path as declared in
24
-
the <option role="configure">--with-config-file-scan-dir</option>
25
-
option.
23
+
The returned configuration files include the full path.
26
24
</para>
27
25
</refsect1>
28
26

27
+
<refsect1 role="parameters">
28
+
&reftitle.parameters;
29
+
&no.function.parameters;
30
+
</refsect1>
31
+

29
32
<refsect1 role="returnvalues">
30
33
&reftitle.returnvalues;
31
34
<para>
32
35
Returns a comma-separated string of .ini files on success. Each comma is
33
-
followed by a newline. If the directive <option
34
-
role="configure">--with-config-file-scan-dir</option> wasn't set,
35
-
&false; is returned. If it was set and the directory was empty, an
36
-
empty string is returned. If a file is unrecognizable, the file will
37
-
still make it into the returned string but a PHP error will also result.
38
-
This PHP error will be seen both at compile time and while using
36
+
followed by a newline. If the configure directive <option
37
+
role="configure">--with-config-file-scan-dir</option> wasn't set and the
38
+
<varname>PHP_INI_SCAN_DIR</varname> environment variable isn't set, &false;
39
+
is returned. If it was set and the directory was empty, an empty string is
40
+
returned. If a file is unrecognizable, the file will still make it into
41
+
the returned string but a PHP error will also result. This PHP error will
42
+
be seen both at compile time and while using
39
43
<function>php_ini_scanned_files</function>.
40
44
</para>
41
45
</refsect1>
...
...
@@ -76,7 +80,6 @@ if ($filelist = php_ini_scanned_files()) {
76
80
</refsect1>
77
81

78
82
</refentry>
79
-

80
83
<!-- Keep this comment at the end of the file
81
84
Local variables:
82
85
mode: sgml
83
86