Public Member Functions | |
| current () | |
| key () | |
| next () | |
| rewind () | |
| valid () | |
Detailed Description
Basic iterator.
- Since
- PHP 5.0
Interface for external iterators or objects that can be iterated themselves internally.
- Note
- This is an engine internal interface.
Member Function Documentation
| Iterator::current | ( | ) |
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.
| Iterator::key | ( | ) |
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 | ( | ) |
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 | ( | ) |
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 | ( | ) |
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:
