From 0b725887a3b3f20acd2fb6a7e0e2f6b4d1f0c075 Mon Sep 17 00:00:00 2001
From: Hannes Magnusson <bjori@php.net>
Date: Sat, 15 Nov 2008 17:21:02 +0000
Subject: [PATCH] Categorize SPL:  - Interfaces (only Countable documented)  -
 Iterators  - Exceptions (not documented)  - Functions  - "Uncategorized
 classes" (only arrayobject, splfileinfo documented)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@269055 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/spl/book.xml           |  30 ++++-----
 reference/spl/datastructures.xml |  29 ++++++---
 reference/spl/interfaces.xml     |  60 ++++++++++++++++++
 reference/spl/iterators.xml      | 101 +++++++++++++++++++++++++++++++
 4 files changed, 192 insertions(+), 28 deletions(-)
 create mode 100644 reference/spl/interfaces.xml
 create mode 100644 reference/spl/iterators.xml

diff --git a/reference/spl/book.xml b/reference/spl/book.xml
index 61380fd08e..a604d0c6d7 100644
--- a/reference/spl/book.xml
+++ b/reference/spl/book.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
 
 <book xml:id="book.spl" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <title>Standard PHP Library (SPL)</title>
@@ -22,28 +22,19 @@
  &reference.spl.setup;
  &reference.spl.constants;
  &reference.spl.datastructures;
+ &reference.spl.iterators;
+ &reference.spl.interfaces;
  &reference.spl.reference;
 
- &reference.spl.arrayiterator;
  &reference.spl.arrayobject;
- &reference.spl.cachingiterator;
- &reference.spl.recursivecachingiterator;
- &reference.spl.directoryiterator;
- &reference.spl.filteriterator;
- &reference.spl.limititerator;
- &reference.spl.parentiterator;
- &reference.spl.recursivedirectoryiterator;
- &reference.spl.recursiveiteratoriterator;
- &reference.spl.simplexmliterator;
+ &reference.spl.splfileinfo;
 
- &reference.spl.spldoublylinkedlist;
- &reference.spl.splstack;
- &reference.spl.splqueue;
-
- &reference.spl.splheap;
- &reference.spl.splmaxheap;
- &reference.spl.splminheap;
- &reference.spl.splpriorityqueue;
+<!-- TODO: Not documented
+ &reference.spl.splfileobject;
+ &reference.spl.splfixedarray;
+ &reference.spl.splobjectstorage;
+ &reference.spl.spltempfileobject;
+-->
 
 </book>
 
@@ -67,3 +58,4 @@ 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/datastructures.xml b/reference/spl/datastructures.xml
index 61545c33f7..386b159dbd 100644
--- a/reference/spl/datastructures.xml
+++ b/reference/spl/datastructures.xml
@@ -1,18 +1,18 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 
-<appendix xml:id="spl.datastructures" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<part xml:id="spl.datastructures" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 
  <title>Datastructures</title>
 
- <sect1>
+ <partintro>
   <para>
    SPL provides a set of standard datastructures. They are grouped here by their 
    underlying implementation which usually defines their general field of 
    application.
   </para>
 
-  <sect2>
+  <section>
    <title>Doubly Linked Lists</title>
 
    <para>
@@ -32,8 +32,8 @@
     </listitem>
    </itemizedlist>
 
-  </sect2>
-  <sect2>
+  </section>
+  <section>
    <title>Heaps</title>
 
    <para>
@@ -55,9 +55,19 @@
     </listitem>
    </itemizedlist>
 
-  </sect2>
- </sect1>
-</appendix>
+  </section>
+ </partintro>
+
+ &reference.spl.spldoublylinkedlist;
+ &reference.spl.splstack;
+ &reference.spl.splqueue;
+
+ &reference.spl.splheap;
+ &reference.spl.splmaxheap;
+ &reference.spl.splminheap;
+ &reference.spl.splpriorityqueue;
+
+</part>
 
 
 
@@ -81,3 +91,4 @@ 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/interfaces.xml b/reference/spl/interfaces.xml
new file mode 100644
index 0000000000..47f76f2361
--- /dev/null
+++ b/reference/spl/interfaces.xml
@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- $Revision: 1.1 $ -->
+
+<part xml:id="spl.interfaces" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+
+ <title>Interfaces</title>
+
+ <partintro>
+  <para>
+   SPL provides a set of interfaces.
+  </para>
+
+  <section xml:id="spl.interfaces.list">
+   <title>Interface list</title>
+   <simplelist>
+    <member><classname>Countable</classname></member>
+    <member><classname>OuterIterator</classname></member>
+    <member><classname>RecursiveIterator</classname></member>
+    <member><classname>SeekableIterator</classname></member>
+    <member><classname>SplObserver</classname></member>
+    <member><classname>SplSubject</classname></member>
+   </simplelist>
+  </section>
+
+ </partintro>
+
+ &reference.spl.countable;
+<!-- TODO: Not documented
+ &reference.spl.outeriterator;
+ &reference.spl.recursiveiterator;
+ &reference.spl.seekableiterator;
+ &reference.spl.splobserver;
+ &reference.spl.splsubject;
+-->
+
+</part>
+
+
+
+<!-- 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/iterators.xml b/reference/spl/iterators.xml
new file mode 100644
index 0000000000..dfef3f5cb0
--- /dev/null
+++ b/reference/spl/iterators.xml
@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- $Revision: 1.1 $ -->
+
+<part xml:id="spl.iterators" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+
+ <title>Iterators</title>
+
+ <partintro>
+  <para>
+   SPL provides a set of iterators to traverse over objects.
+  </para>
+
+  <section xml:id="spl.iterators.list">
+   <title>Iterator list</title>
+   <simplelist>
+    <member><classname>AppendIterator</classname></member>
+    <member><classname>ArrayIterator</classname></member>
+    <member><classname>CachingIterator</classname></member>
+    <member><classname>DirectoryIterator</classname></member>
+    <member><classname>EmptyIterator</classname></member>
+    <member><classname>FilesystemIterator</classname></member>
+    <member><classname>FilterIterator</classname></member>
+    <member><classname>GlobIterator</classname></member>
+    <member><classname>InfiniteIterator</classname></member>
+    <member><classname>IteratorIterator</classname></member>
+    <member><classname>LimitIterator</classname></member>
+    <member><classname>MultipleIterator</classname></member>
+    <member><classname>NoRewindIterator</classname></member>
+    <member><classname>ParentIterator</classname></member>
+    <member><classname>RecursiveArrayIterator</classname></member>
+    <member><classname>RecursiveCachingIterator</classname></member>
+    <member><classname>RecursiveDirectoryIterator</classname></member>
+    <member><classname>RecursiveFilterIterator</classname></member>
+    <member><classname>RecursiveIteratorIterator</classname></member>
+    <member><classname>RecursiveRegexIterator</classname></member>
+    <member><classname>RecursiveTreeIterator</classname></member>
+    <member><classname>RegexIterator</classname></member>
+   </simplelist>
+  </section>
+
+ </partintro>
+
+<!-- TODO: Not documented
+ &reference.spl.appenditerator;
+ &reference.spl.emptyiterator;
+ &reference.spl.filesystemiterator;
+ &reference.spl.globiterator;
+ &reference.spl.infiniteiterator;
+ &reference.spl.iteratoriterator;
+ &reference.spl.multipleiterator;
+ &reference.spl.norewinditerator;
+ &reference.spl.recursivearrayiterator;
+ &reference.spl.recursivefilteriterator;
+ &reference.spl.recursiveregexiterator;
+ &reference.spl.recursivetreeiterator;
+ &reference.spl.regexiterator;
+-->
+
+
+ &reference.spl.arrayiterator;
+
+ &reference.spl.cachingiterator;
+ &reference.spl.recursivecachingiterator;
+
+ &reference.spl.directoryiterator;
+ &reference.spl.recursivedirectoryiterator;
+
+ &reference.spl.filteriterator;
+ &reference.spl.limititerator;
+ &reference.spl.parentiterator;
+
+ &reference.spl.recursiveiteratoriterator;
+
+ <!-- Should be moved to SimpleXML -->
+ &reference.spl.simplexmliterator;
+
+</part>
+
+
+
+<!-- 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
+-->
+