Iterator::rewind

Rewind the Iterator to the first element

Description

public void Iterator::rewind()

Rewinds back to the first element of the Iterator.

Note:

This is the first method called when starting a foreach loop. It will not be executed after foreach loops.

As foreach always calls rewind before starting iteration, manually advancing the iterator position (for example via SplFileObject::seek) will be reset. To iterate without rewinding the iterator, wrap it in a NoRewindIterator.

Parameters

This function has no parameters.

Return Values

Any returned value is ignored.