- MFH Added RecursiveTreeIterator

Author: helly25

NEWS

@@ -117,6 +117,7 @@ PHP                                                                        NEWS
   . Added new parameter $prepend to spl_autoload_register(). (Etienne)
   . Added FixedArray. (Etienne, Tony)
   . Added delaying exceptions in SPL's autoload mechanism. (Marcus)
+  . Added RecursiveTreeIterator. (Arnaud, Marcus)
 
 - Improved Zend Engine:
   . Added "compact" handler for Zend MM storage. (Dmitry)

ext/spl/examples/recursivetreeiterator.inc renamed to ext/spl/internal/recursivetreeiterator.inc

@@ -10,11 +10,12 @@
  */
 
 
-/** @ingroup Examples
+/** @ingroup SPL
  * @brief   RecursiveIteratorIterator to generate ASCII graphic trees for the
  *          entries in a RecursiveIterator
  * @author  Marcus Boerger, Johannes Schlueter
- * @version 1.0
+ * @version 1.1
+ * @since   PHP 5.3
  */
 class RecursiveTreeIterator extends RecursiveIteratorIterator
 {
@@ -35,16 +36,34 @@ class RecursiveTreeIterator extends RecursiveIteratorIterator
 		$this->rit_flags = $rit_flags;
 	}
 
-	/**  Prefix strings used in getPrefix()
-	 *
-	 * 0: prefix used to start elements
-	 * 1: prefix used if $level < depth and hasNext($level) == true
-	 * 2: prefix used if $level < depth and hasNext($level) == false
-	 * 3: prefix used if $level == depth and hasNext($level) == true
-	 * 4: prefix used if $level == depth and hasNext($level) == false
-	 * 5: prefix used right in front of the current element
+	private $prefix = array(0=>'', 1=>'| ', 2=>'  ', 3=>'|-', 4=>'\-', 5=>'');
+
+	/** Prefix used to start elements. */
+	const PREFIX_LEFT         = 0;
+	/** Prefix used if $level < depth and hasNext($level) == true. */
+	const PREFIX_MID_HAS_NEXT = 1;
+	/** Prefix used if $level < depth and hasNext($level) == false. */
+	const PREFIX_MID_LAST     = 2;
+	/** Prefix used if $level == depth and hasNext($level) == true. */
+	const PREFIX_END_HAS_NEXT = 3;
+	/** Prefix used if $level == depth and hasNext($level) == false. */
+	const PREFIX_END_LAST     = 4;
+	/** Prefix used right in front of the current element. */
+	const PREFIX_RIGHT        = 5;
+
+	/**
+	 * Set prefix part as used in getPrefix() and stored in $prefix.
+	 * @param $part   any PREFIX_* const.
+	 * @param $value  new prefix string for specified part.
+	 * @throws OutOfRangeException if 0 > $part or $part > 5.
 	 */
-	public $prefix = array(0=>'', 1=>'| ', 2=>'  ', 3=>'|-', 4=>'\-', 5=>'');
+	function setPrefixPart($part, $value)
+	{
+		if (0 > $part || $part > 5) {
+			throw new OutOfRangeException();
+		}
+		$this->prefix[$part] = (string)$value;
+	}
 
 	/** @return string to place in front of current element
 	 */

ext/spl/spl.php

@@ -35,6 +35,7 @@
  * - interface RecursiveIterator extends Iterator
  * - interface OuterIterator extends Iterator
  * - class RecursiveIteratorIterator implements OuterIterator
+ * - class RecursiveTreeIterator extends RecursiveIteratorIterator
  * - abstract class FilterIterator implements OuterIterator
  * - class ParentIterator extends FilterIterator implements RecursiveIterator
  * - interface SeekableIterator extends Iterator
@@ -55,7 +56,7 @@
  *
  * - class SplFileInfo
  * - class DirectoryIterator extends SplFileInfo implements Iterator
- * - class filesystemIterator extends DirectoryIterator
+ * - class FilesystemIterator extends DirectoryIterator
  * - class RecursiveDirectoryIterator extends FilesystemIterator implements RecursiveIterator
  * - class GlobIterator extends FilesystemIterator implements Countable
  * - class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIterator
@@ -1132,7 +1133,7 @@ interface SplObserver
 {
 	/** Called from the subject (i.e. when it's value has changed).
 	 * @param $subject the callee
-	 :*/
+	 */
 	function update(SplSubject $subject);
 }