The RecursiveTreeIterator class

Introduction

Allows iterating over a RecursiveIterator to generate an ASCII graphic tree.

Class synopsis

RecursiveTreeIterator
extends RecursiveIteratorIterator
/* Inherited constants */
public const int RecursiveIteratorIterator::LEAVES_ONLY;
public const int RecursiveIteratorIterator::SELF_FIRST;
public const int RecursiveIteratorIterator::CHILD_FIRST;
public const int RecursiveIteratorIterator::CATCH_GET_CHILD;
/* Constants */
public const int RecursiveTreeIterator::BYPASS_CURRENT;
public const int RecursiveTreeIterator::BYPASS_KEY;
public const int RecursiveTreeIterator::PREFIX_LEFT;
public const int RecursiveTreeIterator::PREFIX_MID_HAS_NEXT = 1;
public const int RecursiveTreeIterator::PREFIX_MID_LAST = 2;
public const int RecursiveTreeIterator::PREFIX_END_HAS_NEXT = 3;
public const int RecursiveTreeIterator::PREFIX_END_LAST = 4;
public const int RecursiveTreeIterator::PREFIX_RIGHT = 5;
/* Methods */
public RecursiveTreeIterator::__construct(
    RecursiveIteratorIteratorAggregate $iterator,
    int $flags = RecursiveTreeIterator::BYPASS_KEY,
    int $cachingIteratorFlags = CachingIterator::CATCH_GET_CHILD,
    int $mode = RecursiveTreeIterator::SELF_FIRST
)
public void RecursiveTreeIterator::beginChildren()
public RecursiveIterator RecursiveTreeIterator::beginIteration()
public RecursiveIterator RecursiveTreeIterator::callGetChildren()
public bool RecursiveTreeIterator::callHasChildren()
public mixed RecursiveTreeIterator::current()
public void RecursiveTreeIterator::endChildren()
public void RecursiveTreeIterator::endIteration()
public string RecursiveTreeIterator::getEntry()
public string RecursiveTreeIterator::getPostfix()
public string RecursiveTreeIterator::getPrefix()
public mixed RecursiveTreeIterator::key()
public void RecursiveTreeIterator::next()
public void RecursiveTreeIterator::nextElement()
public void RecursiveTreeIterator::rewind()
public void RecursiveTreeIterator::setPostfix(string $postfix)
public void RecursiveTreeIterator::setPrefixPart(int $part, string $value)
public bool RecursiveTreeIterator::valid()
/* Inherited methods */
public void beginChildren()
public void beginIteration()
public RecursiveIteratornull callGetChildren()
public bool callHasChildren()
public mixed current()
public void endChildren()
public void endIteration()
public int getDepth()
public RecursiveIterator getInnerIterator()
public intfalse getMaxDepth()
public RecursiveIteratornull getSubIterator(intnull $level = null)
public mixed key()
public void next()
public void nextElement()
public void rewind()
public void setMaxDepth(int $maxDepth = -1)
public bool valid()

Predefined Constants

RecursiveTreeIterator::BYPASS_CURRENT

RecursiveTreeIterator::BYPASS_KEY

RecursiveTreeIterator::PREFIX_LEFT

RecursiveTreeIterator::PREFIX_MID_HAS_NEXT

RecursiveTreeIterator::PREFIX_MID_LAST

RecursiveTreeIterator::PREFIX_END_HAS_NEXT

RecursiveTreeIterator::PREFIX_END_LAST

RecursiveTreeIterator::PREFIX_RIGHT

Table of Contents