mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
af4410a7e1
still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
149 lines
3.5 KiB
XML
149 lines
3.5 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $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="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>4.0.1</entry>
|
|
<entry>
|
|
In PHP 4.0.1 and previous versions this 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>.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</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[
|
|
abc.php
|
|
test1.php
|
|
test2.php
|
|
test3.php
|
|
test4.php
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
Files included using the <literal>auto_prepend_file</literal>
|
|
configuration directive are not included in the returned array.
|
|
</para>
|
|
</note>
|
|
</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
|
|
-->
|