From 5aed1fa31d8f77222c60fdc82df7072653a77cfb Mon Sep 17 00:00:00 2001
From: Philip Olson <philip@php.net>
Date: Wed, 15 Sep 2010 22:17:18 +0000
Subject: [PATCH] Added an example that lists inclued files, and clarified the
 inclued.dumpdir description

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@303409 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/inclued/examples.xml | 62 +++++++++++++++++++++++++++++++++-
 reference/inclued/ini.xml      |  4 ++-
 2 files changed, 64 insertions(+), 2 deletions(-)

diff --git a/reference/inclued/examples.xml b/reference/inclued/examples.xml
index fa970b4777..bdc6d0900b 100644
--- a/reference/inclued/examples.xml
+++ b/reference/inclued/examples.xml
@@ -12,7 +12,7 @@
   </para>
   <para>
    <example>
-    <title>Getting the data from inclued</title>
+    <title>Getting the data within the PHP application itself (function)</title>
     <programlisting role="php">
 <![CDATA[
 <?php
@@ -55,6 +55,66 @@ $ dot -Tpng -o inclued.png wp.dot
     </programlisting>
    </example>
   </para>
+  <para>
+   <example>
+    <title>Listing data via inclued dumps (configuration)</title>
+    <para>
+     When using the <link linkend="ini.inclued.dumpdir">inclued.dumpdir</link>
+     directive, files (include clues) are dumped with every request. Here's one
+     way to list those files, and <function>unserialize</function> them.
+    </para>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$path = ini_get('inclued.dumpdir');
+if ($path && is_dir($path)) {
+
+    echo "Path: $path", PHP_EOL;
+
+    $inclues = new GlobIterator($path . DIRECTORY_SEPARATOR . 'inclued*');
+
+    if ($inclues->count() === 0) {
+        echo 'No clues today', PHP_EOL;
+        exit;
+    }
+
+    foreach ($inclues as $inclue) {
+
+        echo 'Inclued file: ', $inclue->getFilename(), PHP_EOL;
+
+        $data = file_get_contents($inclue->getPathname());
+        if ($data) {
+            $inc = unserialize($data);
+            echo ' -- filename: ', $inc['request']['SCRIPT_FILENAME'], PHP_EOL;
+            echo ' -- number of includes: ', count($inc['includes']), PHP_EOL;
+        }
+        echo PHP_EOL;
+    }
+} else {
+    echo 'I am totally clueless today.', PHP_EOL;
+}
+?>
+]]>
+    </programlisting>
+    &example.outputs.similar;
+    <screen>
+<![CDATA[
+PATH: /tmp/inclued
+Inclued file: inclued.56521.1
+ -- filename: /Users/philip/test.php
+ -- number of includes: 1
+
+Inclued file: inclued.56563.1
+ -- filename: /tmp/none.php
+ -- number of includes: 0
+
+Inclued file: inclued.56636.1
+ -- filename: /tmp/three.php
+ -- number of includes: 3
+]]>
+    </screen>
+   </example>
+  </para>
  </section>
 </chapter>
 
diff --git a/reference/inclued/ini.xml b/reference/inclued/ini.xml
index 95d28c152e..3db54b193b 100644
--- a/reference/inclued/ini.xml
+++ b/reference/inclued/ini.xml
@@ -63,7 +63,9 @@
     <listitem>
      <para>
       Location (path) to the directory that stores inclued files. If set, each
-      PHP request will create a file.
+      PHP request will create a file. These files are serialized versions of
+      what <function>inclued_get_data</function> would produce, so may be
+      unserialized with <function>unserialize</function>.
      </para>
      <caution>
       <para>