Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

NEW_CURRENT_AND_KEY定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

RecursiveDirectoryIterator::NEW_CURRENT_AND_KEY定数は、RecursiveDirectoryIteratorクラスにおいて、イテレータが現在の要素とキーを再生成する動作を示す定数です。この定数を設定すると、ディレクトリを再帰的に走査する際、イテレータが次の要素に進むたびに、current()メソッドが返す現在の要素とkey()メソッドが返すキーが新しく生成し直されます。

この設定は、ファイルシステムの状態が動的に変化する可能性がある状況や、常に各要素の最新情報を確実に取得したい場合に特に重要です。イテレータが移動するたびに情報が最新のデータに基づいて再構築されるため、古い情報を参照してしまうことを防ぎ、正確で信頼性の高いファイル操作が可能になります。

この定数は、RecursiveDirectoryIteratorオブジェクトのコンストラクタの第二引数である$flagsパラメータに渡して利用します。RecursiveDirectoryIterator::SKIP_DOTSなどの他のフラグと組み合わせることで、システムエンジニアはファイルシステム走査の柔軟な制御を行うことができます。

構文(syntax)

1<?php
2RecursiveDirectoryIterator::NEW_CURRENT_AND_KEY;

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

RecursiveDirectoryIterator::NEW_CURRENT_AND_KEYでcurrentとkeyを取得する

1<?php
2
3/**
4 * 一時ディレクトリを作成し、テスト用のファイルとサブディレクトリを配置します。
5 *
6 * @param string $basePath テストディレクトリのベースパス
7 * @throws RuntimeException ディレクトリの作成に失敗した場合
8 */
9function createTestDirectoryStructure(string $basePath): void
10{
11    // メインのテストディレクトリ
12    $testDir = $basePath . DIRECTORY_SEPARATOR . 'test_dir';
13    if (!mkdir($testDir, 0777, true) && !is_dir($testDir)) {
14        throw new \RuntimeException(sprintf('Directory "%s" was not created', $testDir));
15    }
16
17    // サブディレクトリ
18    $subDir = $testDir . DIRECTORY_SEPARATOR . 'sub_dir';
19    if (!mkdir($subDir, 0777, true) && !is_dir($subDir)) {
20        throw new \RuntimeException(sprintf('Directory "%s" was not created', $subDir));
21    }
22
23    // ファイル1 (メインディレクトリ内)
24    file_put_contents($testDir . DIRECTORY_SEPARATOR . 'file1.txt', 'Content of file1');
25    // ファイル2 (サブディレクトリ内)
26    file_put_contents($subDir . DIRECTORY_SEPARATOR . 'file2.txt', 'Content of file2');
27}
28
29/**
30 * 指定されたディレクトリとその内容を再帰的に削除します。
31 *
32 * @param string $dir 削除するディレクトリのパス
33 */
34function removeTestDirectoryStructure(string $dir): void
35{
36    if (!is_dir($dir)) {
37        return;
38    }
39    $files = array_diff(scandir($dir), ['.', '..']);
40    foreach ($files as $file) {
41        (is_dir("$dir/$file")) ? removeTestDirectoryStructure("$dir/$file") : unlink("$dir/$file");
42    }
43    rmdir($dir);
44}
45
46/**
47 * RecursiveDirectoryIterator::NEW_CURRENT_AND_KEY 定数の使用例を示します。
48 * この定数を使用すると、イテレータの current() メソッドは SplFileInfo オブジェクトを、
49 * key() メソッドはファイルのパス名を返します。
50 */
51function demonstrateRecursiveDirectoryIteratorNewCurrentAndKey(): void
52{
53    $tempDir = sys_get_temp_dir();
54    // ユニークな名前で一時ディレクトリを作成し、衝突を避ける
55    $testBasePath = $tempDir . DIRECTORY_SEPARATOR . uniqid('php_test_recursive_dir_', true);
56
57    try {
58        // テスト用のディレクトリとファイルを作成
59        createTestDirectoryStructure($testBasePath);
60        echo "テストディレクトリが作成されました: " . $testBasePath . "\n";
61
62        // RecursiveDirectoryIterator を RecursiveDirectoryIterator::NEW_CURRENT_AND_KEY フラグ付きで初期化
63        // SKIP_DOTS は "." と ".." をスキップします。
64        // NEW_CURRENT_AND_KEY により、current() は SplFileInfo オブジェクトを、key() はパス名を返します。
65        $dirIterator = new RecursiveDirectoryIterator(
66            $testBasePath,
67            RecursiveDirectoryIterator::SKIP_DOTS | RecursiveDirectoryIterator::NEW_CURRENT_AND_KEY
68        );
69
70        // RecursiveIteratorIterator でラップして、ディレクトリを再帰的に走査します。
71        // LEAVES_ONLY はファイルのみを返し、ディレクトリ自体はスキップします。
72        $iterator = new RecursiveIteratorIterator($dirIterator, RecursiveIteratorIterator::LEAVES_ONLY);
73
74        echo "\nディレクトリ内容の走査結果:\n";
75        foreach ($iterator as $key => $current) {
76            echo "----------------------------------------\n";
77            // key() メソッドはファイルのフルパス(パス名)を返します。
78            echo "Key (パス): " . $key . "\n";
79            // current() メソッドは SplFileInfo オブジェクトを返します。
80            echo "Current (オブジェクトの型): " . get_class($current) . "\n";
81            echo "  ファイル名: " . $current->getFilename() . "\n";
82            echo "  フルパス (SplFileInfo::getPathname()): " . $current->getPathname() . "\n";
83            echo "  ファイルサイズ: " . $current->getSize() . " バイト\n";
84        }
85        echo "----------------------------------------\n";
86
87    } catch (Exception $e) {
88        echo "エラーが発生しました: " . $e->getMessage() . "\n";
89    } finally {
90        // テスト用ディレクトリをクリーンアップ
91        removeTestDirectoryStructure($testBasePath);
92        echo "\nテストディレクトリが削除されました: " . $testBasePath . "\n";
93    }
94}
95
96// 関数の実行
97demonstrateRecursiveDirectoryIteratorNewCurrentAndKey();

PHPのRecursiveDirectoryIterator::NEW_CURRENT_AND_KEYは、ファイルシステムを再帰的に走査する際に利用するRecursiveDirectoryIteratorクラスに属する定数です。この定数自体に引数や戻り値はありませんが、RecursiveDirectoryIteratorの挙動を制御するために使用されます。

この定数をRecursiveDirectoryIteratorのコンストラクタのフラグとして指定すると、イテレータのcurrent()メソッドとkey()メソッドの返す値が変わります。具体的には、current()メソッドは、ファイルやディレクトリに関する詳細な情報を持つSplFileInfoオブジェクトを返します。これにより、ファイル名、フルパス、サイズ、更新日時といった多くの属性に簡単にアクセスできるようになります。また、key()メソッドは、走査中のファイルやディレクトリのフルパス(パス名)を文字列として返します。

サンプルコードでは、まず一時的なディレクトリ構造を作成します。その後、RecursiveDirectoryIteratorを初期化する際にSKIP_DOTSフラグと同時にNEW_CURRENT_AND_KEYフラグを設定しています。RecursiveIteratorIteratorと組み合わせてディレクトリを再帰的に走査するforeachループ内では、key()がファイルのフルパスを、current()がSplFileInfoオブジェクトを返し、そのオブジェクトからファイル名やサイズなどの情報を取得できる様子が示されています。これにより、ディレクトリ内のファイルを効率的かつ柔軟に処理できることが理解できます。

RecursiveDirectoryIterator::NEW_CURRENT_AND_KEY定数を指定すると、foreachループでファイルのパスが$keyに、ファイルの詳細情報を持つSplFileInfoオブジェクトが$currentに渡されます。この定数がない場合、key()とcurrent()の戻り値の役割が逆転するため注意が必要です。SplFileInfoオブジェクトを利用することで、ファイル名、サイズ、更新日時など、ファイルに関する豊富な情報を簡単に取得できます。ディレクトリの再帰的な走査では、SKIP_DOTSやLEAVES_ONLYといった他のフラグと組み合わせることで、イテレータの挙動を細かく制御できます。ファイルやディレクトリ操作を行う際は、try-finallyブロックを用いて一時リソースを確実にクリーンアップする習慣を身につけてください。また、サンプルコードのディレクトリパーミッション0777はテスト用であり、本番環境ではセキュリティを考慮し、より制限された権限設定を検討することが重要です。

PHP RecursiveDirectoryIterator::NEW_CURRENT_AND_KEY を使ったディレクトリ走査

1<?php
2
3/**
4 * RecursiveDirectoryIterator::NEW_CURRENT_AND_KEY 定数を使用するサンプルコード。
5 *
6 * この関数は、一時的なディレクトリ構造を作成し、RecursiveDirectoryIterator と
7 * RecursiveIteratorIterator を使用して再帰的に走査します。
8 * RecursiveDirectoryIterator::NEW_CURRENT_AND_KEY 定数を使用することで、
9 * foreach ループで $key にファイル名、$value に SplFileInfo オブジェクトが設定されることを示します。
10 * (PHP 8 以降では、NEW_CURRENT_AND_KEY は FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::KEY_AS_FILENAME のエイリアスです。)
11 */
12function demonstrateRecursiveDirectoryIteratorNewCurrentAndKey(): void
13{
14    // 1. テスト用のディレクトリ構造を一時ディレクトリ内に作成します。
15    // これにより、コードがどこでも単体で実行できるようになります。
16    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'test_recursive_dir_' . uniqid();
17    mkdir($tempDir);
18    mkdir($tempDir . DIRECTORY_SEPARATOR . 'subdir_a');
19    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file1.txt', 'Content for file1');
20    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'subdir_a' . DIRECTORY_SEPARATOR . 'file2.log', 'Content for file2');
21    mkdir($tempDir . DIRECTORY_SEPARATOR . 'subdir_b');
22    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'subdir_b' . DIRECTORY_SEPARATOR . 'file3.json', '{"key": "value"}');
23
24    echo "--- ディレクトリ構造の走査開始 ---" . PHP_EOL;
25    echo "走査対象ディレクトリ: " . $tempDir . PHP_EOL . PHP_EOL;
26
27    try {
28        // RecursiveDirectoryIterator を NEW_CURRENT_AND_KEY フラグ付きでインスタンス化します。
29        // RecursiveDirectoryIterator::SKIP_DOTS は、'.' と '..' をスキップするために使用します。
30        // RecursiveDirectoryIterator::NEW_CURRENT_AND_KEY は、
31        // foreach ループで $key にファイル名 (basename)、$value に SplFileInfo オブジェクトが返されるように設定します。
32        $directoryIterator = new RecursiveDirectoryIterator(
33            $tempDir,
34            RecursiveDirectoryIterator::SKIP_DOTS | RecursiveDirectoryIterator::NEW_CURRENT_AND_KEY
35        );
36
37        // RecursiveIteratorIterator でラップすることで、ディレクトリを再帰的に走査できるようになります。
38        // SELF_FIRST フラグは、サブディレクトリの内容を処理する前にディレクトリ自体を処理することを意味します。
39        $iterator = new RecursiveIteratorIterator($directoryIterator, RecursiveIteratorIterator::SELF_FIRST);
40
41        // ディレクトリ構造を走査し、各要素の $key と $value の内容を表示します。
42        foreach ($iterator as $key => $value) {
43            $indent = str_repeat("  ", $iterator->getDepth()); // 階層に応じたインデント
44
45            // $key はファイル名またはディレクトリ名です (文字列)。
46            echo $indent . "Key: " . $key . " (型: " . gettype($key) . ")" . PHP_EOL;
47
48            // $value は SplFileInfo オブジェクトです。
49            // getPathname() で要素のフルパスを取得できます。
50            echo $indent . "Value Path: " . $value->getPathname() . " (型: " . get_class($value) . ")" . PHP_EOL;
51
52            // SplFileInfo オブジェクトのメソッドを使って、ファイルやディレクトリの情報を取得できます。
53            echo $indent . "  - Is Directory: " . ($value->isDir() ? "Yes" : "No") . PHP_EOL;
54            echo $indent . "  - Is File: " . ($value->isFile() ? "Yes" : "No") . PHP_EOL;
55            if ($value->isFile()) {
56                echo $indent . "  - Size: " . $value->getSize() . " bytes" . PHP_EOL;
57            }
58            echo PHP_EOL;
59        }
60
61    } catch (UnexpectedValueException $e) {
62        // ディレクトリが存在しないなど、予期せぬエラーが発生した場合の処理
63        echo "エラー: " . $e->getMessage() . PHP_EOL;
64    } finally {
65        // 2. テスト用に作成したディレクトリ構造をクリーンアップします。
66        // 子要素から順に削除するため、RecursiveIteratorIterator と CHILD_FIRST フラグを使用します。
67        $files = new RecursiveIteratorIterator(
68            new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS),
69            RecursiveIteratorIterator::CHILD_FIRST
70        );
71
72        foreach ($files as $fileinfo) {
73            if ($fileinfo->isDir()) {
74                // ディレクトリを削除
75                rmdir($fileinfo->getRealPath());
76            } else {
77                // ファイルを削除
78                unlink($fileinfo->getRealPath());
79            }
80        }
81        // ルートの一時ディレクトリを削除
82        rmdir($tempDir);
83        echo "--- ディレクトリ構造のクリーンアップ完了 ---" . PHP_EOL;
84    }
85}
86
87// 関数を実行します。
88demonstrateRecursiveDirectoryIteratorNewCurrentAndKey();

PHPのRecursiveDirectoryIterator::NEW_CURRENT_AND_KEY定数を使用するこのサンプルコードは、ディレクトリを再帰的に走査する際のforeachループの挙動を示しています。この定数は、RecursiveDirectoryIteratorクラスのインスタンスを作成する際にオプションとして指定することで、イテレータが返すキーと値の形式を制御します。定数であるため引数はなく、戻り値も直接的にはありませんが、内部的な動作を設定します。

具体的には、NEW_CURRENT_AND_KEYを指定すると、foreach ($iterator as $key => $value)のようにループする際、$keyには現在の要素(ファイルやディレクトリ)の「名前」(basename)が文字列として設定されます。一方、$valueにはその要素に関する詳細な情報を持つSplFileInfoオブジェクトが設定されます。このSplFileInfoオブジェクトからは、ファイルのフルパス、種類(ファイルかディレクトリか)、サイズなどの情報を取得可能です。PHP 8以降では、この定数はFilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::KEY_AS_FILENAMEのエイリアスとなっています。このサンプルコードは一時ディレクトリを作成し、走査結果の$keyと$valueの内容とその型を表示することで、この定数の効果を具体的に示しています。

RecursiveDirectoryIterator::NEW_CURRENT_AND_KEY定数は、foreachループで$keyにファイルやディレクトリの名前が文字列として、$valueにその詳細情報を持つSplFileInfoオブジェクトが渡されるよう指定するものです。複数の動作フラグを組み合わせる際には、|(ビットOR演算子)を使用することを覚えておきましょう。newキーワードでオブジェクトを生成し、そのオブジェクトのメソッドを呼び出す記述は、PHPのオブジェクト指向プログラミングの基礎ですので、しっかりと理解することが大切です。また、サンプルコードのように一時的なファイルやディレクトリを作成した場合は、try-finallyブロックなどを用いて、プログラム終了時に必ず削除する習慣をつけ、リソースの適切な管理を心がけてください。これはシステムを安全かつ安定して運用するための重要なポイントです。

関連コンテンツ

関連IT用語

関連プログラミング言語