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

Copy
1<?php
2
3/**
4 * FilesystemIterator::key() メソッドと「key exists」の概念を実演します。
5 *
6 * この関数は、一時的なディレクトリとファイルを作成し、
7 * FilesystemIterator を使ってディレクトリ内のエントリを反復処理し、
8 * 各エントリのキー（ファイルパス）を取得・表示します。
9 * 取得したキーが実際にファイルシステム上に存在することも確認します。
10 */
11function demonstrateFilesystemIteratorKeyAndExistence(): void
12{
13    // 一時的なテストディレクトリのパスを定義
14    $testDirPath = __DIR__ . '/filesystem_iterator_test_dir';
15
16    // ----------------------------------------------------
17    // 1. テスト環境の準備 (ディレクトリとファイルの作成)
18    // ----------------------------------------------------
19
20    // テストディレクトリが存在しない場合は作成します
21    if (!is_dir($testDirPath)) {
22        // 第3引数の true は、親ディレクトリも必要に応じて作成することを意味します
23        mkdir($testDirPath, 0777, true);
24        echo "Created test directory: '$testDirPath'\n";
25    }
26
27    // テストディレクトリ内にいくつかのファイルとサブディレクトリを作成します
28    $filesToCreate = [
29        'document.txt',
30        'image.jpg',
31        'data/config.json', // サブディレクトリ内のファイル
32        'data/logs/error.log', // ネストされたサブディレクトリ内のファイル
33    ];
34
35    foreach ($filesToCreate as $relativePath) {
36        $fullPath = $testDirPath . DIRECTORY_SEPARATOR . $relativePath;
37        $dirName = dirname($fullPath);
38
39        // ファイルの親ディレクトリが存在しない場合は作成します
40        if (!is_dir($dirName)) {
41            mkdir($dirName, 0777, true);
42        }
43        // 空のファイルを作成します
44        file_put_contents($fullPath, 'This is a test file.');
45        echo "Created file: '$fullPath'\n";
46    }
47
48    echo "\n--- FilesystemIterator::key() と「key exists」のデモンストレーション ---\n";
49
50    // ----------------------------------------------------
51    // 2. FilesystemIterator を使用した反復処理
52    // ----------------------------------------------------
53
54    try {
55        // FilesystemIterator をインスタンス化します
56        // FilesystemIterator::SKIP_DOTS フラグは '.' (カレントディレクトリ) と '..' (親ディレクトリ) をスキップします
57        $iterator = new FilesystemIterator($testDirPath, FilesystemIterator::SKIP_DOTS);
58
59        echo "ディレクトリ '$testDirPath' を反復処理しています:\n";
60
61        // ディレクトリ内の各エントリを反復処理します
62        // foreach ($iterator as $name => $fileInfo) の $name も、
63        // デフォルト設定では FilesystemIterator::key() と同じパス名になります。
64        foreach ($iterator as $name => $fileInfo) {
65            // FilesystemIterator::key() メソッドを呼び出して、現在の要素のキーを取得します。
66            // デフォルトでは、キーはエントリの完全なパス名 (例: /path/to/dir/file.txt) です。
67            $key = $iterator->key();
68
69            // 取得したキー（パス）がファイルシステム上に実際に存在するか確認します。
70            // FilesystemIterator が返すキーは通常、存在するパスを指します。
71            $existsStatus = file_exists($key) ? "exists" : "DOES NOT exist";
72
73            echo "  キー (パス): '$key' - ステータス: {$existsStatus}\n";
74        }
75    } catch (UnexpectedValueException $e) {
76        // 指定されたパスがディレクトリでない場合などに発生するエラーを捕捉します
77        echo "エラー: " . $e->getMessage() . "\n";
78    }
79
80    // ----------------------------------------------------
81    // 3. テスト環境のクリーンアップ
82    // ----------------------------------------------------
83
84    echo "\n--- テスト環境をクリーンアップ中 ---\n";
85
86    // ディレクトリとその内容を再帰的に削除するヘルパー関数
87    $deleteDirectoryRecursive = function (string $dir) use (&$deleteDirectoryRecursive): void {
88        if (!is_dir($dir)) {
89            return;
90        }
91        $items = new FilesystemIterator($dir, FilesystemIterator::SKIP_DOTS);
92        foreach ($items as $item) {
93            if ($item->isDir()) {
94                $deleteDirectoryRecursive($item->getPathname()); // サブディレクトリを再帰的に削除
95            } else {
96                unlink($item->getPathname()); // ファイルを削除
97            }
98        }
99        rmdir($dir); // 空になったディレクトリを削除
100        echo "Deleted: '$dir'\n";
101    };
102
103    // テストディレクトリを削除します
104    if (is_dir($testDirPath)) {
105        $deleteDirectoryRecursive($testDirPath);
106    }
107}
108
109// 関数を実行してデモンストレーションを開始します
110demonstrateFilesystemIteratorKeyAndExistence();
111

PHP 8のFilesystemIteratorクラスに属するkey()メソッドは、ディレクトリ内の要素を反復処理する際に、現在指している要素の「キー」を取得するものです。このメソッドは引数を取らず、戻り値として文字列（string）を返します。具体的には、反復処理中の現在のファイルやサブディレクトリの完全なパス名が返されます。

サンプルコードでは、一時的に作成したテストディレクトリ内のファイルやサブディレクトリをFilesystemIteratorで順に巡回しています。巡回中に$iterator->key()を呼び出すことで、現在処理している要素のフルパスがキーとして取得されます。そして、「php key exists」の概念を実演するため、取得したこのパスがfile_exists()関数によって実際にファイルシステム上に存在するかどうかも確認しています。これにより、FilesystemIterator::key()が返す値は、実際に存在するファイルやディレクトリへの有効なパスであることを示し、ファイルシステム上の特定の要素を識別し操作するための重要な情報として利用できることを示しています。

Copy
1<?php
2
3/**
4 * FilesystemIterator::key() メソッドの使用例を示します。
5 * この関数は、指定されたディレクトリの内容を走査し、各要素のキー（パス）と値（ファイル名）を表示します。
6 * システムエンジニアを目指す初心者の方にも分かりやすいように、詳細なコメントを含みます。
7 *
8 * キーワード: php key value
9 *
10 * @return void
11 */
12function demonstrateFilesystemIteratorKey(): void
13{
14    // 一時ディレクトリの名前を定義します。これはサンプルコードがファイルを
15    // 作成・削除するために使用する作業ディレクトリです。
16    $tempDir = __DIR__ . DIRECTORY_SEPARATOR . 'temp_files_for_iterator';
17
18    // 既存の場合はまず削除し、新しく一時ディレクトリを作成します。
19    // mkdir() の第3引数で再帰的な作成 (親ディレクトリがない場合も作成) を許可し、
20    // 第2引数でパーミッションを 0777 (読み書き実行を許可) に設定します。
21    if (is_dir($tempDir)) {
22        deleteDirectory($tempDir); // 既存ディレクトリがあれば削除
23    }
24    if (!mkdir($tempDir, 0777, true)) {
25        echo "エラー: 一時ディレクトリ '{$tempDir}' の作成に失敗しました。\n";
26        return;
27    }
28
29    // テスト用のダミーファイルとサブディレクトリを作成します。
30    // FilesystemIterator がこれらを走査します。
31    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'document.txt', 'これはテキストファイルです。');
32    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'image.jpg', 'ダミー画像データの内容'); // 内容はデモンストレーション用
33    mkdir($tempDir . DIRECTORY_SEPARATOR . 'sub_folder'); // サブディレクトリも作成
34
35    echo "--- ディレクトリ '{$tempDir}' の内容を走査します ---\n\n";
36
37    try {
38        // FilesystemIterator をインスタンス化します。
39        // これはファイルシステムを走査するためのイテレータ（反復子）です。
40        // FilesystemIterator::SKIP_DOTS フラグは、特殊なディレクトリ'.' (現在のディレクトリ) と
41        // '..' (親ディレクトリ) を走査対象から除外するために使用されます。
42        //
43        // FilesystemIterator はデフォルトで、キーをパス名 (KEY_AS_PATHNAME)、
44        // 値を SplFileInfo オブジェクト (CURRENT_AS_FILEINFO) として扱います。
45        $iterator = new FilesystemIterator($tempDir, FilesystemIterator::SKIP_DOTS);
46
47        // ディレクトリ内の各要素（ファイルやサブディレクトリ）をループします。
48        // foreach ($iterator as $fileInfo) の $fileInfo は、各要素の SplFileInfo オブジェクトです。
49        foreach ($iterator as $fileInfo) {
50            // FilesystemIterator::key() メソッドは、現在の要素のキーを文字列として返します。
51            // このキーは、通常は要素の完全なパス名です。
52            $keyPath = $iterator->key();
53
54            // FilesystemIterator はデフォルトで SplFileInfo オブジェクトを「値」として返します。
55            // ここでは、その SplFileInfo オブジェクトからファイル名を取得して「値」として表示します。
56            // $fileInfo は $iterator->current() と同じオブジェクトを指します。
57            $valueFileName = $fileInfo->getFilename();
58
59            echo "キー (要素の完全パス): " . $keyPath . "\n";
60            echo "値 (要素のファイル名): " . $valueFileName . "\n";
61            echo "---------------------------------------------------\n";
62        }
63    } catch (UnexpectedValueException $e) {
64        // FilesystemIterator のコンストラクタに無効なディレクトリパスなどが
65        // 指定された場合に発生するエラーを処理します。
66        echo "エラー: ディレクトリ '{$tempDir}' の読み込み中に問題が発生しました。詳細: " . $e->getMessage() . "\n";
67    } finally {
68        // サンプルコードの実行後、作成した一時ディレクトリとファイルをクリーンアップします。
69        // これは、不要なファイルを残さないための重要なステップです。
70        deleteDirectory($tempDir);
71    }
72}
73
74/**
75 * 指定されたディレクトリを再帰的に削除するヘルパー関数。
76 * ディレクトリ内にファイルやサブディレクトリが存在してもすべて削除します。
77 *
78 * @param string $dir 削除するディレクトリのパス
79 * @return void
80 */
81function deleteDirectory(string $dir): void
82{
83    if (!is_dir($dir)) {
84        // 指定されたパスがディレクトリではない場合は何もしません。
85        return;
86    }
87
88    // ディレクトリ内のすべてのファイルとサブディレクトリをスキャンします。
89    // scandir() は '.' と '..' (現在のディレクトリと親ディレクトリ) も返すため、
90    // array_diff() でこれらを除外します。
91    $files = array_diff(scandir($dir), ['.', '..']);
92
93    foreach ($files as $file) {
94        $path = $dir . DIRECTORY_SEPARATOR . $file;
95        // 各要素がディレクトリかファイルかを確認します。
96        // ディレクトリの場合は再帰的に deleteDirectory 関数を呼び出し、
97        // ファイルの場合は unlink() で削除します。
98        is_dir($path) ? deleteDirectory($path) : unlink($path);
99    }
100
101    // ディレクトリが空になったら、そのディレクトリ自体を rmdir() で削除します。
102    rmdir($dir);
103    echo "一時ディレクトリ '{$dir}' とその内容を削除しました。\n";
104}
105
106// 上記の関数を実行してデモンストレーションを開始します。
107demonstrateFilesystemIteratorKey();
108

PHPのFilesystemIteratorクラスは、指定されたディレクトリ内のファイルやサブディレクトリを効率的に順番に処理（走査）するためのイテレータ（反復子）です。このクラスに属するkey()メソッドは、現在処理している要素の「キー」を取得するために使用されます。key()メソッドは引数を受け取らず、現在の要素のキーを文字列（string）として返します。

FilesystemIteratorにおいて、この「キー」は通常、走査中のファイルやディレクトリの完全なパス名を示します。一方、「値」は通常、そのファイルやディレクトリの詳細な情報を含むSplFileInfoオブジェクトとして提供されます。

提供されたサンプルコードでは、まず一時的な作業ディレクトリとダミーのファイル・サブディレクトリを作成します。次に、FilesystemIteratorをインスタンス化してディレクトリ内容の走査を開始します。ループの中で$iterator->key()を呼び出すことで、現在の要素の完全なパス（キー）を取得し、同時にファイル情報オブジェクトからファイル名（値）を取り出して表示しています。これにより、ディレクトリ内の各要素がパスとファイル名としてどのように表現されるかを確認できます。処理の最後には、作成した一時ディレクトリとファイルを確実に削除し、クリーンな状態に戻しています。