php-doc-en/reference/info/functions/get-included-files.xml

110 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.get-included-files" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>get_included_files</refname>
<refpurpose>Returns an array with the names of included or required files</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>get_included_files</methodname>
<void/>
</methodsynopsis>
<para>
Gets 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>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of the names of all files.
</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>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>get_included_files</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// This file is abc.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>
&example.outputs;
<screen>
<![CDATA[
/path/to/abc.php
/path/to/test1.php
/path/to/test2.php
/path/to/test3.php
/path/to/test4.php
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>include</function></member>
<member><function>include_once</function></member>
<member><function>require</function></member>
<member><function>require_once</function></member>
<member><function>get_required_files</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
-->