From: Marcus Boerger <helly@php.net>
Date: Sun, 31 Oct 2004 19:05:37 +0000 (+0000)
Subject: - Update docu
X-Git-Tag: RELEASE_0_2~787
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=081dac3026c470aa640aee1fc1645a27a1bf7603;p=php

- Update docu
---

diff --git a/ext/spl/internal/cachingiterator.inc b/ext/spl/internal/cachingiterator.inc
index f1b896d05d..59271bfe07 100755
--- a/ext/spl/internal/cachingiterator.inc
+++ b/ext/spl/internal/cachingiterator.inc
@@ -1,7 +1,7 @@
 <?php
 
 /** @file cachingiterator.inc
- * @ingroup Internal
+ * @ingroup SPL
  * @brief class CachingIterator
  * @author  Marcus Boerger
  * @date    2003 - 2004
@@ -13,10 +13,19 @@ define('CIT_CALL_TOSTRING', 1);
 define('CIT_CATCH_GET_CHILD', 2);
 
 /**
- * @brief   Cached Iteration over another Iterator
+ * @brief   Cached iteration over another Iterator
  * @author  Marcus Boerger
  * @version 1.1
  *
+ * This iterator wrapper does a one ahead iteration. This way it knows whether
+ * the inner iterator has one more element.
+ *
+ * @note If you want to convert the elements into strings and the inner 
+ *       Iterator is an internal Iterator then you need to provide the 
+ *       flag CIT_CALL_TOSTRING to do the conversion when the actual element
+ *       is being fetched. Otherwise the conversion would happen with the
+ *       already changed iterator. If you do not need this then it you should
+ *       omit this flag because it costs unneccessary work and time.
  */
 class CachingIterator implements OuterIterator
 {
@@ -98,6 +107,9 @@ class CachingIterator implements OuterIterator
 	}
 
 	/** Aggregate the inner iterator
+	 *
+	 * @param func    Name of method to invoke
+	 * @param params  Array of parameters to pass to method
 	 */
 	function __call($func, $params)
 	{
diff --git a/ext/spl/internal/cachingrecursiveiterator.inc b/ext/spl/internal/cachingrecursiveiterator.inc
index d731c7a725..05012cd478 100755
--- a/ext/spl/internal/cachingrecursiveiterator.inc
+++ b/ext/spl/internal/cachingrecursiveiterator.inc
@@ -1,7 +1,7 @@
 <?php
 
 /** @file cachingrecursiveiterator.inc
- * @ingroup Internal
+ * @ingroup SPL
  * @brief class CachingRecursiveIterator
  * @author  Marcus Boerger
  * @date    2003 - 2004
@@ -10,9 +10,11 @@
  */
 
 /**
- * @brief   
+ * @brief   Cached recursive iteration over another Iterator
  * @author  Marcus Boerger
  * @version 1.1
+ *
+ * @See CachingIterator
  */
 class CachingRecursiveIterator extends CachingIterator implements RecursiveIterator
 {
diff --git a/ext/spl/internal/filteriterator.inc b/ext/spl/internal/filteriterator.inc
index c5f27bd47d..b3415434fe 100755
--- a/ext/spl/internal/filteriterator.inc
+++ b/ext/spl/internal/filteriterator.inc
@@ -1,7 +1,7 @@
 <?php
 
 /** @file filteriterator.inc
- * @ingroup Internal
+ * @ingroup SPL
  * @brief class FilterIterator
  * @author  Marcus Boerger
  * @date    2003 - 2004
@@ -109,6 +109,16 @@ abstract class FilterIterator implements OuterIterator
 	{
 		return $this->it;
 	}
+
+	/** Aggregate the inner iterator
+	 *
+	 * @param func    Name of method to invoke
+	 * @param params  Array of parameters to pass to method
+	 */
+	function __call($func, $params)
+	{
+		return call_user_func_array(array($this->it, $func), $params);
+	}
 }
 
 ?>
\ No newline at end of file
diff --git a/ext/spl/internal/iteratoriterator.inc b/ext/spl/internal/iteratoriterator.inc
index 03cbc9f876..68828cea53 100755
--- a/ext/spl/internal/iteratoriterator.inc
+++ b/ext/spl/internal/iteratoriterator.inc
@@ -77,6 +77,16 @@ class IteratorIterator implements OuterIterator
 		return $this->iterator->rewind();
 	}
 
+	/** Aggregate the inner iterator
+	 *
+	 * @param func    Name of method to invoke
+	 * @param params  Array of parameters to pass to method
+	 */
+	function __call($func, $params)
+	{
+		return call_user_func_array(array($this->it, $func), $params);
+	}
+
 	/** The inner iterator must be private because when this class will be
 	 * converted to c code it won't no longer be available.
 	 */
diff --git a/ext/spl/internal/limititerator.inc b/ext/spl/internal/limititerator.inc
index 0a27707079..e81874e791 100755
--- a/ext/spl/internal/limititerator.inc
+++ b/ext/spl/internal/limititerator.inc
@@ -1,7 +1,7 @@
 <?php
 
 /** @file limititerator.inc
- * @ingroup Internal
+ * @ingroup SPL
  * @brief class LimitIterator
  * @author  Marcus Boerger
  * @date    2003 - 2004
@@ -113,6 +113,16 @@ class LimitIterator implements OuterIterator
 	{
 		return $this->it;
 	}
+
+	/** Aggregate the inner iterator
+	 *
+	 * @param func    Name of method to invoke
+	 * @param params  Array of parameters to pass to method
+	 */
+	function __call($func, $params)
+	{
+		return call_user_func_array(array($this->it, $func), $params);
+	}
 }
 
 ?>
\ No newline at end of file
diff --git a/ext/spl/internal/outeriterator.inc b/ext/spl/internal/outeriterator.inc
index 712212aba3..c8a7faab2c 100755
--- a/ext/spl/internal/outeriterator.inc
+++ b/ext/spl/internal/outeriterator.inc
@@ -1,7 +1,7 @@
 <?php
 
 /** @file outeriterator.inc
- * @ingroup Internal
+ * @ingroup SPL
  * @brief class OuterIterator
  * @author  Marcus Boerger
  * @date    2003 - 2004
diff --git a/ext/spl/internal/parentiterator.inc b/ext/spl/internal/parentiterator.inc
index 9d3c59d290..114941679c 100755
--- a/ext/spl/internal/parentiterator.inc
+++ b/ext/spl/internal/parentiterator.inc
@@ -1,7 +1,7 @@
 <?php
 
 /** @file parentiterator.inc
- * @ingroup Internal
+ * @ingroup SPL
  * @brief class FilterIterator
  * @author  Marcus Boerger
  * @date    2003 - 2004
diff --git a/ext/spl/internal/recursiveiterator.inc b/ext/spl/internal/recursiveiterator.inc
index 3bb0d8d0ff..02bf1a8d91 100755
--- a/ext/spl/internal/recursiveiterator.inc
+++ b/ext/spl/internal/recursiveiterator.inc
@@ -1,7 +1,7 @@
 <?php
 
 /** @file recursiveiterator.inc
- * @ingroup Internal
+ * @ingroup SPL
  * @brief class RecursiveIterator
  * @author  Marcus Boerger
  * @date    2003 - 2004
diff --git a/ext/spl/internal/recursiveiteratoriterator.inc b/ext/spl/internal/recursiveiteratoriterator.inc
index d2c9956030..86801ac13f 100755
--- a/ext/spl/internal/recursiveiteratoriterator.inc
+++ b/ext/spl/internal/recursiveiteratoriterator.inc
@@ -1,7 +1,7 @@
 <?php
 
 /** @file recursiveiteratoriterator.inc
- * @ingroup Internal
+ * @ingroup SPL
  * @brief class RecursiveIteratorIterator
  * @author  Marcus Boerger
  * @date    2003 - 2004
diff --git a/ext/spl/internal/seekableiterator.inc b/ext/spl/internal/seekableiterator.inc
index 2cc5331aa1..81c4b01efe 100755
--- a/ext/spl/internal/seekableiterator.inc
+++ b/ext/spl/internal/seekableiterator.inc
@@ -1,7 +1,7 @@
 <?php
 
 /** @file seekableiterator.inc
- * @ingroup Internal
+ * @ingroup SPL
  * @brief class SeekableIterator
  * @author  Marcus Boerger
  * @date    2003 - 2004