RecursiveTreeIterator Class Reference

Inheritance diagram for RecursiveTreeIterator:

Public Member Functions
	__construct ( $iterator, int $flags=RecursiveTreeIterator::BYPASS_KEY, int $cachingIteratorFlags=CachingIterator::CATCH_GET_CHILD, int $mode=RecursiveTreeIterator::SELF_FIRST)
	key ()
	current ()
	getPrefix ()
	setPostfix (string $postfix)
	setPrefixPart (int $part, string $value)
	getEntry ()
	getPostfix ()
Public Member Functions inherited from RecursiveIteratorIterator
	__construct (Traversable $iterator, int $mode=RecursiveIteratorIterator::LEAVES_ONLY, int $flags=0)
	rewind ()
	valid ()
	next ()
	getDepth ()
	getSubIterator (?int $level=null)
	getInnerIterator ()
	beginIteration ()
	endIteration ()
	callHasChildren ()
	callGetChildren ()
	beginChildren ()
	endChildren ()
	nextElement ()
	setMaxDepth (int $maxDepth=-1)
	getMaxDepth ()

Data Fields
const int	BYPASS_CURRENT = UNKNOWN
const int	BYPASS_KEY = UNKNOWN
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
Data Fields inherited from RecursiveIteratorIterator
const int	LEAVES_ONLY = UNKNOWN
const int	SELF_FIRST = UNKNOWN
const int	CHILD_FIRST = UNKNOWN
const int	CATCH_GET_CHILD = UNKNOWN

Detailed Description

Definition at line 406 of file spl_iterators.stub.php.

Constructor & Destructor Documentation

__construct()

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

Parameters

RecursiveIterator | IteratorAggregate

$iterator

Definition at line 426 of file spl_iterators.stub.php.

Member Function Documentation

current()

RecursiveTreeIterator::current

(

)

@tentative-return-type

Reimplemented from RecursiveIteratorIterator.

Definition at line 437 of file spl_iterators.stub.php.

getEntry()

RecursiveTreeIterator::getEntry

(

)

@tentative-return-type

Definition at line 449 of file spl_iterators.stub.php.

getPostfix()

RecursiveTreeIterator::getPostfix

(

)

@tentative-return-type

Definition at line 452 of file spl_iterators.stub.php.

getPrefix()

RecursiveTreeIterator::getPrefix

(

)

@tentative-return-type

Definition at line 440 of file spl_iterators.stub.php.

key()

RecursiveTreeIterator::key

(

)

@tentative-return-type

Reimplemented from RecursiveIteratorIterator.

Definition at line 434 of file spl_iterators.stub.php.

setPostfix()

RecursiveTreeIterator::setPostfix

(

string

$postfix

)

@tentative-return-type

Definition at line 443 of file spl_iterators.stub.php.

setPrefixPart()

RecursiveTreeIterator::setPrefixPart	(	int	$part,
		string	$value )

@tentative-return-type

Definition at line 446 of file spl_iterators.stub.php.

Field Documentation

BYPASS_CURRENT

const int RecursiveTreeIterator::BYPASS_CURRENT = UNKNOWN

@cvalue RTIT_BYPASS_CURRENT

Definition at line 409 of file spl_iterators.stub.php.

BYPASS_KEY

const int RecursiveTreeIterator::BYPASS_KEY = UNKNOWN

@cvalue RTIT_BYPASS_KEY

Definition at line 411 of file spl_iterators.stub.php.

PREFIX_END_HAS_NEXT

const int RecursiveTreeIterator::PREFIX_END_HAS_NEXT = 3

Definition at line 419 of file spl_iterators.stub.php.

PREFIX_END_LAST

const int RecursiveTreeIterator::PREFIX_END_LAST = 4

Definition at line 421 of file spl_iterators.stub.php.

PREFIX_LEFT

const int RecursiveTreeIterator::PREFIX_LEFT = 0

Definition at line 413 of file spl_iterators.stub.php.

PREFIX_MID_HAS_NEXT

const int RecursiveTreeIterator::PREFIX_MID_HAS_NEXT = 1

Definition at line 415 of file spl_iterators.stub.php.

PREFIX_MID_LAST

const int RecursiveTreeIterator::PREFIX_MID_LAST = 2

Definition at line 417 of file spl_iterators.stub.php.

PREFIX_RIGHT

const int RecursiveTreeIterator::PREFIX_RIGHT = 5

Definition at line 423 of file spl_iterators.stub.php.

---

The documentation for this class was generated from the following file:

• ext/spl/spl_iterators.stub.php