RecursiveIterator Interface Reference

Inheritance diagram for RecursiveIterator:

Collaboration diagram for RecursiveIterator:

Public Member Functions
	current ()
	getChildren ()
	hasChildren ()
	key ()
	next ()
	rewind ()
	valid ()

Detailed Description

Interface for recursive iteration with RecursiveIteratorIterator.

Author

Marcus Boerger

Version

1.0

Since

PHP 5.0

Definition at line 18 of file recursiveiterator.inc.

Member Function Documentation

Iterator::current ( )

inherited

Return the current element.

Implemented in SimpleXMLIterator, RecursiveDirectoryIterator, DirectoryIterator, ArrayIterator, SplFileObject, SplDoublyLinkedList, MultipleIterator, RegexIterator, CachingIterator, RecursiveIteratorIterator, RecursiveTreeIterator, FilterIterator, LimitIterator, DualIterator, CallbackFilterIterator, IteratorIterator, SubClasses, DbaReader, AppendIterator, SplObjectStorage, IniGroups, EmptyIterator, and DirectoryTreeIterator.

RecursiveIterator::getChildren

(

)

Returns

the sub iterator for the current element

Note

The returned object must implement RecursiveIterator.

Implemented in SimpleXMLIterator, RecursiveDirectoryIterator, SplFileObject, RecursiveCachingIterator, RecursiveFilterIterator, RecursiveRegexIterator, RecursiveDualIterator, RecursiveArrayIterator, and NoCvsDirectory.

RecursiveIterator::hasChildren

(

)

Returns

whether the current element has children

Implemented in SimpleXMLIterator, RecursiveDirectoryIterator, SplFileObject, RecursiveCachingIterator, RecursiveFilterIterator, RecursiveRegexIterator, RecursiveDualIterator, and RecursiveArrayIterator.

Iterator::key ( )

inherited

Return the key of the current element.

Implemented in SimpleXMLIterator, RecursiveDirectoryIterator, DirectoryIterator, ArrayIterator, SplFileObject, MultipleIterator, SplDoublyLinkedList, CachingIterator, RecursiveTreeIterator, DualIterator, RegexIterator, DbaReader, LimitIterator, RecursiveIteratorIterator, FilterIterator, CallbackFilterIterator, AppendIterator, IteratorIterator, IniGroups, EmptyIterator, SplObjectStorage, and DirectoryFilterDots.

Iterator::next ( )

inherited

Move forward to next element.

Implemented in SimpleXMLIterator, DirectoryIterator, ArrayIterator, SplFileObject, SplDoublyLinkedList, MultipleIterator, DualIterator, RecursiveIteratorIterator, LimitIterator, IteratorIterator, AppendIterator, SplObjectStorage, FilterIterator, CachingIterator, DbaReader, EmptyIterator, RecursiveCachingIterator, SearchIterator, and InfiniteIterator.

Iterator::rewind ( )

inherited

Rewind the Iterator to the first element.

Implemented in SimpleXMLIterator, DirectoryIterator, ArrayIterator, SplFileObject, SplDoublyLinkedList, MultipleIterator, IteratorIterator, DualIterator, LimitIterator, RecursiveIteratorIterator, CachingIterator, AppendIterator, DbaReader, FilterIterator, RecursiveCachingIterator, RecursiveCompareDualIterator, SplObjectStorage, SearchIterator, EmptyIterator, and NoRewindIterator.

Iterator::valid ( )

inherited

Check if there is a current element after calls to rewind() or next().

Implemented in SimpleXMLIterator, DirectoryIterator, ArrayIterator, SplFileObject, SplDoublyLinkedList, MultipleIterator, CachingIterator, DualIterator, LimitIterator, FilterIterator, DbaReader, RecursiveIteratorIterator, IteratorIterator, AppendIterator, SearchIterator, SplObjectStorage, and EmptyIterator.

---

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

• recursiveiterator.inc