【PHP8.x】rewindメソッドの使い方

rewindメソッドは、イテレータを最初の要素に巻き戻すメソッドです。

このメソッドは、PHPの標準ライブラリであるSpl（Standard PHP Library）に属するRecursiveDirectoryIteratorクラスに実装されています。RecursiveDirectoryIteratorは、指定されたディレクトリとその中のサブディレクトリを再帰的に走査し、ファイルやディレクトリの情報を順番に取得するための特別なオブジェクト（イテレータ）です。rewindメソッドを呼び出すことで、現在イテレータが指している位置に関わらず、走査の対象となるディレクトリ構造の最初の項目に内部ポインタがリセットされます。

これにより、一度ディレクトリ内のすべての要素を処理した後で、再度最初から要素を取得し直したい場合や、途中で処理を中断した後に再び初期状態から開始したい場合に利用されます。例えば、あるディレクトリ内の全てのファイルを一度リストアップした後、もう一度同じイテレータを使って最初からファイル名だけを取得するといった場面で、rewindメソッドはイテレータを効率的に再利用するために役立ちます。このメソッドは、ディレクトリコンテンツの複数回の走査を可能にし、柔軟なファイルシステム操作を実現します。

Copy
1<?php
2$directoryIterator = new RecursiveDirectoryIterator('.');
3$directoryIterator->rewind();

引数なし

引数はありません

戻り値なし

戻り値はありません