File: php-ini-scanned-files.xml

package info (click to toggle)
php-doc 20081024-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 57,752 kB
  • ctags: 3,858
  • sloc: xml: 686,554; php: 19,446; perl: 610; cpp: 500; makefile: 336; sh: 114; awk: 28
file content (99 lines) | stat: -rw-r--r-- 2,837 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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.php-ini-scanned-files" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>php_ini_scanned_files</refname>
  <refpurpose>Return a list of .ini files parsed from the additional ini dir</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>php_ini_scanned_files</methodname>
   <void/>
  </methodsynopsis>
  <para>
   <function>php_ini_scanned_files</function> returns a comma-separated
   list of configuration files parsed after &php.ini;.  These files are
   found in a directory defined by the
   <option role="configure">--with-config-file-scan-dir</option> option
   which is set during compilation.
  </para>
  <para>
   The returned configuration files also include the path as declared in
   the <option role="configure">--with-config-file-scan-dir</option>
   option.
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a comma-separated string of .ini files on success. Each comma is
   followed by a newline. If the directive <option
   role="configure">--with-config-file-scan-dir</option> wasn't set,
   &false; is returned.  If it was set and the directory was empty, an
   empty string is returned.  If a file is unrecognizable, the file will
   still make it into the returned string but a PHP error will also result.
   This PHP error will be seen both at compile time and while using
   <function>php_ini_scanned_files</function>.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A simple example to list the returned ini files</title>
    <programlisting role="php">
<![CDATA[
<?php
if ($filelist = php_ini_scanned_files()) {
    if (strlen($filelist) > 0) {
        $files = explode(',', $filelist);

        foreach ($files as $file) {
            echo "<li>" . trim($file) . "</li>\n";
        }
    }
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ini_set</function></member>
    <member><function>phpinfo</function></member>
    <member><function>php_ini_loaded_file</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- 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:"../../../../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
-->