get-included-files.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 8dd14a886c7e954cef181c374b6f05cc7149e643 Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<refentry xml:id="function.get-included-files" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>get_included_files</refname>
  <refpurpose>返回被 include 和 require 文件名的 array</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>get_included_files</methodname>
   <void/>
  </methodsynopsis>
  <para>
   返回所有被
   <function>include</function>、 <function>include_once</function>、
   <function>require</function> 和 <function>require_once</function>
   的文件名。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   返回所有文件名称的 array。
  </para>
  <para>
   脚本最初被称为”被包含的文件“，所以脚本自身也会和 <function>include</function> 系列函数引用的脚本列在一起。
  </para>
  <para>
   被多次 include 和 require 的文件在返回的 array 里只会列出一次。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>get_included_files</function> 示例</title>
    <programlisting role="php">
<![CDATA[
<?php
// 本文件是 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
-->