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

Copy
1<?php
2
3/**
4 * FilesystemIterator::isLink と unlink の使用例を示す関数
5 *
6 * この関数は、一時ファイルとシンボリックリンクを作成し、
7 * FilesystemIterator を使ってディレクトリを走査し、
8 * シンボリックリンクを検出して unlink で削除する方法を示します。
9 * システムエンジニアを目指す初心者の方にも、ファイルシステム操作の基本を理解してもらうことを目的としています。
10 *
11 * @param string $baseDir ベースとなるディレクトリ。通常は __DIR__ を指定します。
12 */
13function demonstrateFilesystemIteratorIsLink(string $baseDir): void
14{
15    // 一時的なディレクトリとファイルの名前を定義
16    $tempDir = $baseDir . '/temp_fs_test_' . uniqid();
17    $realFileName = 'real_file.txt';
18    $linkFileName = 'symlink_to_real_file.lnk';
19
20    $realFilePath = $tempDir . '/' . $realFileName;
21    $linkPath = $tempDir . '/' . $linkFileName;
22
23    // --- 準備: 一時ディレクトリ、ファイル、シンボリックリンクの作成 ---
24
25    // 1. 一時ディレクトリを作成
26    if (!mkdir($tempDir) && !is_dir($tempDir)) {
27        echo "エラー: 一時ディレクトリの作成に失敗しました: {$tempDir}\n";
28        return; // 処理を中断
29    }
30    echo "一時ディレクトリを作成しました: {$tempDir}\n";
31
32    // 2. 実際のファイルを作成
33    if (file_put_contents($realFilePath, 'これは実際のファイルです。') === false) {
34        echo "エラー: 実際のファイルの作成に失敗しました: {$realFilePath}\n";
35        rmdir($tempDir); // 作成したディレクトリをクリーンアップして終了
36        return;
37    }
38    echo "ファイルを作成しました: {$realFilePath}\n";
39
40    // 3. シンボリックリンクを作成
41    // 注意: Windows環境では管理者権限が必要な場合があり、失敗することがあります。
42    // シンボリックリンクの作成に失敗した場合、以下の FilesystemIterator::isLink() は
43    // この要素に対して常に false を返すことになります。
44    $symlinkCreated = false;
45    if (symlink($realFilePath, $linkPath)) {
46        echo "シンボリックリンクを作成しました: {$linkPath}\n";
47        $symlinkCreated = true;
48    } else {
49        echo "注意: シンボリックリンクの作成に失敗しました。この環境では symlink 関数がサポートされていないか、権限が不足している可能性があります。\n";
50        echo "      この場合、isLink() はシンボリックリンクを検出できません。\n";
51    }
52
53    echo "\n--- ディレクトリ走査開始 ---\n";
54
55    try {
56        // FilesystemIterator を使用してディレクトリを走査します。
57        // FilesystemIterator::SKIP_DOTS フラグは、特殊ディレクトリ '.' と '..' をスキップします。
58        $iterator = new FilesystemIterator($tempDir, FilesystemIterator::SKIP_DOTS);
59
60        foreach ($iterator as $fileInfo) {
61            $currentPath = $fileInfo->getPathname();
62            echo "要素: {$currentPath}\n";
63
64            // FilesystemIterator::isLink() メソッドで現在の要素がシンボリックリンクかどうかをチェックします。
65            if ($fileInfo->isLink()) {
66                echo "  これはシンボリックリンクです。\n";
67                
68                // キーワード「unlink」に関連付け、シンボリックリンクを削除する例です。
69                // unlink() 関数は、ファイルやシンボリックリンク自体を削除しますが、
70                // シンボリックリンクの場合、リンク先のファイルには影響を与えません。
71                if (unlink($currentPath)) {
72                    echo "  シンボリックリンクを削除しました: {$currentPath}\n";
73                } else {
74                    echo "  シンボリックリンクの削除に失敗しました: {$currentPath}\n";
75                }
76            } else {
77                echo "  これはシンボリックリンクではありません。\n";
78            }
79        }
80    } catch (UnexpectedValueException $e) {
81        // 指定されたパスがディレクトリでない、または読み取れない場合に発生
82        echo "エラー: ディレクトリ '{$tempDir}' を読み込めませんでした。({$e->getMessage()})\n";
83    }
84
85    echo "\n--- ディレクトリ走査終了 ---\n";
86
87    // --- クリーンアップ: 作成したファイルとディレクトリを削除 ---
88    echo "\n--- クリーンアップ開始 ---\n";
89
90    // 実際のファイルを削除します。（シンボリックリンクが削除されても、実体は残るため）
91    if (file_exists($realFilePath)) {
92        if (unlink($realFilePath)) {
93            echo "実際のファイルを削除しました: {$realFilePath}\n";
94        } else {
95            echo "実際のファイルの削除に失敗しました: {$realFilePath}\n";
96        }
97    }
98
99    // シンボリックリンクが作成されたが、何らかの理由で前のステップで削除できなかった場合に備えて再試行
100    if ($symlinkCreated && file_exists($linkPath)) {
101        if (unlink($linkPath)) {
102            echo "残っていたシンボリックリンクを削除しました: {$linkPath}\n";
103        } else {
104            echo "残っていたシンボリックリンクの削除に失敗しました: {$linkPath}\n";
105        }
106    }
107
108    // 一時ディレクトリが空になったら削除します。
109    // rmdir() 関数は、空のディレクトリしか削除できません。
110    if (is_dir($tempDir)) {
111        // ディレクトリ内にまだファイルが残っていないか確認
112        $filesInTemp = array_diff(scandir($tempDir), ['.', '..']);
113        if (empty($filesInTemp)) {
114            if (rmdir($tempDir)) {
115                echo "一時ディレクトリを削除しました: {$tempDir}\n";
116            } else {
117                echo "一時ディレクトリの削除に失敗しました: {$tempDir}\n";
118            }
119        } else {
120            echo "注意: 一時ディレクトリにまだファイルが残っています (" . implode(', ', $filesInTemp) . ")。\n";
121            echo "      手動で削除する必要があるかもしれません。\n";
122        }
123    }
124    echo "--- クリーンアップ終了 ---\n";
125}
126
127// 現在のスクリプトがあるディレクトリを作業ベースディレクトリとして指定して関数を実行します。
128demonstrateFilesystemIteratorIsLink(__DIR__);
129
130?>

このサンプルコードは、PHPのFilesystemIterator::isLinkメソッドとunlink関数の具体的な使用方法を示しています。

FilesystemIterator::isLink()は、FilesystemIteratorを用いてディレクトリを走査する際に取得できるファイル情報（SplFileInfoオブジェクト）が、シンボリックリンクであるかどうかを判定するためのメソッドです。このメソッドは引数を必要とせず、要素がシンボリックリンクであればtrue、そうでなければfalseを真偽値（bool）で返します。

一方、unlink()関数は、ファイルやシンボリックリンクを削除するために用いられます。シンボリックリンクに対してunlink()を実行しても、そのリンクが指し示す元のファイルには影響を与えず、シンボリックリンク自体のみが削除されます。

コードでは、まず一時ディレクトリを作成し、その中に実際のファイルと、そのファイルへのシンボリックリンクを作成します。その後、FilesystemIteratorを使ってこの一時ディレクトリ内の各要素を順に処理します。各要素についてisLink()メソッドでシンボリックリンクであるかを確認し、もしシンボリックリンクであれば、unlink()関数を用いてそれを削除します。最後に、作成した一時ファイルやディレクトリを全てクリーンアップします。この一連の流れを通じて、ファイルシステム操作におけるシンボリックリンクの検出と削除の基本を理解することができます。

Copy
1<?php
2
3/**
4 * FilesystemIterator::isLink() メソッドの使用例をデモンストレーションします。
5 *
6 * この関数は一時的なファイル、ディレクトリ、シンボリックリンクを作成し、
7 * FilesystemIterator を使用してそれらを走査します。
8 * 各項目がシンボリックリンクであるかどうかを isLink() メソッドで判定し、
9 * その情報と「unlink 削除 できない」というキーワードに関連する注意点を表示します。
10 */
11function demonstrateFilesystemIteratorIsLink(): void
12{
13    // 一時ディレクトリのパスを定義
14    $tempDir = __DIR__ . '/temp_islink_demo_' . uniqid();
15
16    // 1. 一時ディレクトリの作成
17    if (!mkdir($tempDir) && !is_dir($tempDir)) {
18        echo "エラー: 一時ディレクトリ '{$tempDir}' の作成に失敗しました。\n";
19        return;
20    }
21    echo "一時ディレクトリ '{$tempDir}' を作成しました。\n";
22
23    // テスト用のファイル、ディレクトリ、シンボリックリンクのパスを定義
24    $regularFile = $tempDir . '/regular_file.txt';
25    $regularDir = $tempDir . '/regular_dir';
26    $symlinkToFile = $tempDir . '/link_to_file.txt';
27    $symlinkToDir = $tempDir . '/link_to_dir';
28
29    try {
30        // 2. テスト用のファイル、ディレクトリを作成
31        file_put_contents($regularFile, "これは通常のファイルです。\n");
32        echo "通常のファイル '{$regularFile}' を作成しました。\n";
33        mkdir($regularDir);
34        echo "通常のディレクトリ '{$regularDir}' を作成しました。\n";
35
36        // 3. シンボリックリンクを作成
37        // Windows環境では管理者権限が必要な場合があります。
38        // symlink() の第一引数はターゲット（リンク先）、第二引数はリンク名です。
39        if (symlink($regularFile, $symlinkToFile)) {
40            echo "シンボリックリンク '{$symlinkToFile}' (ファイルへのリンク) を作成しました。\n";
41        } else {
42            echo "注意: シンボリックリンク '{$symlinkToFile}' の作成に失敗しました。管理者権限が必要な場合があります。\n";
43        }
44
45        if (symlink($regularDir, $symlinkToDir)) {
46            echo "シンボリックリンク '{$symlinkToDir}' (ディレクトリへのリンク) を作成しました。\n";
47        } else {
48            echo "注意: シンボリックリンク '{$symlinkToDir}' の作成に失敗しました。管理者権限が必要な場合があります。\n";
49        }
50
51        echo "\n--- FilesystemIterator::isLink() のデモンストレーション ---\n";
52
53        // FilesystemIterator を使用して一時ディレクトリを走査します。
54        // FilesystemIterator::SKIP_DOTS フラグで "." と ".." をスキップします。
55        $iterator = new FilesystemIterator($tempDir, FilesystemIterator::SKIP_DOTS);
56
57        foreach ($iterator as $fileInfo) {
58            echo "項目名: " . $fileInfo->getFilename();
59
60            if ($fileInfo->isLink()) {
61                // isLink() は、現在のイテレータ項目がシンボリックリンクである場合に true を返します。
62                // 「php unlink 削除 できない」というキーワードに関連して、
63                // シンボリックリンクの削除には特別な注意が必要です。
64                // unlink() 関数でシンボリックリンクを削除すると、削除されるのはリンク自体であり、
65                // リンク先のファイルやディレクトリは影響を受けません。
66                // もしリンク先を削除したい場合は、別途そのパスに対して削除操作を行う必要があります。
67                echo " [種類: シンボリックリンク]";
68                // readlink() を使用してリンクのターゲット（参照先）を取得できます。
69                $target = realpath($fileInfo->getPathname()) ?: readlink($fileInfo->getPathname());
70                echo " -> ターゲット: " . ($target !== false ? $target : "不明");
71            } elseif ($fileInfo->isDir()) {
72                echo " [種類: ディレクトリ]";
73            } elseif ($fileInfo->isFile()) {
74                echo " [種類: ファイル]";
75            }
76            echo "\n";
77        }
78
79    } finally {
80        // 後処理: 作成したファイルとディレクトリをクリーンアップします。
81        // symlink() が失敗している可能性も考慮し、file_exists() で存在確認をします。
82        echo "\n--- クリーンアップ中 ---\n";
83        if (file_exists($symlinkToFile)) {
84            unlink($symlinkToFile); // シンボリックリンク自体を削除
85            echo "シンボリックリンク '{$symlinkToFile}' を削除しました。\n";
86        }
87        if (file_exists($symlinkToDir)) {
88            unlink($symlinkToDir); // シンボリックリンク自体を削除
89            echo "シンボリックリンク '{$symlinkToDir}' を削除しました。\n";
90        }
91        if (file_exists($regularFile)) {
92            unlink($regularFile);
93            echo "ファイル '{$regularFile}' を削除しました。\n";
94        }
95        if (is_dir($regularDir)) {
96            rmdir($regularDir);
97            echo "ディレクトリ '{$regularDir}' を削除しました。\n";
98        }
99        if (is_dir($tempDir)) {
100            rmdir($tempDir);
101            echo "一時ディレクトリ '{$tempDir}' を削除しました。\n";
102        }
103        echo "クリーンアップが完了しました。\n";
104    }
105}
106
107// 関数の実行
108demonstrateFilesystemIteratorIsLink();

PHP 8のFilesystemIterator::isLink()メソッドは、ファイルシステムを走査する際に、現在の項目がシンボリックリンクであるかどうかを判定するために使用されます。このメソッドは引数を受け取らず、真偽値（bool）を返します。項目がシンボリックリンクであればtrueを、そうでなければfalseを返します。

提供されたサンプルコードでは、一時的なファイル、ディレクトリ、シンボリックリンクを作成し、FilesystemIteratorを使ってそれらを一つずつ走査します。foreachループの中で$fileInfo->isLink()が呼び出され、各項目がシンボリックリンクであるかどうかが判断され、その種類が表示されます。

特に「php unlink 削除 できない」というキーワードに関連して重要な注意点があります。unlink()関数はファイルやシンボリックリンクを削除するために使われますが、シンボリックリンクに対してunlink()を実行した場合、削除されるのはあくまでシンボリックリンク自体です。そのリンクが指し示している元のファイルやディレクトリは影響を受けずに残ります。もしリンク先のファイルを削除したい場合は、別途そのパスを指定して削除操作を行う必要があります。isLink()メソッドを用いることで、走査している項目がシンボリックリンクであるかを正確に判断し、削除時に誤ってリンク先を消してしまうといった意図しない結果を防ぐのに役立ちます。