The RecursiveTreeIterator class

Introduction

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

Class synopsis

RecursiveTreeIterator extends RecursiveIteratorIterator implements OuterIterator , Traversable , Iterator {

/* Constants */

const integer RecursiveTreeIterator::BYPASS_CURRENT = 4 ;

const integer RecursiveTreeIterator::BYPASS_KEY = 8 ;

const integer RecursiveTreeIterator::PREFIX_LEFT = 0 ;

const integer RecursiveTreeIterator::PREFIX_MID_HAS_NEXT = 1 ;

const integer RecursiveTreeIterator::PREFIX_MID_LAST = 2 ;

const integer RecursiveTreeIterator::PREFIX_END_HAS_NEXT = 3 ;

const integer RecursiveTreeIterator::PREFIX_END_LAST = 4 ;

const integer RecursiveTreeIterator::PREFIX_RIGHT = 5 ;

/* Methods */

public void beginChildren ( void )

public RecursiveIterator beginIteration ( void )

public RecursiveIterator callGetChildren ( void )

public bool callHasChildren ( void )

__construct ( RecursiveIterator|IteratorAggregate $it [, int $flags = RecursiveTreeIterator::BYPASS_KEY [, int $cit_flags = CachingIterator::CATCH_GET_CHILD [, int $mode = RecursiveIteratorIterator::SELF_FIRST ]]] )

public string current ( void )

public void endChildren ( void )

public void endIteration ( void )

public string getEntry ( void )

public void getPostfix ( void )

public string getPrefix ( void )

public string key ( void )

public void next ( void )

public void nextElement ( void )

public void rewind ( void )

public void setPrefixPart ( int $part , string $value )

public bool valid ( void )

/* Inherited methods */

public void RecursiveIteratorIterator::beginChildren ( void )

public void RecursiveIteratorIterator::beginIteration ( void )

public RecursiveIterator RecursiveIteratorIterator::callGetChildren ( void )

public bool RecursiveIteratorIterator::callHasChildren ( void )

RecursiveIteratorIterator::__construct ( Traversable $iterator [, int $mode = LEAVES_ONLY [, int $flags = 0 ]] )

mixed RecursiveIteratorIterator::current ( void )

public void RecursiveIteratorIterator::endChildren ( void )

public void RecursiveIteratorIterator::endIteration ( void )

int RecursiveIteratorIterator::getDepth ( void )

public iterator RecursiveIteratorIterator::getInnerIterator ( void )

public mixed RecursiveIteratorIterator::getMaxDepth ( void )

RecursiveIterator RecursiveIteratorIterator::getSubIterator ( void )

mixed RecursiveIteratorIterator::key ( void )

void RecursiveIteratorIterator::next ( void )

public void RecursiveIteratorIterator::nextElement ( void )

void RecursiveIteratorIterator::rewind ( void )

public void RecursiveIteratorIterator::setMaxDepth ([ string $max_depth = -1 ] )

bool RecursiveIteratorIterator::valid ( void )

}

Predefined Constants

RecursiveTreeIterator Node Types

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