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

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator::key() メソッドのサンプルコード。
5 *
6 * このメソッドは、RecursiveDirectoryIterator が現在指している要素のキー（通常は完全なファイルパス）を文字列で返します。
7 * キーワード「php key exists」に関連付けて、取得したパスが実際にファイルシステム上に存在するかどうかを確認する例を含みます。
8 *
9 * システムエンジニアを目指す初心者向けに、単体で動作可能なように一時的なファイルとディレクトリを作成・削除します。
10 */
11
12// 1. 一時ディレクトリを作成し、テスト用のファイル構造を準備します。
13$tmpDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'recursive_key_test_' . uniqid();
14mkdir($tmpDir, 0777, true);
15file_put_contents($tmpDir . DIRECTORY_SEPARATOR . 'file1.txt', 'Content for file1');
16mkdir($tmpDir . DIRECTORY_SEPARATOR . 'subdir', 0777);
17file_put_contents($tmpDir . DIRECTORY_SEPARATOR . 'subdir' . DIRECTORY_SEPARATOR . 'file2.txt', 'Content for file2');
18file_put_contents($tmpDir . DIRECTORY_SEPARATOR . 'subdir' . DIRECTORY_SEPARATOR . 'file3.txt', 'Content for file3');
19
20echo "--- ディレクトリ走査を開始します --- \n";
21echo "対象ディレクトリ: {$tmpDir}\n\n";
22
23try {
24    // 2. RecursiveDirectoryIterator をインスタンス化します。
25    //    RecursiveDirectoryIterator::SKIP_DOTS フラグで "." と ".." をスキップします。
26    $iterator = new RecursiveDirectoryIterator($tmpDir, RecursiveDirectoryIterator::SKIP_DOTS);
27
28    // 3. RecursiveIteratorIterator を使用してディレクトリを再帰的に走査します。
29    //    RecursiveIteratorIterator::SELF_FIRST はディレクトリ自体もイテレーション対象に含めます。
30    $recursiveIterator = new RecursiveIteratorIterator($iterator, RecursiveIteratorIterator::SELF_FIRST);
31
32    // 4. イテレータをループし、各要素のキー（パス）を取得・表示します。
33    foreach ($recursiveIterator as $item) {
34        // key() メソッドは、現在の要素のキー（ファイルやディレクトリの完全パス）を返します。
35        $key = $recursiveIterator->key();
36        echo "キー (パス): {$key}\n";
37
38        // 取得したキー（パス）がファイルシステム上に実際に存在するかを確認します。
39        // これは「key exists」というキーワードに関連するチェックです。
40        if (file_exists($key)) {
41            echo "  -> このパスはファイルシステム上に存在します。\n";
42        } else {
43            // 通常、RecursiveDirectoryIterator が返すパスは存在するため、このメッセージは表示されないはずです。
44            echo "  -> 警告: このパスはファイルシステム上に存在しません。\n";
45        }
46
47        // isDir() や isFile() で、そのキーがディレクトリかファイルかを判断することもできます。
48        if ($item->isDir()) {
49            echo "  -> これはディレクトリです。\n";
50        } elseif ($item->isFile()) {
51            echo "  -> これはファイルです。\n";
52        }
53        echo "----------------------------------------\n";
54    }
55} catch (UnexpectedValueException $e) {
56    // ディレクトリが存在しない場合などに発生する可能性のあるエラーをキャッチします。
57    echo "エラーが発生しました: " . $e->getMessage() . "\n";
58} finally {
59    // 5. 使用した一時ディレクトリとファイルをクリーンアップする関数を定義します。
60    //    再帰的にディレクトリ内のすべてのファイルを削除します。
61    function removeTemporaryDirectory($dir)
62    {
63        if (!is_dir($dir)) {
64            return;
65        }
66        $objects = scandir($dir);
67        foreach ($objects as $object) {
68            if ($object === "." || $object === "..") {
69                continue;
70            }
71            $path = $dir . DIRECTORY_SEPARATOR . $object;
72            if (is_dir($path) && !is_link($path)) {
73                removeTemporaryDirectory($path);
74            } else {
75                unlink($path);
76            }
77        }
78        rmdir($dir);
79    }
80
81    // 6. クリーンアップを実行します。
82    removeTemporaryDirectory($tmpDir);
83    echo "\n--- 一時ディレクトリ {$tmpDir} をクリーンアップしました --- \n";
84}

PHP 8のRecursiveDirectoryIteratorクラスが提供するkey()メソッドは、ディレクトリを走査するイテレータが現在指している要素の「キー」を文字列として返します。このメソッドは引数を取らず、戻り値として、通常はファイルまたはディレクトリの完全なパス（絶対パス）を文字列型で提供します。

サンプルコードでは、まず一時的なディレクトリとファイルを準備し、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを組み合わせてディレクトリ構造を再帰的に走査しています。foreachループの中でkey()メソッドを呼び出すと、現在処理中の要素（ファイルまたはディレクトリ）の完全なパスが取得されます。

この取得されたパスは、キーワード「php key exists」に関連付けて、file_exists()関数を用いてファイルシステム上に実際に存在するかどうかが確認されます。これにより、key()が返す情報が有効なパスであることを実証しています。また、isDir()やisFile()といったメソッドで、そのパスがディレクトリかファイルかを判断する例も示されており、これによりパスの内容に応じた処理が可能となります。サンプルコードは、使用した一時ファイルを適切にクリーンアップし、単体で動作するよう構成されています。

Copy
1<?php
2
3// このサンプルコードが単体で動作するように、一時的なディレクトリとファイルを作成します。
4// 実際のアプリケーションでは、この準備は不要です。
5$tempDir = __DIR__ . '/example_recursive_dir';
6if (!is_dir($tempDir)) {
7    mkdir($tempDir);
8}
9if (!is_dir($tempDir . '/subdir')) {
10    mkdir($tempDir . '/subdir');
11}
12file_put_contents($tempDir . '/file1.txt', 'This is file1 in the main directory.');
13file_put_contents($tempDir . '/subdir/file2.txt', 'This is file2 in a subdirectory.');
14
15echo "--- RecursiveDirectoryIterator::key() メソッドのサンプル ---\n";
16echo "このコードは、指定されたディレクトリとその内容を再帰的に走査し、\n";
17echo "各ファイルやディレクトリの「キー」（完全なパス）を表示します。\n";
18echo "key() メソッドが返すパスは、その要素がファイルシステム上に「存在すること」を示します。\n\n";
19
20try {
21    // RecursiveDirectoryIterator は、ディレクトリの内容をイテレータとして提供します。
22    // FilesystemIterator::SKIP_DOTS は、特殊なエントリである '.' (カレントディレクトリ) と '..' (親ディレクトリ) をスキップします。
23    $directoryIterator = new RecursiveDirectoryIterator(
24        $tempDir,
25        FilesystemIterator::SKIP_DOTS
26    );
27
28    // RecursiveIteratorIterator は、RecursiveDirectoryIterator をラップすることで、
29    // サブディレクトリの中まで含めて、再帰的に全ての要素を走査できるようにします。
30    // RecursiveIteratorIterator::SELF_FIRST は、サブディレクトリ自体をその内容よりも先に走査します。
31    $iterator = new RecursiveIteratorIterator(
32        $directoryIterator,
33        RecursiveIteratorIterator::SELF_FIRST
34    );
35
36    // foreach ループを使ってイテレータを走査します。
37    // 各要素はファイルまたはディレクトリを表します。
38    foreach ($iterator as $name => $fileinfo) {
39        // RecursiveDirectoryIterator::key() メソッドは、現在の要素の完全なパスを文字列として返します。
40        // このパスは、ファイルシステム上で実際にアクセス可能な要素の場所を示します。
41        // ここで得られるキーは、そのパスにファイルまたはディレクトリが「存在すること」を意味します。
42        $key = $iterator->key();
43        echo "キー（パス）: " . $key . "\n";
44    }
45
46} catch (UnexpectedValueException $e) {
47    // 指定されたパスが存在しない、またはディレクトリでない場合にこの例外が発生します。
48    echo "エラー: ディレクトリの走査中に問題が発生しました。 " . $e->getMessage() . "\n";
49} finally {
50    // サンプルコードが作成した一時ディレクトリとファイルをクリーンアップします。
51    // 実際のアプリケーションでは、このクリーンアップは通常行いません。
52    echo "\n一時ファイルをクリーンアップしています...\n";
53    if (is_dir($tempDir)) {
54        // クリーンアップのために再度イテレータを設定し、子要素から先に処理します (CHILD_FIRST)。
55        $files = new RecursiveIteratorIterator(
56            new RecursiveDirectoryIterator($tempDir, FilesystemIterator::SKIP_DOTS),
57            RecursiveIteratorIterator::CHILD_FIRST
58        );
59
60        foreach ($files as $file) {
61            // ファイルの場合は直接削除し、ディレクトリの場合は空にしてから削除します。
62            if ($file->isDir()) {
63                rmdir($file->getRealPath());
64            } else {
65                unlink($file->getRealPath());
66            }
67        }
68        rmdir($tempDir); // 最上位のディレクトリを削除
69        echo "クリーンアップが完了しました。\n";
70    } else {
71        echo "クリーンアップするディレクトリが見つかりませんでした。\n";
72    }
73}

PHPのRecursiveDirectoryIterator::key()メソッドは、ディレクトリとその中のファイルを再帰的に走査する際に、現在処理している要素の「キー」を取得するために使用されます。このメソッドは引数を取らず、現在のファイルやディレクトリの完全なパスを文字列として返します。

ここで取得できる「キー」は、ファイルシステム上におけるそのファイルまたはディレクトリの絶対パスを意味します。このメソッドがパスを返すということは、そのパスが指し示すファイルやディレクトリが実際にファイルシステム上に「存在すること」を示しています。したがって、パスを通じて要素の存在を確認する目的でも利用可能です。

サンプルコードでは、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを組み合わせてディレクトリ内を再帰的に探索し、$iterator->key()を呼び出すことで、各ファイルやサブディレクトリの完全なパスを表示しています。これにより、現在処理中の要素がどこにあるのかを正確に把握し、その存在を明示的に確認できます。