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

Copy
1<?php
2
3/**
4 * FilesystemIterator::FOLLOW_SYMLINKS 定数の動作をデモンストレーションします。
5 *
6 * この定数は、FilesystemIteratorがディレクトリを走査する際に、
7 * シンボリックリンクを「リンクそのもの」として扱うか、
8 * それとも「リンクの指す先のファイルやディレクトリ」として扱うかを制御します。
9 *
10 * PHP 8 で利用可能な機能です。
11 */
12function demonstrateFilesystemIteratorFollowSymlinks(): void
13{
14    // 1. デモ用の一時ディレクトリとファイル、シンボリックリンクを準備します。
15    $tempDir = __DIR__ . '/php_symlink_demo';
16    $targetFilePath = $tempDir . '/actual_file.txt';
17    $symlinkPath = $tempDir . '/link_to_actual_file.txt';
18
19    // 一時ディレクトリが存在しない場合は作成
20    if (!is_dir($tempDir)) {
21        mkdir($tempDir, 0777, true);
22    }
23
24    // ターゲットファイルを作成し、内容を書き込む
25    file_put_contents($targetFilePath, 'これはオリジナルのファイルです。');
26
27    // シンボリックリンクを作成
28    // 注意: Windows環境では管理者権限が必要な場合があり、作成に失敗することがあります。
29    // その場合、シンボリックリンクがない状態での動作となります。
30    $symlinkCreated = false;
31    if (!file_exists($symlinkPath) && !is_link($symlinkPath)) {
32        if (symlink($targetFilePath, $symlinkPath)) {
33            echo "INFO: シンボリックリンクを作成しました: $symlinkPath -> $targetFilePath\n\n";
34            $symlinkCreated = true;
35        } else {
36            echo "WARNING: シンボリックリンクの作成に失敗しました。管理者権限がないか、OSがサポートしていません。\n";
37            echo "          このデモは、シンボリックリンクがある場合の動作を完全には示せません。\n\n";
38        }
39    } else {
40        echo "INFO: シンボリックリンクは既に存在します: $symlinkPath\n\n";
41        $symlinkCreated = true; // 既に存在すれば、デモは可能です
42    }
43
44    // --- FilesystemIterator::FOLLOW_SYMLINKS なしの場合（デフォルトの挙動） ---
45    echo "--- FilesystemIterator::FOLLOW_SYMLINKS なしの場合 (デフォルト) ---\n";
46    echo "  - シンボリックリンクは『リンクそのもの』として扱われます。\n";
47    echo "  - SplFileInfo::isLink() は 'true' を返しますが、\n";
48    echo "  - SplFileInfo::isFile() は 'false'、SplFileInfo::getType() は 'link' を返す可能性があります。\n";
49    try {
50        // FilesystemIterator のコンストラクタにフラグを指定しない場合、
51        // FilesystemIterator::FOLLOW_SYMLINKS は適用されません。
52        $iterator = new FilesystemIterator($tempDir);
53        foreach ($iterator as $fileInfo) {
54            echo '  名前: ' . $fileInfo->getFilename();
55            echo ', タイプ: ' . $fileInfo->getType(); // 例: 'file' または 'link'
56            echo ', isLink(): ' . ($fileInfo->isLink() ? 'true' : 'false');
57            echo ', isFile(): ' . ($fileInfo->isFile() ? 'true' : 'false');
58            echo "\n";
59        }
60    } catch (UnexpectedValueException $e) {
61        echo "エラー: ディレクトリを読み込めません - " . $e->getMessage() . "\n";
62    }
63    echo "\n";
64
65    // --- FilesystemIterator::FOLLOW_SYMLINKS ありの場合 ---
66    echo "--- FilesystemIterator::FOLLOW_SYMLINKS ありの場合 ---\n";
67    echo "  - シンボリックリンクは『リンクが指す先のファイルやディレクトリ』として扱われます。\n";
68    echo "  - SplFileInfo::isLink() は 'true' を返しますが、\n";
69    echo "  - SplFileInfo::isFile() や SplFileInfo::getType() はリンク先の情報を反映します。\n";
70    try {
71        // FilesystemIterator::FOLLOW_SYMLINKS 定数をフラグとして指定します。
72        $iterator = new FilesystemIterator($tempDir, FilesystemIterator::FOLLOW_SYMLINKS);
73        foreach ($iterator as $fileInfo) {
74            echo '  名前: ' . $fileInfo->getFilename();
75            echo ', タイプ: ' . $fileInfo->getType(); // 例: 'file' (リンク先がファイルの場合)
76            echo ', isLink(): ' . ($fileInfo->isLink() ? 'true' : 'false');
77            echo ', isFile(): ' . ($fileInfo->isFile() ? 'true' : 'false'); // 例: 'true' (リンク先がファイルの場合)
78            echo "\n";
79        }
80    } catch (UnexpectedValueException $e) {
81        echo "エラー: ディレクトリを読み込めません - " . $e->getMessage() . "\n";
82    }
83    echo "\n";
84
85    // 2. クリーンアップ: 作成した一時ファイルとディレクトリを削除します。
86    echo "--- クリーンアップ ---\n";
87    // シンボリックリンクが存在すれば削除
88    if ($symlinkCreated && is_link($symlinkPath)) {
89        unlink($symlinkPath);
90        echo "INFO: シンボリックリンクを削除しました: $symlinkPath\n";
91    }
92    // ターゲットファイルを削除
93    if (file_exists($targetFilePath)) {
94        unlink($targetFilePath);
95        echo "INFO: ターゲットファイルを削除しました: $targetFilePath\n";
96    }
97    // 一時ディレクトリを削除 (ディレクトリが空の場合のみ)
98    // FilesystemIterator を使ってディレクトリが空であることを確認しています。
99    if (is_dir($tempDir) && !(new FilesystemIterator($tempDir))->valid()) {
100        rmdir($tempDir);
101        echo "INFO: 一時ディレクトリを削除しました: $tempDir\n";
102    } else if (is_dir($tempDir)) {
103        echo "WARNING: 一時ディレクトリ ($tempDir) が空でないため削除できませんでした。\n";
104    }
105}
106
107// デモンストレーション関数を実行します。
108demonstrateFilesystemIteratorFollowSymlinks();

PHP 8で導入されたFilesystemIterator::FOLLOW_SYMLINKSは、FilesystemIteratorがディレクトリ内のファイルを走査する際に、シンボリックリンクの扱い方を制御するための定数です。この定数自体に引数はなく、整数（int）値を返します。通常、FilesystemIteratorのコンストラクタの第2引数にフラグとして指定して使用します。

この定数を指定しない場合、FilesystemIteratorはシンボリックリンクを「リンクそのもの」として認識します。そのため、走査されたSplFileInfoオブジェクトのisLink()メソッドはtrueを返し、getType()メソッドは「link」といった値を返す傾向があります。

一方、FilesystemIterator::FOLLOW_SYMLINKSを指定すると、シンボリックリンクは「リンクが指す先のファイルやディレクトリ」として扱われます。この場合、SplFileInfoオブジェクトのisFile()やgetType()といったメソッドは、リンク先の実際のファイルやディレクトリの情報を反映するようになります。ただし、そのエントリがシンボリックリンクであること自体は変わらないため、isLink()メソッドは引き続きtrueを返します。この定数を使用することで、シンボリックリンクの先の内容を直接処理したい場合に便利です。

Copy
1<?php
2
3/**
4 * FilesystemIterator::FOLLOW_SYMLINKS 定数を使用して、
5 * ファイルシステムイテレータがシンボリックリンクをどのように扱うかをデモンストレーションします。
6 *
7 * この関数は一時ディレクトリ、ファイル、およびシンボリックリンクを作成し、
8 * FilesystemIterator でシンボリックリンクの追跡有無による挙動の違いを示します。
9 */
10function demonstrateFilesystemIteratorFollowSymlinks(): void
11{
12    // ユニークな名前で一時ディレクトリを作成
13    $testDir = sys_get_temp_dir() . '/php_symlink_demo_' . uniqid();
14    echo "テストディレクトリを作成中: {$testDir}\n";
15
16    // テスト用ディレクトリとファイルを作成
17    mkdir($testDir, 0777, true);
18    file_put_contents("{$testDir}/real_file.txt", "これは実ファイルです。");
19    mkdir("{$testDir}/sub_dir");
20    file_put_contents("{$testDir}/sub_dir/another_file.txt", "これはサブディレクトリ内のファイルです。");
21
22    // シンボリックリンクを作成
23    // 'real_file.txt' へのシンボリックリンク
24    symlink("{$testDir}/real_file.txt", "{$testDir}/symlink_to_file.txt");
25    // 'sub_dir' へのシンボリックリンク
26    symlink("{$testDir}/sub_dir", "{$testDir}/symlink_to_dir");
27
28    echo "\n--- 作成されたディレクトリ構造とシンボリックリンク ---\n";
29    echo "ルート: {$testDir}/\n";
30    echo "├── real_file.txt (実ファイル)\n";
31    echo "├── sub_dir/ (実ディレクトリ)\n";
32    echo "│   └── another_file.txt\n";
33    echo "├── symlink_to_file.txt -> real_file.txt (ファイルへのシンボリックリンク)\n";
34    echo "└── symlink_to_dir -> sub_dir/ (ディレクトリへのシンボリックリンク)\n";
35    echo "------------------------------------------------------\n\n";
36
37    echo "--- FilesystemIterator (シンボリックリンクを追跡しない) ---\n";
38    echo "    (isLink()がtrueの場合、そのエントリはシンボリックリンク自体を示します)\n";
39    // デフォルトでは FilesystemIterator はシンボリックリンクを追跡せず、
40    // それ自体をファイルシステムのエントリとして認識します。
41    // FilesystemIterator::SKIP_DOTS は '.' と '..' エントリを除外します。
42    // FilesystemIterator::UNIX_PATHS は Windows 環境でもパスの表示を一貫させます。
43    $iteratorNoFollow = new FilesystemIterator(
44        $testDir,
45        FilesystemIterator::SKIP_DOTS | FilesystemIterator::UNIX_PATHS
46    );
47    foreach ($iteratorNoFollow as $fileinfo) {
48        echo "名前: " . $fileinfo->getFilename();
49        echo ", タイプ: " . ($fileinfo->isDir() ? "ディレクトリ" : ($fileinfo->isFile() ? "ファイル" : ($fileinfo->isLink() ? "シンボリックリンク" : "不明")));
50        echo ", リンクか: " . ($fileinfo->isLink() ? "はい" : "いいえ");
51        echo ", 実パス: " . $fileinfo->getRealPath() . "\n";
52    }
53    echo "\n";
54
55    echo "--- FilesystemIterator (FilesystemIterator::FOLLOW_SYMLINKS を使用してシンボリックリンクを追跡) ---\n";
56    echo "    (isLink()がfalseの場合でも、その実体がシンボリックリンクであっても追跡された結果を示します)\n";
57    // FilesystemIterator::FOLLOW_SYMLINKS を指定すると、
58    // イテレータはシンボリックリンクが指す実体を辿り、その実体のタイプとして認識します。
59    // そのため、isLink()はfalseになり、isDir()やisFile()が実体のタイプを示します。
60    $iteratorFollow = new FilesystemIterator(
61        $testDir,
62        FilesystemIterator::SKIP_DOTS | FilesystemIterator::FOLLOW_SYMLINKS | FilesystemIterator::UNIX_PATHS
63    );
64    foreach ($iteratorFollow as $fileinfo) {
65        echo "名前: " . $fileinfo->getFilename();
66        echo ", タイプ: " . ($fileinfo->isDir() ? "ディレクトリ" : ($fileinfo->isFile() ? "ファイル" : ($fileinfo->isLink() ? "シンボリックリンク" : "不明")));
67        echo ", リンクか: " . ($fileinfo->isLink() ? "はい" : "いいえ"); // FOLLOW_SYMLINKS の場合、これは false になることが多い
68        echo ", 実パス: " . $fileinfo->getRealPath() . "\n";
69    }
70    echo "\n";
71
72    // テスト用ディレクトリをクリーンアップ
73    echo "テストディレクトリをクリーンアップ中: {$testDir}\n";
74    // シンボリックリンクとファイル、ディレクトリを安全に削除
75    if (file_exists("{$testDir}/symlink_to_file.txt")) {
76        unlink("{$testDir}/symlink_to_file.txt");
77    }
78    if (file_exists("{$testDir}/symlink_to_dir")) {
79        unlink("{$testDir}/symlink_to_dir");
80    }
81    if (file_exists("{$testDir}/real_file.txt")) {
82        unlink("{$testDir}/real_file.txt");
83    }
84    if (file_exists("{$testDir}/sub_dir/another_file.txt")) {
85        unlink("{$testDir}/sub_dir/another_file.txt");
86    }
87    if (is_dir("{$testDir}/sub_dir")) {
88        rmdir("{$testDir}/sub_dir");
89    }
90    if (is_dir($testDir)) {
91        rmdir($testDir);
92    }
93    echo "クリーンアップ完了。\n";
94}
95
96// 関数を実行してデモンストレーションを開始
97demonstrateFilesystemIteratorFollowSymlinks();

FilesystemIterator::FOLLOW_SYMLINKSは、PHPのFilesystemIteratorクラスに渡す定数で、ファイルシステムを走査する際にシンボリックリンクをどのように扱うかを設定します。この定数自体に引数はなく、戻り値は内部的な整数値（int型）です。

FilesystemIteratorのコンストラクタにFOLLOW_SYMLINKSを指定しない場合、イテレータはシンボリックリンクを独立したファイルシステムのエントリとして認識します。そのため、SplFileInfo::isLink()メソッドはtrueを返し、リンク先のファイルやディレクトリ自体ではなく、シンボリックリンクそのものを対象とします。

一方で、FOLLOW_SYMLINKS定数を指定すると、イテレータはシンボリックリンクが指し示す実体を追跡します。この場合、SplFileInfo::isLink()はfalseを返し、代わりにリンク先の実際の種類（ファイルかディレクトリか）に応じてisFile()やisDir()がtrueを返すようになります。

サンプルコードは、一時ディレクトリとシンボリックリンクを作成し、FilesystemIteratorでFOLLOW_SYMLINKSを使用した場合としない場合で、リストされるエントリのタイプやisLink()メソッドの結果がどのように異なるかを具体的に示しています。これにより、シンボリックリンクの追跡機能の有無による挙動の違いを明確に理解することができます。