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

Copy
1<?php
2
3/**
4 * GlobIteratorのrewindメソッドの使用例を示す関数です。
5 * GlobIteratorはファイルシステムを反復処理するためのイテレータで、
6 * rewind()メソッドを使うことで、イテレータを先頭に戻し、複数回反復処理を行うことができます。
7 * これは、PHPの通常のジェネレータとは異なり、「巻き戻し可能（rewindable）」な特性を持つことを示します。
8 */
9function demonstrateGlobIteratorRewind(): void
10{
11    echo "--- GlobIterator::rewind() メソッドのデモンストレーション ---\n\n";
12
13    // サンプル用に一時ディレクトリとファイルを作成します。
14    // このディレクトリはスクリプト終了時に削除されます。
15    $tempDir = __DIR__ . '/temp_glob_files';
16    if (!is_dir($tempDir)) {
17        mkdir($tempDir);
18    }
19    file_put_contents($tempDir . '/item1.txt', 'コンテンツ1');
20    file_put_contents($tempDir . '/item2.log', 'コンテンツ2');
21    file_put_contents($tempDir . '/item3.txt', 'コンテンツ3');
22
23    // GlobIteratorのインスタンスを作成します。
24    // 指定されたパターン（例: .txt または .log ファイル）にマッチするファイルを探します。
25    // ここでは全てのファイル（*）を対象とします。
26    $iterator = new GlobIterator($tempDir . '/*');
27
28    // イテレータが空の場合、処理を終了します。
29    if (!$iterator->valid()) {
30        echo "指定されたパターン '{$tempDir}/*' にマッチするファイルが見つかりませんでした。\n";
31        // 一時ディレクトリのクリーンアップ
32        array_map('unlink', glob($tempDir . '/*'));
33        rmdir($tempDir);
34        return;
35    }
36
37    echo "--- 1回目のイテレーション（反復処理）---\n";
38    // 最初のイテレーションでは、ディレクトリ内のファイルを順に処理します。
39    foreach ($iterator as $file) {
40        echo "発見したファイル: " . $file->getFilename() . "\n";
41    }
42
43    echo "\n--- rewind() メソッドを呼び出します ---\n";
44    // rewind() メソッドを呼び出すことで、イテレータの内部ポインタが先頭にリセットされます。
45    // これにより、もう一度最初からイテレーションを行う準備ができます。
46    $iterator->rewind();
47    echo "イテレータが先頭に巻き戻されました。\n";
48
49    echo "\n--- 2回目のイテレーション（反復処理）---\n";
50    // rewind()の後、もう一度イテレーションを行うと、再度最初からファイルが列挙されます。
51    // これは、GlobIteratorが「巻き戻し可能（rewindable）」であることを示しています。
52    foreach ($iterator as $file) {
53        echo "再度発見したファイル: " . $file->getFilename() . "\n";
54    }
55
56    echo "\n--- デモンストレーション終了 ---\n";
57
58    // 作成した一時ファイルとディレクトリをクリーンアップします。
59    array_map('unlink', glob($tempDir . '/*')); // ディレクトリ内のファイルを全て削除
60    rmdir($tempDir); // 空になったディレクトリを削除
61}
62
63// 関数を実行してデモンストレーションを開始します。
64demonstrateGlobIteratorRewind();

PHP 8のGlobIterator::rewind()メソッドは、ファイルシステム上のファイルやディレクトリを繰り返し処理するGlobIteratorの内部ポインタを先頭にリセットするために使用されます。このメソッドには引数がなく、戻り値もありません（void）。

GlobIteratorは、指定されたパターンに合致するファイルを効率的に反復処理（イテレーション）するためのPHPのイテレータです。通常、イテレータは一度最後まで処理すると、再度最初から処理するには新しくインスタンスを作り直す必要があります。しかし、rewind()メソッドを呼び出すことで、GlobIteratorは既存のインスタンスをそのまま利用して、内部の処理位置を初期状態（先頭）に戻すことができます。

これにより、同じGlobIteratorインスタンスを使って、ファイルリストに対して複数回にわたる反復処理を最初から実行することが可能になります。これは、PHPの通常のジェネレータが一度しかイテレーションできないのに対し、GlobIteratorが「巻き戻し可能（rewindable）」な特性を持つことを示しています。

サンプルコードでは、まず一時ディレクトリにファイルを作成し、GlobIteratorで一度ファイルを列挙します。その後、$iterator->rewind()を呼び出すことでイテレータを先頭に戻し、再度ファイルを列挙できることを実演しています。この機能は、同じデータセットに対して異なる処理を複数回行いたい場合に非常に便利です。最後に、作成した一時ファイルとディレクトリをクリーンアップしてデモンストレーションを終了します。

Copy
1<?php
2
3// このサンプルコードを実行するために、一時的なテスト用ファイルを作成します。
4// 実際のファイルが存在しない環境でも動作するようにするためです。
5$testDir = __DIR__ . DIRECTORY_SEPARATOR . 'test_files_for_rewind';
6if (!is_dir($testDir)) {
7    mkdir($testDir);
8}
9file_put_contents($testDir . DIRECTORY_SEPARATOR . 'data1.txt', 'This is data file 1.');
10file_put_contents($testDir . DIRECTORY_SEPARATOR . 'data2.txt', 'This is data file 2.');
11file_put_contents($testDir . DIRECTORY_SEPARATOR . 'data3.txt', 'This is data file 3.');
12
13// GlobIterator を使用して、指定されたパターンに一致するファイル（パス）をイテレートします。
14// これはファイルシステム上の要素を「配列のように」順番に処理するのに似ています。
15// ここでは、一時的に作成したディレクトリ内の.txtファイルを対象とします。
16$iterator = new GlobIterator($testDir . DIRECTORY_SEPARATOR . '*.txt');
17
18echo "--- 最初のイテレーション（ファイル一覧）---\n";
19// foreach ループを使ってイテレータの要素を順番に処理します。
20// 各要素は SplFileInfo オブジェクトで、ファイルに関する情報を提供します。
21foreach ($iterator as $fileInfo) {
22    echo "ファイル名: " . $fileInfo->getFilename() . "\n";
23}
24
25echo "\n--- rewind() の呼び出し ---\n";
26// rewind() メソッドを呼び出すことで、イテレータの内部ポインタを先頭（最初の要素）に戻します。
27// これにより、もう一度イテレーションを開始する際に最初から要素を処理できるようになります。
28$iterator->rewind();
29echo "イテレータを先頭に戻しました。\n";
30
31echo "\n--- 2回目のイテレーション（ファイル一覧）---\n";
32// rewind() の後、再度 foreach ループを実行すると、
33// イテレータが先頭に戻っているため、最初のイテレーションと同じ順序でファイルが処理されます。
34foreach ($iterator as $fileInfo) {
35    echo "ファイル名: " . $fileInfo->getFilename() . "\n";
36}
37
38// サンプルコード実行後に作成したテスト用ファイルをクリーンアップします。
39unlink($testDir . DIRECTORY_SEPARATOR . 'data1.txt');
40unlink($testDir . DIRECTORY_SEPARATOR . 'data2.txt');
41unlink($testDir . DIRECTORY_SEPARATOR . 'data3.txt');
42rmdir($testDir);
43
44?>

PHP 8のGlobIterator::rewindメソッドは、ファイルシステム上で特定のパターンに一致するファイルやディレクトリの集合体を順に処理するためのGlobIteratorクラスにおいて、その処理位置を最初の要素に戻す役割を持つメソッドです。GlobIteratorは、一度に大量のファイルパスなどを効率的に扱う際に利用されるオブジェクトです。例えば、一度すべてのファイル名を読み終えた後、もう一度最初からファイル名を処理し直したい場合にrewind()メソッドを使用します。このメソッドには引数がなく、単純に$iterator->rewind();のように呼び出すだけで機能します。また、戻り値はvoidであり、メソッドが値を返すのではなく、GlobIteratorオブジェクトの内部状態（処理する要素の現在の位置）を先頭に戻すという副作用を持つことを示します。これにより、サンプルコードが示すように、一度ファイルの一覧表示を行った後にrewind()を呼び出すことで、同じファイルの一覧を再度最初から取得し直すことが可能になります。