From 3ecf580903149735be74f23a9e34f4fc6ba20203 Mon Sep 17 00:00:00 2001
From: Peter Cowburn <salathe@php.net>
Date: Sat, 29 Mar 2014 21:53:53 +0000
Subject: [PATCH] CachingIterator::getCache()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333177 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/spl/cachingiterator/getcache.xml | 71 +++++++++++++++++++---
 1 file changed, 64 insertions(+), 7 deletions(-)

diff --git a/reference/spl/cachingiterator/getcache.xml b/reference/spl/cachingiterator/getcache.xml
index 351fca9405..37a46dc375 100644
--- a/reference/spl/cachingiterator/getcache.xml
+++ b/reference/spl/cachingiterator/getcache.xml
@@ -4,18 +4,24 @@
 <refentry xml:id="cachingiterator.getcache" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>CachingIterator::getCache</refname>
-  <refpurpose>The getCache purpose</refpurpose>
+  <refpurpose>Retrieve the contents of the cache</refpurpose>
  </refnamediv>
-
+ 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>CachingIterator::getCache</methodname>
+   <modifier>public</modifier> <type>array</type><methodname>CachingIterator::getCache</methodname>
    <void />
   </methodsynopsis>
-  
-  &warn.undocumented.func;
-  
+  <para>
+   Retrieve the contents of the cache.
+  </para>
+  <note>
+   <para>
+    The <constant>CachingIterator::FULL_CACHE</constant> flag
+    must be being used.
+   </para>
+  </note>
  </refsect1>
 
  <refsect1 role="parameters">
@@ -26,7 +32,58 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Description...
+   An <type>array</type> containing the cache items.
+  </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Throws a <classname>BadMethodCallException</classname> when the
+   <constant>CachingIterator::FULL_CACHE</constant> flag is not being used.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><methodname>CachingIterator::getCache</methodname> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$iterator = new ArrayIterator(array(1, 2, 3));
+$cache    = new CachingIterator($iterator, CachingIterator::FULL_CACHE);
+
+$cache->next();
+$cache->next();
+var_dump($cache->getCache());
+
+$cache->next();
+var_dump($cache->getCache());
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+array(2) {
+  [0]=>
+  int(1)
+  [1]=>
+  int(2)
+}
+array(3) {
+  [0]=>
+  int(1)
+  [1]=>
+  int(2)
+  [2]=>
+  int(3)
+}
+]]>
+    </screen>
+   </example>
   </para>
  </refsect1>