SeekableIterator Interface Reference

Inheritance diagram for SeekableIterator:

Collaboration diagram for SeekableIterator:

Public Member Functions
	current ()
	key ()
	next ()
	rewind ()
	seek ($index)
	valid ()

Detailed Description

seekable iterator

Author

Marcus Boerger

Version

1.0

Since

PHP 5.0

Turns a normal iterator ino a seekable iterator. When there is a way to seek on an iterator LimitIterator can use this to efficiently rewind to offset.

Definition at line 21 of file seekableiterator.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.

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.

SeekableIterator::seek

(

$index

)

Seek to an absolute position.

Parameters

$index

position to seek to

Returns

void

The method should throw an exception if it is not possible to seek to the given position. Typically this exception should be of type OutOfBoundsException.

function seek($index);
    $this->rewind();
    $position = 0;
    while($position < $index && $this->valid()) {
        $this->next();
        $position++;
    }
    if (!$this->valid()) {
        throw new OutOfBoundsException('Invalid seek position');
    }
}

Implemented in ArrayIterator, and SplFileObject.

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:

• seekableiterator.inc