【PHP8.x】FilesystemIterator::KEY_AS_PATHNAME定数の使い方

Copy
1<?php
2
3/**
4 * FilesystemIterator::KEY_AS_PATHNAME 定数の使用例を示します。
5 *
6 * この定数を使うと、FilesystemIterator が返すイテレータのキーが、
7 * ファイルやディレクトリのパス名になります。
8 * 通常、イテレータのキーは数値インデックスです。
9 *
10 * このサンプルでは、一時ディレクトリを作成し、その中のファイルやディレクトリを走査し、
11 * キーがパス名として取得されることを出力します。
12 */
13function demonstrateFilesystemIteratorKeyAsPathname(): void
14{
15    // 一時ディレクトリのパスを生成
16    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_fs_iterator_test_' . uniqid();
17
18    // 一時ディレクトリを作成
19    if (!mkdir($tempDir, 0777, true)) {
20        echo "エラー: 一時ディレクトリの作成に失敗しました: {$tempDir}\n";
21        return;
22    }
23
24    // テスト用のファイルとサブディレクトリを作成
25    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file1.txt', 'テストファイル1');
26    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'document.pdf', 'PDFファイル');
27    mkdir($tempDir . DIRECTORY_SEPARATOR . 'images');
28    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'images' . DIRECTORY_SEPARATOR . 'photo.jpg', '画像ファイル');
29
30    echo "--- FilesystemIterator::KEY_AS_PATHNAME の使用例 ---\n";
31    echo "対象ディレクトリ: {$tempDir}\n\n";
32
33    try {
34        // FilesystemIterator を初期化し、KEY_AS_PATHNAME フラグを指定します。
35        // このフラグにより、イテレータの各要素のキーとして、
36        // そのファイルまたはディレクトリの完全なパス名が使用されます。
37        $iterator = new FilesystemIterator($tempDir, FilesystemIterator::KEY_AS_PATHNAME);
38
39        // イテレータをループし、キー（パス名）とファイル情報（SplFileInfoオブジェクト）を出力
40        foreach ($iterator as $key => $fileInfo) {
41            // $key にはファイルまたはディレクトリのパス名が入ります。
42            // $fileInfo はそのファイル/ディレクトリの詳細情報を持つ SplFileInfo オブジェクトです。
43            echo "キー (パス名): " . $key . "\n";
44            echo "  ファイル/ディレクトリ名: " . $fileInfo->getFilename() . "\n";
45            echo "  種類: " . ($fileInfo->isDir() ? "ディレクトリ" : "ファイル") . "\n";
46            echo "-----------------------------------------\n";
47        }
48    } catch (UnexpectedValueException $e) {
49        echo "エラー: ディレクトリにアクセスできません。メッセージ: " . $e->getMessage() . "\n";
50    } finally {
51        // 後処理: 作成した一時ディレクトリとその内容を全て削除
52        // rmdir は空のディレクトリしか削除できないため、再帰的な削除関数を使用します。
53        $recursiveRemoveDir = function (string $dir) use (&$recursiveRemoveDir) {
54            $files = array_diff(scandir($dir), ['.', '..']);
55            foreach ($files as $file) {
56                $path = "$dir/$file";
57                (is_dir($path)) ? $recursiveRemoveDir($path) : unlink($path);
58            }
59            return rmdir($dir);
60        };
61
62        if (!$recursiveRemoveDir($tempDir)) {
63            echo "\n警告: 一時ディレクトリの削除に失敗しました: {$tempDir}\n";
64        } else {
65            echo "\n一時ディレクトリとその内容を削除しました: {$tempDir}\n";
66        }
67    }
68}
69
70// 関数を実行して、FilesystemIterator::KEY_AS_PATHNAME の動作を確認します。
71demonstrateFilesystemIteratorKeyAsPathname();

PHP 8のFilesystemIterator::KEY_AS_PATHNAMEは、FilesystemIteratorクラスに属する定数です。この定数はint型の値を持っており、ファイルシステムを反復処理する際に、各要素のキーとしてファイルやディレクトリの完全なパス名を取得するために使用します。通常、FilesystemIteratorをオプションなしで使用すると、イテレータのキーは0から始まる数値インデックスになります。しかし、FilesystemIterator::KEY_AS_PATHNAMEをコンストラクタの第二引数として指定することで、foreachループなどでキーとして各ファイルのパス名を直接取得できるようになります。

サンプルコードでは、一時ディレクトリを作成し、その中にいくつかのファイルやサブディレクトリを配置しています。その後、new FilesystemIterator($tempDir, FilesystemIterator::KEY_AS_PATHNAME)としてイテレータを生成し、ループで取得される$keyがファイルやディレクトリのパス名になっている様子を確認できます。これにより、反復処理中にファイルパスをすぐに利用したい場合に、キーから直接パスを取得できるため非常に便利です。この定数自体は引数を持たず、特定の挙動を指示するフラグとして機能します。

Copy
1<?php
2
3/**
4 * FilesystemIterator::KEY_AS_PATHNAME 定数の使用例を示します。
5 *
6 * この定数を使用することで、FilesystemIterator がファイルを反復処理する際に、
7 * 配列のキーとしてファイル名 (basename) の代わりに完全なパス名を使用するようになります。
8 * これにより、イテレータのキー名が変更されます。
9 */
10function demonstrateFilesystemIteratorKeyAsPathname(): void
11{
12    // 一時ディレクトリを作成し、サンプルファイルを追加します。
13    // スクリプトの実行が完了したらクリーンアップされます。
14    $tempDir = sys_get_temp_dir() . '/' . uniqid('php_fs_demo_');
15    if (!mkdir($tempDir) && !is_dir($tempDir)) {
16        throw new \RuntimeException(sprintf('Failed to create directory "%s"', $tempDir));
17    }
18
19    $file1Path = $tempDir . '/document.txt';
20    $file2Path = $tempDir . '/image.jpg';
21    file_put_contents($file1Path, 'This is a sample document.');
22    file_put_contents($file2Path, 'This is a sample image.');
23
24    echo "--- FilesystemIterator (デフォルト動作) ---\n";
25    echo "  (キー: ファイル名、値: SplFileInfo オブジェクト)\n";
26    // デフォルトの FilesystemIterator は、キーとしてファイル名 (例: document.txt) を使用します。
27    $defaultIterator = new FilesystemIterator($tempDir);
28    foreach ($defaultIterator as $key => $fileInfo) {
29        echo "キー: " . $key . ", 完全なパス名: " . $fileInfo->getPathname() . "\n";
30    }
31    echo "\n";
32
33    echo "--- FilesystemIterator (KEY_AS_PATHNAME フラグ使用) ---\n";
34    echo "  (キー: 完全なパス名、値: SplFileInfo オブジェクト)\n";
35    // FilesystemIterator::KEY_AS_PATHNAME フラグを指定すると、
36    // キーが完全なパス名 (例: /tmp/php_fs_demo_.../document.txt) に変更されます。
37    $pathNameKeyIterator = new FilesystemIterator($tempDir, FilesystemIterator::KEY_AS_PATHNAME);
38    foreach ($pathNameKeyIterator as $key => $fileInfo) {
39        echo "キー: " . $key . ", 完全なパス名: " . $fileInfo->getPathname() . "\n";
40    }
41    echo "\n";
42
43    // 後処理: 作成したファイルとディレクトリを削除します。
44    unlink($file1Path);
45    unlink($file2Path);
46    rmdir($tempDir);
47    echo "一時ファイルとディレクトリをクリーンアップしました。\n";
48}
49
50// 関数を実行し、FilesystemIterator の動作の違いを確認します。
51demonstrateFilesystemIteratorKeyAsPathname();
52
53?>

PHP 8のFilesystemIterator::KEY_AS_PATHNAME定数は、ファイルシステムを反復処理するFilesystemIteratorクラスで使用され、イテレータが提供する要素の「キー」の形式を変更します。FilesystemIteratorは、ディレクトリ内のファイルやフォルダをforeachループなどで順に処理する際に、各要素を「キー」と「値」（通常はSplFileInfoオブジェクト）のペアとして扱います。

デフォルトの設定では、FilesystemIteratorで反復処理を行うと、各要素の「キー」にはファイルやフォルダの基本的な名前（例: document.txt）が設定されます。

しかし、FilesystemIterator::KEY_AS_PATHNAME定数をFilesystemIteratorのインスタンスを生成する際に引数として指定すると、このキーの挙動が変更されます。具体的には、「キー」がファイルやフォルダの「完全なパス名」（例: /tmp/unique_id/document.txt）に切り替わります。

これにより、イテレータのキーから直接ファイルシステム上の具体的なパスを特定できるようになり、特に完全なパス名をキーとして利用したい場合に役立ちます。この定数自体は整数値であり、引数は受け取りません。サンプルコードは、この定数を使用した場合としない場合のキーの違いを明確に示しています。