Php/docs/class.recursivetreeiterator

From Get docs

(PHP 5 >= 5.3.0, PHP 7)

Introduction

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


Class synopsis


RecursiveTreeIterator extends RecursiveIteratorIterator implements OuterIterator {

/* Inherited constants */

const int RecursiveIteratorIterator::LEAVES_ONLY = 0

const int RecursiveIteratorIterator::SELF_FIRST = 1

const int RecursiveIteratorIterator::CHILD_FIRST = 2

const int RecursiveIteratorIterator::CATCH_GET_CHILD = 16

/* Constants */

const int BYPASS_CURRENT = 4

const int BYPASS_KEY = 8

const int PREFIX_LEFT = 0

const int PREFIX_MID_HAS_NEXT = 1

const int PREFIX_MID_LAST = 2

const int PREFIX_END_HAS_NEXT = 3

const int PREFIX_END_LAST = 4

const int PREFIX_RIGHT = 5

/* Methods */

public beginChildren ( ) : void

public callHasChildren ( ) : bool

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

public current ( ) : string

public endChildren ( ) : void

public endIteration ( ) : void

public getEntry ( ) : string

public getPostfix ( ) : string

public getPrefix ( ) : string

public key ( ) : string

public next ( ) : void

public nextElement ( ) : void

public rewind ( ) : void

public setPostfix ( string $postfix ) : void

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

public valid ( ) : bool

/* Inherited methods */

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

public RecursiveIteratorIterator::next ( ) : void

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

}

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