PHP Conference Nagoya 2025

    The RecursiveTreeIterator class

    (PHP 5 >= 5.3.0, PHP 7, PHP 8)

    Introduction

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

    Class synopsis

    class 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 BYPASS_CURRENT;
    public const int BYPASS_KEY;
    public const int PREFIX_LEFT;
    public const int PREFIX_MID_HAS_NEXT = 1;
    public const int PREFIX_MID_LAST = 2;
    public const int PREFIX_END_HAS_NEXT = 3;
    public const int PREFIX_END_LAST = 4;
    public const int PREFIX_RIGHT = 5;
    /* Methods */
    public __construct(
        RecursiveIterator|IteratorAggregate $iterator,
        int $flags = RecursiveTreeIterator::BYPASS_KEY,
        int $cachingIteratorFlags = CachingIterator::CATCH_GET_CHILD,
        int $mode = RecursiveTreeIterator::SELF_FIRST
    )
    public beginChildren(): void
    public beginIteration(): RecursiveIterator
    public callGetChildren(): RecursiveIterator
    public callHasChildren(): bool
    public current(): mixed
    public endChildren(): void
    public endIteration(): void
    public getEntry(): string
    public getPostfix(): string
    public getPrefix(): string
    public key(): mixed
    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::beginChildren(): void
    public RecursiveIteratorIterator::beginIteration(): void
    public RecursiveIteratorIterator::callGetChildren(): ?RecursiveIterator
    public RecursiveIteratorIterator::callHasChildren(): bool
    public RecursiveIteratorIterator::current(): mixed
    public RecursiveIteratorIterator::endChildren(): void
    public RecursiveIteratorIterator::endIteration(): void
    public RecursiveIteratorIterator::getDepth(): int
    public RecursiveIteratorIterator::getInnerIterator(): RecursiveIterator
    public RecursiveIteratorIterator::getMaxDepth(): int|false
    public RecursiveIteratorIterator::getSubIterator(?int $level = null): ?RecursiveIterator
    public RecursiveIteratorIterator::key(): mixed
    public RecursiveIteratorIterator::next(): void
    public RecursiveIteratorIterator::nextElement(): void
    public RecursiveIteratorIterator::rewind(): void
    public RecursiveIteratorIterator::setMaxDepth(int $maxDepth = -1): void
    public RecursiveIteratorIterator::valid(): bool
    }

    Table of Contents

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 1 note

    up
    21
    matthieu88160
    7 years ago
    $it = new RecursiveArrayIterator(array(1, 2, array(3, 4, array(5, 6, 7), 8), 9, 10));
    $tit = new RecursiveTreeIterator($it);

    foreach( $tit as $key => $value ){
    echo $value . PHP_EOL;
    }

    /* Will output

    |-1
    |-2
    |-Array
    | |-3
    | |-4
    | |-Array
    | | |-5
    | | |-6
    | | \-7
    | \-8
    |-9
    \-10

    */
    ＋add a note
    To Top