From 65049d5b8cc09e8383f161f3be258b67c8d8991b Mon Sep 17 00:00:00 2001
From: Philip Olson <philip@php.net>
Date: Thu, 2 Apr 2009 07:20:24 +0000
Subject: [PATCH] Briefly documented IteratorIterator

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@278162 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/spl/iteratoriterator.xml            | 84 +++++++++++++++++++
 reference/spl/iteratoriterator/construct.xml  | 73 ++++++++++++++++
 reference/spl/iteratoriterator/current.xml    | 63 ++++++++++++++
 .../spl/iteratoriterator/getinneriterator.xml | 64 ++++++++++++++
 reference/spl/iteratoriterator/key.xml        | 63 ++++++++++++++
 reference/spl/iteratoriterator/next.xml       | 64 ++++++++++++++
 reference/spl/iteratoriterator/rewind.xml     | 64 ++++++++++++++
 reference/spl/iteratoriterator/valid.xml      | 64 ++++++++++++++
 8 files changed, 539 insertions(+)
 create mode 100644 reference/spl/iteratoriterator.xml
 create mode 100644 reference/spl/iteratoriterator/construct.xml
 create mode 100644 reference/spl/iteratoriterator/current.xml
 create mode 100644 reference/spl/iteratoriterator/getinneriterator.xml
 create mode 100644 reference/spl/iteratoriterator/key.xml
 create mode 100644 reference/spl/iteratoriterator/next.xml
 create mode 100644 reference/spl/iteratoriterator/rewind.xml
 create mode 100644 reference/spl/iteratoriterator/valid.xml

diff --git a/reference/spl/iteratoriterator.xml b/reference/spl/iteratoriterator.xml
new file mode 100644
index 0000000000..b8056eba57
--- /dev/null
+++ b/reference/spl/iteratoriterator.xml
@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+
+<phpdoc:classref xml:id="class.iteratoriterator" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>The IteratorIterator class</title>
+ <titleabbrev>IteratorIterator</titleabbrev>
+
+ <partintro>
+
+<!-- {{{ IteratorIterator intro -->
+  <section xml:id="iteratoriterator.intro">
+   &reftitle.intro;
+   <para>
+    This iterator wrapper allows the conversion of anything that is
+    <link linkend="class.traversable">Traversable</link> into an Iterator.
+    It is important to understand that most classes that do not implement
+    Iterators have reasons as most likely they do not allow the full
+    Iterator feature set. If so, techniques should be provided to prevent
+    misuse, otherwise expect exceptions or fatal errors.
+   </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="iteratoriterator.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>IteratorIterator</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>IteratorIterator</classname>
+     </ooclass>
+
+     <oointerface>
+      <interfacename>Iterator</interfacename>
+     </oointerface>
+
+     <oointerface>
+      <interfacename>Traversable</interfacename>
+     </oointerface>
+
+     <oointerface>
+      <interfacename>OuterIterator</interfacename>
+     </oointerface>
+    </classsynopsisinfo>
+<!-- }}} -->
+
+    <classsynopsisinfo role="comment">Methods</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.iteratoriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+
+ </partintro>
+
+ &reference.spl.entities.iteratoriterator;
+
+</phpdoc:classref>
+
+<!-- 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/iteratoriterator/construct.xml b/reference/spl/iteratoriterator/construct.xml
new file mode 100644
index 0000000000..6050bf1409
--- /dev/null
+++ b/reference/spl/iteratoriterator/construct.xml
@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+
+<refentry xml:id="iteratoriterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>IteratorIterator::__construct</refname>
+  <refpurpose>Create an iterator from anything that is traversable</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <methodname>IteratorIterator::__construct</methodname>
+   <methodparam><type>Traversable</type><parameter>iterator</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Creates an iterator from anything that is traversable.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>iterator</parameter></term>
+     <listitem>
+      <para>
+       The traversable iterator.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.void;
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><classname>Traversable</classname></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/iteratoriterator/current.xml b/reference/spl/iteratoriterator/current.xml
new file mode 100644
index 0000000000..7a8a7e3b2a
--- /dev/null
+++ b/reference/spl/iteratoriterator/current.xml
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+
+<refentry xml:id="iteratoriterator.current" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>IteratorIterator::current</refname>
+  <refpurpose>Get the current value</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>IteratorIterator::current</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Get the value of the current element.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   The value of the current element.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><methodname>IteratorIterator::key</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/iteratoriterator/getinneriterator.xml b/reference/spl/iteratoriterator/getinneriterator.xml
new file mode 100644
index 0000000000..162c4e1512
--- /dev/null
+++ b/reference/spl/iteratoriterator/getinneriterator.xml
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+
+<refentry xml:id="iteratoriterator.getinneriterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>IteratorIterator::getInnerIterator</refname>
+  <refpurpose>Get the inner iterator</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>IteratorIterator::getInnerIterator</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Get the inner iterator.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   The inner iterator as passed to <methodname>IteratorIterator::__construct</methodname>.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><classname>Iterator</classname></member>
+    <member><classname>OuterIterator</classname></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/iteratoriterator/key.xml b/reference/spl/iteratoriterator/key.xml
new file mode 100644
index 0000000000..9e9e62db40
--- /dev/null
+++ b/reference/spl/iteratoriterator/key.xml
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+
+<refentry xml:id="iteratoriterator.key" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>IteratorIterator::key</refname>
+  <refpurpose>Get the key of the current element</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>IteratorIterator::key</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Get the key of the current element.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   The key of the current element.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><methodname>IteratorIterator::current</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/iteratoriterator/next.xml b/reference/spl/iteratoriterator/next.xml
new file mode 100644
index 0000000000..abfd25f71c
--- /dev/null
+++ b/reference/spl/iteratoriterator/next.xml
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+
+<refentry xml:id="iteratoriterator.next" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>IteratorIterator::next</refname>
+  <refpurpose>Forward to the next element</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>IteratorIterator::next</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Forward to the next element.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.void;
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><methodname>IteratorIterator::rewind</methodname></member>
+    <member><methodname>IteratorIterator::valid</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/iteratoriterator/rewind.xml b/reference/spl/iteratoriterator/rewind.xml
new file mode 100644
index 0000000000..2c5c2776f9
--- /dev/null
+++ b/reference/spl/iteratoriterator/rewind.xml
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+
+<refentry xml:id="iteratoriterator.rewind" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>IteratorIterator::rewind</refname>
+  <refpurpose>Rewind to the first element</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>IteratorIterator::rewind</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Rewinds to the first element.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.void;
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><methodname>IteratorIterator::next</methodname></member>
+    <member><methodname>IteratorIterator::valid</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/iteratoriterator/valid.xml b/reference/spl/iteratoriterator/valid.xml
new file mode 100644
index 0000000000..984e33cdbc
--- /dev/null
+++ b/reference/spl/iteratoriterator/valid.xml
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+
+<refentry xml:id="iteratoriterator.valid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>IteratorIterator::valid</refname>
+  <refpurpose>Checks if the iterator is valid</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>IteratorIterator::valid</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Checks if the iterator is valid.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns &true; if the iterator is valid, otherwise &false;
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>iterator_count</function></member>
+    <member><methodname>IteratorIterator::current</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
+-->