RecursiveTreeIterator

class RecursiveTreeIterator extends RecursiveIteratorIterator (View source)

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

Constants

LEAVES_ONLY

The default. Lists only leaves in iteration.
SELF_FIRST

Lists leaves and parents in iteration with parents coming first.
CHILD_FIRST

Lists leaves and parents in iteration with leaves coming first.
CATCH_GET_CHILD

Special flag: Ignore exceptions thrown in accessing children.
BYPASS_CURRENT

BYPASS_KEY

PREFIX_LEFT

PREFIX_MID_HAS_NEXT

PREFIX_MID_LAST

PREFIX_END_HAS_NEXT

PREFIX_END_LAST

PREFIX_RIGHT

Methods

__construct(Traversable $iterator, int $flags = self::BYPASS_KEY, int $cachingIteratorFlags = CachingIterator::CATCH_GET_CHILD, int $mode = RecursiveIteratorIterator::SELF_FIRST)

Construct a RecursiveTreeIterator

void
rewind()

Rewind iterator

bool
valid()

Check validity

mixed
key()

Get the key of the current element

mixed
current()

Get current element

void
next()

Move to next element

int
getDepth()

Get the current depth of the recursive iteration

from  RecursiveIteratorIterator
RecursiveIterator|null
getSubIterator(int $level)

The current active sub iterator

from  RecursiveIteratorIterator
Iterator|null
getInnerIterator()

Get inner iterator

from  RecursiveIteratorIterator
void
beginIteration()

Begin iteration

void
endIteration()

End iteration

bool
callHasChildren()

Has children

RecursiveIterator|null
callGetChildren()

Get children

void
beginChildren()

Begin children

void
endChildren()

End children

void
nextElement()

Next element

void
setMaxDepth(int $maxDepth = -1)

Set max depth

from  RecursiveIteratorIterator
int|false
getMaxDepth()

Get max depth

from  RecursiveIteratorIterator
string
getPrefix()

Get the prefix

void
setPostfix(string $postfix)

No description

void
setPrefixPart(int $part, string $value)

Set a part of the prefix

string
getEntry()

Get current entry

string
getPostfix()

Get the postfix

Details

at line 1384
__construct(Traversable $iterator, int $flags = self::BYPASS_KEY, int $cachingIteratorFlags = CachingIterator::CATCH_GET_CHILD, int $mode = RecursiveIteratorIterator::SELF_FIRST)

Construct a RecursiveTreeIterator

Parameters

Traversable $iterator
int $flags

[optional] A bitmask of special flags. See class constants for details.
int $cachingIteratorFlags

[optional] Flags to affect the behavior of the {\RecursiveCachingIterator} used internally.
int $mode

[optional] The operation mode. See class constants for details.

at line 1396
void rewind()

Rewind iterator

Return Value

void

Any returned value is ignored.

at line 1403
bool valid()

Check validity

Return Value

bool

The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

at line 1410
mixed key()

Get the key of the current element

Return Value

mixed

TKey on success, or null on failure.

at line 1418
mixed current()

Get current element

Return Value

mixed

Can return any type.

at line 1426
void next()

Move to next element

Return Value

void

Any returned value is ignored.

in RecursiveIteratorIterator at line 320
int getDepth()

Get the current depth of the recursive iteration

Return Value

int

The current depth of the recursive iteration.

in RecursiveIteratorIterator at line 329
RecursiveIterator|null getSubIterator(int $level)

The current active sub iterator

Parameters

int $level [optional]

Return Value

RecursiveIterator|null

The current active sub iterator.

in RecursiveIteratorIterator at line 337
Iterator|null getInnerIterator()

Get inner iterator

Return Value

Iterator|null

The inner iterator for the current entry.

at line 1433
void beginIteration()

Begin iteration

Return Value

void

at line 1440
void endIteration()

End iteration

Return Value

void

at line 1447
bool callHasChildren()

Has children

Return Value

bool

true if the element has children, otherwise false

at line 1454
RecursiveIterator|null callGetChildren()

Get children

Return Value

RecursiveIterator|null

A RecursiveIterator.

at line 1461
void beginChildren()

Begin children

Return Value

void

at line 1468
void endChildren()

End children

Return Value

void

at line 1475
void nextElement()

Next element

Return Value

void

in RecursiveIteratorIterator at line 405
void setMaxDepth(int $maxDepth = -1)

Set max depth

Parameters

int $maxDepth

[optional]

The maximum allowed depth. Default -1 is used for any depth.

Return Value

void

in RecursiveIteratorIterator at line 413
int|false getMaxDepth()

Get max depth

Return Value

int|false

The maximum accepted depth, or false if any depth is allowed.

at line 1482
string getPrefix()

Get the prefix

Return Value

string

the string to place in front of current element

at line 1488
void setPostfix(string $postfix)

No description

Parameters

string $postfix

Return Value

void

at line 1502
void setPrefixPart(int $part, string $value)

Set a part of the prefix

Parameters

int $part

One of the RecursiveTreeIterator::PREFIX_* constants.

string $value

The value to assign to the part of the prefix specified in part.

Return Value

void

at line 1513
string getEntry()

Get current entry

Return Value

string

the part of the tree built for the current element.

at line 1521
string getPostfix()

Get the postfix

Return Value

string

to place after the current element.