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

Copy
1<?php
2
3/**
4 * FilesystemIterator::rewind() の使用方法をデモンストレーションします。
5 *
6 * この関数は、FilesystemIterator がどのようにリワインド（巻き戻し）され、
7 * 繰り返し処理を最初から再開できるかを示します。
8 * FilesystemIterator は「リワインド可能なイテレータ」の一種です。
9 * 通常の PHP ジェネレータ（'yield' を使用して作成されるもの）は、
10 * デフォルトではリワインド可能ではないため、この特性は重要です。
11 */
12function demonstrateFilesystemIteratorRewind(): void
13{
14    // 1. セットアップ: 一時ディレクトリとダミーファイルを作成します。
15    // これにより、サンプルコードが自己完結し、どこでも実行可能になります。
16    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('php_rewind_demo_', true);
17    if (!mkdir($tempDir) && !is_dir($tempDir)) {
18        echo "エラー: 一時ディレクトリ '$tempDir' を作成できませんでした。\n";
19        return;
20    }
21
22    // テスト用のファイルを作成
23    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file1.txt', 'Content 1');
24    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file2.txt', 'Content 2');
25    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file3.txt', 'Content 3');
26
27    echo "--- ディレクトリ '$tempDir' 内のファイル: ---\n";
28
29    try {
30        // 2. FilesystemIterator のインスタンスを作成します。
31        // FilesystemIterator は、指定されたパス内のファイルやディレクトリを反復処理します。
32        // FilesystemIterator::SKIP_DOTS は '.' と '..' エントリをスキップするために使用されます。
33        $iterator = new FilesystemIterator($tempDir, FilesystemIterator::SKIP_DOTS);
34
35        echo "イテレータの最初のパス (最初の繰り返し):\n";
36        $i = 1;
37        foreach ($iterator as $fileInfo) {
38            echo "  [パス1, 項目 " . $i++ . "] " . $fileInfo->getFilename() . "\n";
39        }
40
41        echo "\n--- イテレータをリワインドしています ---\n";
42        // 3. rewind() メソッドを呼び出し、イテレータを初期状態にリセットします。
43        // rewind() を呼び出した後、イテレータは最初から再度トラバースする準備が整います。
44        $iterator->rewind();
45
46        echo "rewind() 後のイテレータの2番目のパス (2回目の繰り返し):\n";
47        $j = 1;
48        foreach ($iterator as $fileInfo) {
49            echo "  [パス2, 項目 " . $j++ . "] " . $fileInfo->getFilename() . "\n";
50        }
51
52    } catch (UnexpectedValueException $e) {
53        echo "エラー: " . $e->getMessage() . "\n";
54    } finally {
55        // 4. クリーンアップ: 一時ファイルとディレクトリを削除します。
56        if (is_dir($tempDir)) {
57            foreach (new FilesystemIterator($tempDir) as $file) {
58                unlink($file->getPathname());
59            }
60            rmdir($tempDir); // ディレクトリを削除
61            echo "\n一時ディレクトリ '$tempDir' をクリーンアップしました。\n";
62        }
63    }
64}
65
66// デモンストレーション関数を実行します。
67demonstrateFilesystemIteratorRewind();

FilesystemIterator::rewind()は、PHP 8 の FilesystemIterator クラスに属するメソッドです。このメソッドは引数を受け取らず、戻り値もありません。

FilesystemIteratorは、指定されたディレクトリ内のファイルやディレクトリを順に処理するためのイテレータです。一度すべての項目を処理し終えたイテレータは通常、その状態が終了点に達しています。しかし、rewind()メソッドを呼び出すことで、イテレータの内部ポインタをリセットし、再度最初のエントリから処理を開始できるように巻き戻すことができます。

これは、FilesystemIteratorが「リワインド可能なイテレータ」であるという重要な特性を示しています。通常のPHPジェネレータ（yieldキーワードで作成されるもの）は、一度生成を完了すると通常は巻き戻して最初から再実行することはできません。そのため、FilesystemIteratorのように複数の処理で同じデータソースを最初から反復したい場合にrewind()は非常に役立ちます。

提供されたサンプルコードでは、まず一時ディレクトリを作成し、複数のファイルを配置します。その後、FilesystemIteratorを使用してディレクトリ内のファイルを一度リストアップします。処理が終了した後、$iterator->rewind()を呼び出すことでイテレータを初期状態に戻しています。これにより、続くforeachループで再びディレクトリ内のファイルを最初から順に処理できる様子が示されています。最後に、作成した一時ディレクトリとファイルを適切にクリーンアップしています。このrewind()の機能により、同じイテレータインスタンスを使って効率的に複数回の走査が可能となります。

Copy
1<?php
2
3/**
4 * FilesystemIterator::rewind() メソッドの使用方法を示すサンプルコードです。
5 * FilesystemIterator は、ディレクトリ内のファイルやサブディレクトリを順に処理するためのイテレータです。
6 * rewind() メソッドは、イテレータの内部ポインタを最初の要素にリセットします。
7 * これにより、一度処理を開始したイテレータを最初から再開したい場合に利用できます。
8 *
9 * （補足）PHPの配列には FilesystemIterator のような 'rewind' メソッドは直接ありませんが、
10 * 配列の内部ポインタをリセットする `reset()` 関数が似た概念を持ちます。
11 * このサンプルは FilesystemIterator::rewind() の具体的な挙動に焦点を当てています。
12 */
13function demonstrateFilesystemIteratorRewind(): void
14{
15    // 1. デモンストレーション用の一時ディレクトリを作成
16    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_rewind_demo_' . uniqid();
17    if (!mkdir($tempDir) && !is_dir($tempDir)) {
18        echo "エラー: 一時ディレクトリを作成できませんでした: $tempDir\n";
19        return;
20    }
21
22    // 2. 一時ディレクトリ内にサンプルファイルを作成
23    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file1.txt', 'コンテンツ1');
24    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file2.txt', 'コンテンツ2');
25    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file3.txt', 'コンテンツ3');
26
27    echo "--- 最初のイテレーション（途中で中断）---\n";
28
29    // 3. FilesystemIterator をインスタンス化 ('.' と '..' をスキップ)
30    $iterator = new FilesystemIterator($tempDir, FilesystemIterator::SKIP_DOTS);
31
32    // 4. イテレータを一部処理し、途中で中断してポインタを進める
33    $processedCount = 0;
34    foreach ($iterator as $fileInfo) {
35        echo "ファイル名: " . $fileInfo->getFilename() . "\n";
36        $processedCount++;
37        if ($processedCount >= 2) {
38            echo "（2つのファイルを処理後、イテレーションを中断しました）\n";
39            break; // 途中でループを抜けてイテレータのポインタを残す
40        }
41    }
42
43    echo "\n--- rewind() を呼び出し中 ---\n";
44    // 5. rewind() メソッドを呼び出し、イテレータの内部ポインタを最初の要素にリセット
45    $iterator->rewind();
46
47    echo "\n--- rewind() 呼び出し後、再度イテレーション ---\n";
48    // 6. ポインタがリセットされたため、最初から再度イテレーションが開始されることを確認
49    foreach ($iterator as $fileInfo) {
50        echo "ファイル名: " . $fileInfo->getFilename() . "\n";
51    }
52
53    echo "\n--- クリーンアップ ---\n";
54
55    // 7. 作成した一時ファイルとディレクトリを削除
56    foreach (new FilesystemIterator($tempDir, FilesystemIterator::SKIP_DOTS) as $file) {
57        unlink($file->getPathname());
58    }
59    rmdir($tempDir);
60    echo "一時ディレクトリ '$tempDir' とそのファイルは削除されました。\n";
61}
62
63// 関数を実行
64demonstrateFilesystemIteratorRewind();

PHPのFilesystemIteratorクラスは、ディレクトリ内のファイルやサブディレクトリを順番に処理するためのイテレータ機能を提供します。このFilesystemIteratorに属するrewind()メソッドは、イテレータが現在指している内部ポインタを、その最初の要素にリセットする役割を持ちます。

このメソッドは引数を一切取らず、また戻り値もありません。そのため、呼び出すだけでイテレータの状態を初期位置に戻すことができます。一度ディレクトリ内の要素の処理を開始し、途中で中断したイテレータを、再び最初から処理し直したい場合に特に有用です。

サンプルコードでは、まず一時ディレクトリに作成されたファイルをFilesystemIteratorで一部だけ処理し、途中でイテレータのポインタを進めます。その後、rewind()メソッドを呼び出すことでポインタを最初の要素に戻し、再度イテレーションを開始すると、最初からすべてのファイルが順に処理される様子が示されています。

補足として、PHPの配列にはrewind()メソッドは直接ありませんが、配列の内部ポインタを最初の要素にリセットするreset()関数が同様の目的で使用されます。FilesystemIterator::rewind()は、このイテレータに特化したリセット機能として機能します。