php-doc-en/reference/info/functions/php-ini-scanned-files.xml
Derick Rethans 64a89e0101 - Consistency and structure
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@132049 c90b9560-bf6c-de11-be94-00142212c4b1
2003-06-16 19:33:51 +00:00

80 lines
2.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.php-ini-scanned-files">
<refnamediv>
<refname>php_ini_scanned_files</refname>
<refpurpose>Return a list of .ini files parsed from the additional ini dir</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>php_ini_scanned_files</methodname>
<void/>
</methodsynopsis>
<simpara>
<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
<literal>--with-config-file-scan-dir</literal>. option which is set
during compilation.
</simpara>
<simpara>
Returns a comma-separated string of .ini files on success. If the
directive <literal>--with-config-files-scan-dir</literal> wasn't set,
&false; is returned. If it was set and the directory was empty, an
empty string is returned. If a file is unreconizable, 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>.
</simpara>
<simpara>
The returned configuration files also include the path as declared in
the <literal>--with-config-file-scan-dir</literal> directive. Also, each
comma is followed by a newline.
</simpara>
<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>
<simpara>
See also <function>ini_set</function> and <function>phpinfo</function>.
</simpara>
</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
-->