From 56c22ac5c49711d660d74e127f622a88513b4c84 Mon Sep 17 00:00:00 2001
From: Mikko Koppanen <mkoppanen@php.net>
Date: Sat, 2 Jan 2010 01:56:39 +0000
Subject: [PATCH] Added documentation for TokyoTyrantIterator

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@292910 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../tokyo_tyrant/tokyotyrant/getiterator.xml  |  85 ++++++++++++++
 .../tokyo_tyrant/tokyotyrantiterator.xml      |  76 +++++++++++++
 .../tokyotyrantiterator/construct.xml         | 107 ++++++++++++++++++
 .../tokyotyrantiterator/current.xml           |  66 +++++++++++
 .../tokyo_tyrant/tokyotyrantiterator/key.xml  |  66 +++++++++++
 .../tokyo_tyrant/tokyotyrantiterator/next.xml |  66 +++++++++++
 .../tokyotyrantiterator/rewind.xml            |  66 +++++++++++
 .../tokyotyrantiterator/valid.xml             |  66 +++++++++++
 .../tokyotyranttable/getiterator.xml          |  85 ++++++++++++++
 reference/tokyo_tyrant/versions.xml           |   6 +
 10 files changed, 689 insertions(+)
 create mode 100644 reference/tokyo_tyrant/tokyotyrant/getiterator.xml
 create mode 100644 reference/tokyo_tyrant/tokyotyrantiterator.xml
 create mode 100644 reference/tokyo_tyrant/tokyotyrantiterator/construct.xml
 create mode 100644 reference/tokyo_tyrant/tokyotyrantiterator/current.xml
 create mode 100644 reference/tokyo_tyrant/tokyotyrantiterator/key.xml
 create mode 100644 reference/tokyo_tyrant/tokyotyrantiterator/next.xml
 create mode 100644 reference/tokyo_tyrant/tokyotyrantiterator/rewind.xml
 create mode 100644 reference/tokyo_tyrant/tokyotyrantiterator/valid.xml
 create mode 100644 reference/tokyo_tyrant/tokyotyranttable/getiterator.xml

diff --git a/reference/tokyo_tyrant/tokyotyrant/getiterator.xml b/reference/tokyo_tyrant/tokyotyrant/getiterator.xml
new file mode 100644
index 0000000000..9ad8d9cebe
--- /dev/null
+++ b/reference/tokyo_tyrant/tokyotyrant/getiterator.xml
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 291194 $ -->
+
+<refentry xml:id="tokyotyrant.getiterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>TokyoTyrant::getIterator</refname>
+  <refpurpose>Get an iterator</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>TokyoTyrantIterator</type><methodname>TokyoTyrant::getIterator</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Gets an iterator for iterating all keys / values in the database.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   This method returns TokyoTyrantIterator object and throws TokyoTyrantException on failure.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><methodname>TokyoTyrant::getIterator</methodname> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$tt = new TokyoTyrant("localhost");
+$it = $tt->getIterator();
+
+foreach ($it as $k => $v) {
+
+}
+?>
+]]>
+    </programlisting>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><methodname>TokyoTyrantTable::getQuery</methodname></member>
+    <member><methodname>TokyoTyrantTable::getIterator</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:"~/.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
+-->
diff --git a/reference/tokyo_tyrant/tokyotyrantiterator.xml b/reference/tokyo_tyrant/tokyotyrantiterator.xml
new file mode 100644
index 0000000000..d441d16a74
--- /dev/null
+++ b/reference/tokyo_tyrant/tokyotyrantiterator.xml
@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 290998 $ -->
+
+<phpdoc:classref xml:id="class.tokyotyrantiterator" 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 TokyoTyrantIterator class</title>
+ <titleabbrev>TokyoTyrantIterator</titleabbrev>
+
+ <partintro>
+
+<!-- {{{ tokyotyrantiterator intro -->
+  <section xml:id="tokyotyrantiterator.intro">
+   &reftitle.intro;
+   <para>
+    Provides an iterator for TokyoTyrant and TokyoTyrantTable objects. The iterator iterates over
+    over all keys and values in the database. TokyoTyrantIterator was added in version 0.2.0.
+  </section>
+<!-- }}} -->
+
+  <section xml:id="tokyotyrantiterator.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>TokyoTyrantIterator</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>TokyoTyrantIterator</classname>
+     </ooclass>
+     
+     <ooclass>
+      <modifier>implements</modifier>
+      <classname>Iterator</classname>
+     </ooclass>
+    </classsynopsisinfo>
+<!-- }}} -->
+    
+    <classsynopsisinfo role="comment">Methods</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.tokyotyrantiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+    
+    <classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.tokyotyrant')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+
+ </partintro>
+
+ &reference.tokyo-tyrant.entities.tokyotyrantiterator;
+
+</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:"~/.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
+-->
diff --git a/reference/tokyo_tyrant/tokyotyrantiterator/construct.xml b/reference/tokyo_tyrant/tokyotyrantiterator/construct.xml
new file mode 100644
index 0000000000..3d6cba9cea
--- /dev/null
+++ b/reference/tokyo_tyrant/tokyotyrantiterator/construct.xml
@@ -0,0 +1,107 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 291194 $ -->
+
+<refentry xml:id="tokyotyrantiterator.__construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>TokyoTyrantIterator::__construct</refname>
+  <refpurpose>Construct an iterator</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>TokyoTyrantIterator</type><methodname>TokyoTyrantIterator::__construct</methodname>
+   <methodparam><type>mixed</type><parameter>object</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Construct a new TokyoTyrantIterator object. One connection can have multiple iterators but it is not quaranteed
+   that all items are traversed in that case. <parameter>object</parameter> parameter can be either an of instance 
+   TokyoTyrant or TokyoTyrantTable.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Throws an exception if iterator initialization fails.
+  </para>
+ </refsect1>
+
+  <refsect1 role="examples">
+   &reftitle.examples;
+   <para>
+    <example>
+     <title><methodname>TokyoTyrantIterator::__construct</methodname> example</title>
+     <programlisting role="php">
+<![CDATA[
+<?php
+/* Connect to a table database */
+$tt = new TokyoTyrantTable("localhost", 1979);
+
+/* Passing null to put generates a new uid */
+$index = $tt->put(null, array("column1" => "some data", "column2" => "more data"));
+
+/* Construct an iterator */
+$it = new TokyoTyrantIterator($tt);
+
+foreach ($it as $value) {
+    var_dump($value);
+}
+?>
+]]>
+     </programlisting>
+     &example.outputs;
+     <screen>
+<![CDATA[
+array(2) {
+  ["column1"]=>
+  string(9) "some data"
+  ["column2"]=>
+  string(9) "more data"
+}
+]]>
+     </screen>
+    </example>
+   </para>
+  </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+     <member><methodname>TokyoTyrantIterator::key</methodname></member>
+     <member><methodname>TokyoTyrantIterator::current</methodname></member>
+     <member><methodname>TokyoTyrantIterator::next</methodname></member>
+     <member><methodname>TokyoTyrantIterator::rewind</methodname></member>
+     <member><methodname>TokyoTyrantIterator::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:"~/.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
+-->
diff --git a/reference/tokyo_tyrant/tokyotyrantiterator/current.xml b/reference/tokyo_tyrant/tokyotyrantiterator/current.xml
new file mode 100644
index 0000000000..cec15d8953
--- /dev/null
+++ b/reference/tokyo_tyrant/tokyotyrantiterator/current.xml
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 291194 $ -->
+
+<refentry xml:id="tokyotyrantiterator.current" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>TokyoTyrantIterator::current</refname>
+  <refpurpose>Get the current value</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>mixed</type><methodname>TokyoTyrantIterator::current</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Returns the current value during iteration.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the current value on success and false on failure.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+     <member><methodname>TokyoTyrantIterator::valid</methodname></member>
+     <member><methodname>TokyoTyrantIterator::key</methodname></member>
+     <member><methodname>TokyoTyrantIterator::next</methodname></member>
+     <member><methodname>TokyoTyrantIterator::rewind</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:"~/.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
+-->
diff --git a/reference/tokyo_tyrant/tokyotyrantiterator/key.xml b/reference/tokyo_tyrant/tokyotyrantiterator/key.xml
new file mode 100644
index 0000000000..509f0441db
--- /dev/null
+++ b/reference/tokyo_tyrant/tokyotyrantiterator/key.xml
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 291194 $ -->
+
+<refentry xml:id="tokyotyrantiterator.key" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>TokyoTyrantIterator::key</refname>
+  <refpurpose>Returns the current key</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>mixed</type><methodname>TokyoTyrantIterator::key</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Returns the current key.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the current key on success and false on failure.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+     <member><methodname>TokyoTyrantIterator::valid</methodname></member>
+     <member><methodname>TokyoTyrantIterator::current</methodname></member>
+     <member><methodname>TokyoTyrantIterator::next</methodname></member>
+     <member><methodname>TokyoTyrantIterator::rewind</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:"~/.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
+-->
diff --git a/reference/tokyo_tyrant/tokyotyrantiterator/next.xml b/reference/tokyo_tyrant/tokyotyrantiterator/next.xml
new file mode 100644
index 0000000000..b9037cbff7
--- /dev/null
+++ b/reference/tokyo_tyrant/tokyotyrantiterator/next.xml
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 291194 $ -->
+
+<refentry xml:id="tokyotyrantiterator.next" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>TokyoTyrantIterator::next</refname>
+  <refpurpose>Move to next key</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>mixed</type><methodname>TokyoTyrantIterator::next</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Move to next key during iteration and return it's value.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the next value on success and false on failure.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+     <member><methodname>TokyoTyrantIterator::valid</methodname></member>
+     <member><methodname>TokyoTyrantIterator::key</methodname></member>
+     <member><methodname>TokyoTyrantIterator::current</methodname></member>
+     <member><methodname>TokyoTyrantIterator::rewind</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:"~/.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
+-->
diff --git a/reference/tokyo_tyrant/tokyotyrantiterator/rewind.xml b/reference/tokyo_tyrant/tokyotyrantiterator/rewind.xml
new file mode 100644
index 0000000000..c9e23256ae
--- /dev/null
+++ b/reference/tokyo_tyrant/tokyotyrantiterator/rewind.xml
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 291194 $ -->
+
+<refentry xml:id="tokyotyrantiterator.rewind" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>TokyoTyrantIterator::rewind</refname>
+  <refpurpose>Rewinds the iterator</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>TokyoTyrantIterator::rewind</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Rewinds the iterator for new iteration. Called automatically at the beginning of foreach.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Throws TokyoTyrantException if iterator initialization fails.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+     <member><methodname>TokyoTyrantIterator::valid</methodname></member>
+     <member><methodname>TokyoTyrantIterator::current</methodname></member>
+     <member><methodname>TokyoTyrantIterator::next</methodname></member>
+     <member><methodname>TokyoTyrantIterator::rewind</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:"~/.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
+-->
diff --git a/reference/tokyo_tyrant/tokyotyrantiterator/valid.xml b/reference/tokyo_tyrant/tokyotyrantiterator/valid.xml
new file mode 100644
index 0000000000..e2811473a1
--- /dev/null
+++ b/reference/tokyo_tyrant/tokyotyrantiterator/valid.xml
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 291194 $ -->
+
+<refentry xml:id="tokyotyrantiterator.valid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>TokyoTyrantIterator::valid</refname>
+  <refpurpose>Rewinds the iterator</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>boolean</type><methodname>TokyoTyrantIterator::valid</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Checks whether the internal pointer points to valid element.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns true if the pointer points to correct element and false if not.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+     <member><methodname>TokyoTyrantIterator::key</methodname></member>
+     <member><methodname>TokyoTyrantIterator::current</methodname></member>
+     <member><methodname>TokyoTyrantIterator::next</methodname></member>
+     <member><methodname>TokyoTyrantIterator::rewind</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:"~/.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
+-->
diff --git a/reference/tokyo_tyrant/tokyotyranttable/getiterator.xml b/reference/tokyo_tyrant/tokyotyranttable/getiterator.xml
new file mode 100644
index 0000000000..34e4c017a3
--- /dev/null
+++ b/reference/tokyo_tyrant/tokyotyranttable/getiterator.xml
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 291194 $ -->
+
+<refentry xml:id="tokyotyranttable.getiterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>TokyoTyrantTable::getIterator</refname>
+  <refpurpose>Get an iterator</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>TokyoTyrantIterator</type><methodname>TokyoTyrantTable::getIterator</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Gets an iterator for iterating all keys / values in the database.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   This method returns TokyoTyrantIterator object and throws TokyoTyrantException on failure.
+  </para>
+ </refsect1>
+
+  <refsect1 role="examples">
+   &reftitle.examples;
+   <para>
+    <example>
+     <title><methodname>TokyoTyrantTable::getIterator</methodname> example</title>
+     <programlisting role="php">
+<![CDATA[
+<?php
+$tt = new TokyoTyrantTable("localhost");
+$it = $tt->getIterator();
+
+foreach ($it as $k => $v) {
+  var_dump($k, $v);
+}
+?>
+]]>
+     </programlisting>
+    </example>
+   </para>
+  </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+     <member><methodname>TokyoTyrantTable::getQuery</methodname></member>
+     <member><methodname>TokyoTyrant::getIterator</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:"~/.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
+-->
diff --git a/reference/tokyo_tyrant/versions.xml b/reference/tokyo_tyrant/versions.xml
index b510e36da8..8cc43ca5de 100644
--- a/reference/tokyo_tyrant/versions.xml
+++ b/reference/tokyo_tyrant/versions.xml
@@ -76,6 +76,12 @@ Example entries:
  <function name='tokyotyrantexception::gettrace' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
  <function name='tokyotyrantexception::gettraceasstring' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
  <function name='tokyotyrantexception::__tostring' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantiterator::__construct' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
+ <function name='tokyotyrantiterator::next' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
+ <function name='tokyotyrantiterator::valid' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
+ <function name='tokyotyrantiterator::rewind' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
+ <function name='tokyotyrantiterator::key' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
+ <function name='tokyotyrantiterator::current' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
 </versions>
 
 <!-- Keep this comment at the end of the file