From 2951b744fa51e68a996cbbffb3be52a97070ea74 Mon Sep 17 00:00:00 2001
From: Philip Olson <philip@php.net>
Date: Fri, 11 Sep 2009 05:16:43 +0000
Subject: [PATCH] Added skeletons for a few SPL Iterator constructors.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288255 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/spl/filteriterator/construct.xml    | 78 +++++++++++++++
 reference/spl/limititerator/construct.xml     | 96 +++++++++++++++++++
 .../recursivecachingiterator/construct.xml    | 89 +++++++++++++++++
 3 files changed, 263 insertions(+)
 create mode 100644 reference/spl/filteriterator/construct.xml
 create mode 100644 reference/spl/limititerator/construct.xml
 create mode 100644 reference/spl/recursivecachingiterator/construct.xml

diff --git a/reference/spl/filteriterator/construct.xml b/reference/spl/filteriterator/construct.xml
new file mode 100644
index 0000000000..473651fbab
--- /dev/null
+++ b/reference/spl/filteriterator/construct.xml
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="filteriterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>FilterIterator::__construct</refname>
+  <refpurpose>Construct a filterIterator</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <methodname>FilterIterator::__construct</methodname>
+   <methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Constructs a new <classname>FilterIterator</classname>, which consists of
+   a passed in <parameter>iterator</parameter> with filters applied to it.
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>iterator</parameter></term>
+     <listitem>
+      <para>
+       The iterator that is being filtered.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   The <classname>FilterIterator</classname>.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><methodname>LimitIterator::__construct</methodname></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:"../../../../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
+-->
diff --git a/reference/spl/limititerator/construct.xml b/reference/spl/limititerator/construct.xml
new file mode 100644
index 0000000000..9c3ac4167d
--- /dev/null
+++ b/reference/spl/limititerator/construct.xml
@@ -0,0 +1,96 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="limititerator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>LimitIterator::__construct</refname>
+  <refpurpose>Construct a LimitIterator</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <methodname>LimitIterator::__construct</methodname>
+   <methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>offset</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>count</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Constructs a new <classname>LimitIterator</classname>, which consists of
+   a passed in <parameter>iterator</parameter> with limits applied to it.
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>iterator</parameter></term>
+     <listitem>
+      <para>
+       The iterator to limit.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>offset</parameter></term>
+     <listitem>
+      <para>
+       Optional offset of the limit.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>count</parameter></term>
+     <listitem>
+      <para>
+       Optional count of the limit.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   The new <classname>LimitIterator</classname>.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><methodname>FilterIterator::__construct</methodname></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:"../../../../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
+-->
diff --git a/reference/spl/recursivecachingiterator/construct.xml b/reference/spl/recursivecachingiterator/construct.xml
new file mode 100644
index 0000000000..0740a13185
--- /dev/null
+++ b/reference/spl/recursivecachingiterator/construct.xml
@@ -0,0 +1,89 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="recursivecachingiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>RecursiveCachingIterator::__construct</refname>
+  <refpurpose>Construct</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <methodname>RecursiveCachingIterator::__construct</methodname>
+   <methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>flags</parameter><initializer>self::CALL_TOSTRING</initializer></methodparam>
+  </methodsynopsis>
+  <para>
+   Constructs a new <classname>RecursiveCachingIterator</classname>,
+   which consists of a passed in <parameter>iterator</parameter>.
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>iterator</parameter></term>
+     <listitem>
+      <para>
+       The iterator being used.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>flags</parameter></term>
+     <listitem>
+      <para>
+       The flags. Use <constant>CALL_TOSTRING</constant> to call 
+       <methodname>RecursiveCachingIterator::__toString</methodname> for every element (the default),
+       and/or <constant>CATCH_GET_CHILD</constant> to catch exceptions when trying to get children.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   The <classname>RecursiveCachingIterator</classname>.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><methodname>CachingIterator::__construct</methodname></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:"../../../../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
+-->