【PHP8.x】Directory::rewind()メソッドの使い方

rewindメソッドは、Directoryクラスのインスタンスが表すディレクトリの内部ポインタを先頭に戻すメソッドです。

PHPでは、opendir()関数を使ってディレクトリを開くと、そのディレクトリ内のファイルやサブディレクトリなどのエントリを読み込むための内部ポインタが設定されます。このポインタは、readdir()関数などでエントリを一つずつ読み進めるたびに自動的に次の位置へ移動します。全てのディレクトリ内容を読み終えたり、途中で特定の処理を終えてから、再びディレクトリの最初からエントリを読み直したい場合に、この内部ポインタをリセットする必要が生じます。

rewindメソッドを呼び出すと、現在内部ポインタがどこを指しているかに関わらず、そのポインタがディレクトリの最初の位置に戻されます。これにより、再度readdir()関数を呼び出した際には、ディレクトリ内の最初のファイルやサブディレクトリから再び読み込みを開始できるようになります。この機能は、ディレクトリ内のエントリを複数回処理する必要がある場合や、特定の条件に基づいてディレクトリ内容を繰り返し参照する場面で特に役立ちます。rewindメソッドは引数を取らず、特に値を返しませんが、ディレクトリの読み込み状態を初期化する重要な役割を担っています。

Copy
1<?php
2$directoryObject = opendir('.'); // Directory オブジェクトを生成
3if ($directoryObject) {
4    $directoryObject->rewind();
5    closedir($directoryObject);
6}
7?>

引数なし

引数はありません

戻り値なし

戻り値はありません