【PHP8.x】GlobIterator::NEW_CURRENT_AND_KEY定数の使い方

Copy
1<?php
2
3// 一時ディレクトリとファイルを作成し、GlobIteratorの対象とします。
4function setupTempFiles(): void
5{
6    $dir = 'temp_glob_dir';
7    if (!is_dir($dir)) {
8        mkdir($dir, 0777, true);
9    }
10    file_put_contents($dir . '/file1.txt', 'Content A');
11    file_put_contents($dir . '/file2.log', 'Content B'); // .logファイルは GlobIterator のパターンにマッチしません
12    file_put_contents($dir . '/file3.txt', 'Content C');
13}
14
15// 一時ファイルをクリーンアップします。
16function cleanupTempFiles(): void
17{
18    $dir = 'temp_glob_dir';
19    if (is_dir($dir)) {
20        array_map('unlink', glob($dir . '/*'));
21        rmdir($dir);
22    }
23}
24
25/**
26 * GlobIterator と IteratorIterator::NEW_CURRENT_AND_KEY 定数の使用例。
27 *
28 * PHPの標準ライブラリでは、`NEW_CURRENT_AND_KEY` 定数は `IteratorIterator`
29 * または `RecursiveIteratorIterator` クラスに定義されています。
30 * この定数は、イテレータをラップする際に、ラッパーイテレータが内部イテレータの
31 * `current()` と `key()` の値を直接返すように指定するために使用されます。
32 *
33 * ここでは、`GlobIterator` を内部イテレータとして使用し、その挙動を示します。
34 */
35function demonstrateGlobIteratorWithNewCurrentAndKey(): void
36{
37    setupTempFiles();
38
39    echo "--- GlobIterator を直接使用した場合のキーと値 ---\n";
40    // GlobIterator は指定されたパターンに一致するファイルを反復処理します。
41    // current() は SplFileInfo オブジェクトを、key() はファイルパスを返します。
42    $globIterator = new GlobIterator('temp_glob_dir/*.txt');
43
44    foreach ($globIterator as $key => $fileInfo) {
45        /* @var SplFileInfo $fileInfo */
46        echo "キー (ファイルパス): {$key}, 値 (SplFileInfoオブジェクトのファイル名): {$fileInfo->getFilename()}\n";
47    }
48    echo "\n";
49
50    echo "--- IteratorIterator で GlobIterator をラップし、NEW_CURRENT_AND_KEY を指定した場合 ---\n";
51    // `IteratorIterator::NEW_CURRENT_AND_KEY` は、ラッパーイテレータの `current()` と `key()` が
52    // 内部イテレータ (`GlobIterator`) の `current()` と `key()` をそのまま返すことを保証します。
53    //
54    // 注意: 多くの単純なイテレータを `IteratorIterator` でラップする場合、
55    // この動作はデフォルトと同じであるため、目に見える変化はないかもしれません。
56    // しかし、このフラグは動作を明示的に指定するために使用されます。
57
58    // GlobIteratorは一度ループするとポインタが終端に達するため、
59    // IteratorIteratorでラップする前にリワインド (巻き戻し) する必要があります。
60    $globIterator->rewind();
61    $wrappedIterator = new IteratorIterator($globIterator, IteratorIterator::NEW_CURRENT_AND_KEY);
62
63    foreach ($wrappedIterator as $key => $fileInfo) {
64        /* @var SplFileInfo $fileInfo */
65        echo "キー (ファイルパス): {$key}, 値 (SplFileInfoオブジェクトのファイル名): {$fileInfo->getFilename()}\n";
66    }
67    echo "\n";
68
69    cleanupTempFiles();
70}
71
72// サンプルコードを実行します。
73demonstrateGlobIteratorWithNewCurrentAndKey();

PHP 8で提供されるNEW_CURRENT_AND_KEYは、IteratorIteratorやRecursiveIteratorIteratorといった、他のイテレータをラップするクラスで使用される定数です。この定数は引数を持たず、値そのものであるため戻り値もありません。

この定数を指定すると、ラッパーイテレータが内部でラップしているイテレータのcurrent()メソッドとkey()メソッドが返す値を、自身のcurrent()とkey()としてそのまま提供するようになります。例えば、GlobIteratorをIteratorIteratorでラップする際にNEW_CURRENT_AND_KEYを指定すると、IteratorIteratorはGlobIteratorが返すファイル情報（SplFileInfoオブジェクト）とファイルパスを、変更せずにそのまま自身の値とキーとして利用者に提供します。これにより、ラップされたイテレータの本来のキーと値のペアを維持したまま、さらに別の処理を加えたい場合に、その動作を明示的に指定することができます。

Copy
1<?php
2
3// このスクリプトが存在するディレクトリに、テスト用のサブディレクトリを作成します。
4$testDir = __DIR__ . '/test_glob_iterator_files';
5if (!is_dir($testDir)) {
6    mkdir($testDir);
7}
8
9// テストファイルを作成します。
10// GlobIteratorで走査されるファイルです。
11file_put_contents($testDir . '/document.txt', 'これはテキストファイルです。');
12file_put_contents($testDir . '/log.log', 'これはログファイルです。');
13file_put_contents($testDir . '/another_doc.txt', '別のテキストファイルです。');
14
15/**
16 * GlobIterator と GlobIterator::NEW_CURRENT_AND_KEY 定数の使用例を示す関数です。
17 *
18 * GlobIterator::NEW_CURRENT_AND_KEY は、イテレータが反復処理を行う際に、
19 * ファイルの「キー」（通常はインデックスまたはパス名）としてファイルのパス名を、
20 * 「現在の要素」（値）としてファイルに関する詳細情報を持つ SplFileInfo オブジェクトを
21 * 返すように設定する特別なフラグです。
22 *
23 * @param string $path GlobIteratorで走査するファイルパスパターン（例: '/path/*.txt'）
24 */
25function demonstrateGlobIteratorWithNewCurrentAndKey(string $path): void
26{
27    echo "--- GlobIterator::NEW_CURRENT_AND_KEY の使用例 ---\n";
28    echo "検索パターン: " . $path . "\n\n";
29
30    try {
31        // GlobIterator のインスタンスを 'new' キーワードと括弧を使って作成します。
32        // 第2引数に GlobIterator::NEW_CURRENT_AND_KEY 定数を指定することで、
33        // 反復処理の挙動をカスタマイズします。これが「php new 括弧」の典型的な使い方です。
34        $iterator = new GlobIterator($path, GlobIterator::NEW_CURRENT_AND_KEY);
35
36        // 指定されたパスにファイルが見つからない場合の処理です。
37        if (!$iterator->valid()) {
38            echo "  指定されたパターンに合致するファイルが見つかりませんでした。\n";
39            return;
40        }
41
42        // イテレータを foreach ループで処理します。
43        // GlobIterator::NEW_CURRENT_AND_KEY が設定されているため、
44        // $key にはファイル全体のパス（例: /path/to/document.txt）が入り、
45        // $fileInfo にはファイルに関する詳細情報（ファイル名、サイズ、更新日時など）を
46        // 取得できる SplFileInfo オブジェクトが入ります。
47        foreach ($iterator as $key => $fileInfo) {
48            echo "  キー (ファイルパス): " . $key . "\n";
49            echo "  値 (SplFileInfo オブジェクト):\n";
50            echo "    ファイル名: " . $fileInfo->getFilename() . "\n";
51            echo "    フルパス: " . $fileInfo->getPathname() . "\n";
52            echo "    ファイルサイズ: " . $fileInfo->getSize() . " バイト\n";
53            echo "  -------------------------------------\n";
54        }
55    } catch (UnexpectedValueException $e) {
56        // GlobIteratorのコンストラクタで発生する可能性のあるエラーを捕捉します。
57        echo "エラーが発生しました: " . $e->getMessage() . "\n";
58    }
59
60    echo "--------------------------------------------------\n\n";
61}
62
63// さまざまなパターンで関数を呼び出し、動作を確認します。
64demonstrateGlobIteratorWithNewCurrentAndKey($testDir . '/*.txt'); // .txt ファイルを検索
65demonstrateGlobIteratorWithNewCurrentAndKey($testDir . '/*.log'); // .log ファイルを検索
66demonstrateGlobIteratorWithNewCurrentAndKey($testDir . '/*');     // すべてのファイルを検索
67
68// スクリプトの実行後、作成したテストファイルとディレクトリをクリーンアップします。
69array_map('unlink', glob($testDir . '/*')); // ディレクトリ内のファイルを削除
70rmdir($testDir); // 空になったディレクトリを削除
71
72?>

PHP 8で利用できるGlobIterator::NEW_CURRENT_AND_KEYは、GlobIteratorクラスに定義された特別な定数です。この定数自体は引数を持たず、直接の戻り値もありません。その主な役割は、GlobIteratorがファイルやディレクトリを走査する際の反復処理の挙動をカスタマイズすることにあります。

この定数は、new GlobIterator($path, GlobIterator::NEW_CURRENT_AND_KEY); のように、newキーワードと括弧を使ってGlobIteratorのインスタンスを作成する際の第二引数として指定します。これは「php new 括弧」の典型的な使用例の一つです。

この定数を指定すると、GlobIteratorをforeachループで処理した際に、イテレータの「キー」として走査対象ファイルのフルパスが提供されます。また、「現在の要素」（値）としては、そのファイルの詳細な情報（ファイル名、サイズ、更新日時など）にアクセスできるSplFileInfoオブジェクトが「返される」ようになります。これにより、ファイルシステムを効率的に操作し、各ファイルに関する多様な情報を簡単に取得できるようになるため、初心者の方でもファイル処理のスクリプトをより柔軟に記述できます。