RecursiveTreeIterator (class)

The RecursiveTreeIterator class

Introduction

(PHP 5 >= 5.3.0, PHP 7)

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

Class synopsis

RecursiveTreeIterator extends RecursiveIteratorIterator implements OuterIterator {

/* Constants */

const integer BYPASS_CURRENT = 4 ;

const integer BYPASS_KEY = 8 ;

const integer PREFIX_LEFT = 0 ;

const integer PREFIX_MID_HAS_NEXT = 1 ;

const integer PREFIX_MID_LAST = 2 ;

const integer PREFIX_END_HAS_NEXT = 3 ;

const integer PREFIX_END_LAST = 4 ;

const integer PREFIX_RIGHT = 5 ;

/* Methods */

public void beginChildren ( void )

public RecursiveIterator beginIteration ( void )

public RecursiveIterator callGetChildren ( void )

public bool callHasChildren ( void )

public __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 )

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

public mixed RecursiveIteratorIterator::current ( void )

public void RecursiveIteratorIterator::endChildren ( void )

public void RecursiveIteratorIterator::endIteration ( void )

public int RecursiveIteratorIterator::getDepth ( void )

public iterator RecursiveIteratorIterator::getInnerIterator ( void )

public mixed RecursiveIteratorIterator::getMaxDepth ( void )

public RecursiveIterator RecursiveIteratorIterator::getSubIterator ([ int $level ] )

public mixed RecursiveIteratorIterator::key ( void )

public void RecursiveIteratorIterator::next ( void )

public void RecursiveIteratorIterator::nextElement ( void )

public void RecursiveIteratorIterator::rewind ( void )

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

public bool RecursiveIteratorIterator::valid ( void )

}

Predefined Constants

RecursiveTreeIterator::BYPASS_CURRENTRecursiveTreeIterator::BYPASS_KEYRecursiveTreeIterator::PREFIX_LEFTRecursiveTreeIterator::PREFIX_MID_HAS_NEXTRecursiveTreeIterator::PREFIX_MID_LASTRecursiveTreeIterator::PREFIX_END_HAS_NEXTRecursiveTreeIterator::PREFIX_END_LASTRecursiveTreeIterator::PREFIX_RIGHT

RecursiveTreeIterator::beginChildren — Begin children

RecursiveTreeIterator::beginIteration — Begin iteration

RecursiveTreeIterator::callGetChildren — Get children

RecursiveTreeIterator::callHasChildren — Has children

RecursiveTreeIterator::__construct — Construct a RecursiveTreeIterator

RecursiveTreeIterator::current — Get current element

RecursiveTreeIterator::endChildren — End children

RecursiveTreeIterator::endIteration — End iteration

RecursiveTreeIterator::getEntry — Get current entry

RecursiveTreeIterator::getPostfix — Get the postfix

RecursiveTreeIterator::getPrefix — Get the prefix

RecursiveTreeIterator::key — Get the key of the current element

RecursiveTreeIterator::next — Move to next element

RecursiveTreeIterator::nextElement — Next element

RecursiveTreeIterator::rewind — Rewind iterator

RecursiveTreeIterator::setPrefixPart — Set a part of the prefix

RecursiveTreeIterator::valid — Check validity

← RecursiveRegexIterator::hasChildren

RecursiveTreeIterator::beginChildren →

 © 1997–2017 The PHP Documentation Group

Licensed under the Creative Commons Attribution License v3.0 or later.

https://secure.php.net/manual/en/class.recursivetreeiterator.php

RecursiveTreeIterator (class)

The RecursiveTreeIterator class

Introduction

Class synopsis

Predefined Constants

Table of Contents