php-doc-en/reference/info/functions/get-included-files.xml
2004-01-15 00:15:32 +00:00

114 lines
3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.71 -->
<refentry id="function.get-included-files">
<refnamediv>
<refname>get_included_files</refname>
<refpurpose>
Returns an array with the names of included or required files
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>get_included_files</methodname>
<void/>
</methodsynopsis>
<para>
Returns an array of the names of all files that have been
included using <function>include</function>,
<function>include_once</function>, <function>require</function>
or <function>require_once</function>.
</para>
<para>
The script originally called is considered an "included file," so
it will be listed together with the files referenced by
<function>include</function> and family.
</para>
<para>
Files that are included or required multiple times only show up
once in the returned array.
</para>
<note>
<para>
Files included using the <literal>auto_prepend_file</literal>
configuration directive are not included in the returned array.
</para>
</note>
<para>
<example>
<title><function>get_included_files</function> example (<filename>abc.php</filename>)</title>
<programlisting role="php">
<![CDATA[
<?php
include 'test1.php';
include_once 'test2.php';
require 'test3.php';
require_once 'test4.php';
$included_files = get_included_files();
foreach ($included_files as $filename) {
echo "$filename\n";
}
?>
]]>
</programlisting>
<para>
will generate the following output:
</para>
<screen>
<![CDATA[
abc.php
test1.php
test2.php
test3.php
test4.php
]]>
</screen>
</example>
</para>
<note>
<para>
In PHP 4.0.1pl2 and previous versions
<function>get_included_files</function> assumed that the
required files ended in the extension <literal>.php</literal>;
other extensions would not be returned. The array returned by
<function>get_included_files</function> was an associative array
and only listed files included by <function>include</function>
and <function>include_once</function>.
</para>
</note>
<para>
See also
<function>include</function>,
<function>include_once</function>,
<function>require</function>,
<function>require_once</function>, and
<function>get_required_files</function>.
</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
-->