php-doc-en/reference/info/functions/php-ini-scanned-files.xml
2015-12-03 16:19:52 +00:00

98 lines
2.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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;. The directories
searched are set by a compile time option and, optionally, by an
environment variable at run time: more information can be found in the
<link linkend="configuration.file.scan">installation guide</link>.
</para>
<para>
The returned configuration files include the full path.
</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 configure directive <option
role="configure">--with-config-file-scan-dir</option> wasn't set and the
<varname>PHP_INI_SCAN_DIR</varname> environment variable isn'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:"~/.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
-->