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

Copy
1<?php
2
3/**
4 * DirectoryIterator::getLinkTarget() メソッドの動作を実演する関数。
5 * 一時的なシンボリックリンクを作成し、そのターゲットパスを取得します。
6 *
7 * @return void
8 */
9function demonstrateGetLinkTarget(): void
10{
11    // 一時的な作業ディレクトリとファイル、シンボリックリンクのパスを定義
12    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_link_test_' . uniqid();
13    $targetFile = $tempDir . DIRECTORY_SEPARATOR . 'original_file.txt';
14    $symbolicLink = $tempDir . DIRECTORY_SEPARATOR . 'my_link.lnk';
15
16    // 1. 作業用のディレクトリとターゲットファイルを作成
17    if (!mkdir($tempDir) && !is_dir($tempDir)) {
18        echo "エラー: 一時ディレクトリ '{$tempDir}' の作成に失敗しました。\n";
19        return;
20    }
21    file_put_contents($targetFile, "これはシンボリックリンクのターゲットとなるファイルです。\n");
22    echo "一時ディレクトリ: '{$tempDir}' を作成しました。\n";
23    echo "ターゲットファイル: '{$targetFile}' を作成しました。\n\n";
24
25    // 2. ターゲットファイルへのシンボリックリンクを作成
26    // 注意: Windows環境では、symlink() を使用するために管理者権限が必要な場合があります。
27    // PHP CLI を管理者権限で実行するか、事前に mklink コマンドでリンクを作成する必要があるかもしれません。
28    if (symlink($targetFile, $symbolicLink)) {
29        echo "シンボリックリンク '{$symbolicLink}' を作成しました。ターゲット: '{$targetFile}'\n\n";
30    } else {
31        echo "エラー: シンボリックリンク '{$symbolicLink}' の作成に失敗しました。\n";
32        echo "ヒント: Windows環境では、管理者権限でPHP CLIを実行する必要がある場合があります。\n";
33        // シンボリックリンクの作成に失敗した場合でも、後処理は実行
34        cleanupTemporaryFiles($tempDir, $targetFile, $symbolicLink);
35        return;
36    }
37
38    echo "--- DirectoryIterator を使用してリンクターゲットを探索します ---\n";
39
40    try {
41        // 3. 作成した一時ディレクトリに対して DirectoryIterator をインスタンス化
42        $iterator = new DirectoryIterator($tempDir);
43
44        foreach ($iterator as $fileInfo) {
45            // カレントディレクトリ(.)と親ディレクトリ(..)はスキップ
46            if ($fileInfo->isDot()) {
47                continue;
48            }
49
50            echo "項目名: " . $fileInfo->getFilename() . "\n";
51            echo "  絶対パス: " . $fileInfo->getPathname() . "\n";
52
53            // 4. 現在の項目がシンボリックリンクであるかを確認
54            if ($fileInfo->isLink()) {
55                echo "  これはシンボリックリンクです。\n";
56                // 5. シンボリックリンクのターゲットパスを取得
57                // 戻り値は string (成功) または false (失敗)
58                $linkTarget = $fileInfo->getLinkTarget();
59                if ($linkTarget !== false) {
60                    echo "  リンクターゲットパス: " . $linkTarget . "\n";
61                } else {
62                    echo "  警告: シンボリックリンクのターゲットパスの取得に失敗しました。\n";
63                }
64            } else {
65                echo "  これはシンボリックリンクではありません。\n";
66            }
67            echo "\n";
68        }
69    } catch (UnexpectedValueException $e) {
70        // DirectoryIterator のコンストラクタが失敗した場合の例外 (例: ディレクトリが存在しない)
71        echo "エラー: ディレクトリを読み込めませんでした。 " . $e->getMessage() . "\n";
72    } catch (Exception $e) {
73        // その他の予期せぬ例外
74        echo "予期せぬエラー: " . $e->getMessage() . "\n";
75    } finally {
76        // 6. 後処理: 作成した一時ファイル、シンボリックリンク、ディレクトリを削除
77        cleanupTemporaryFiles($tempDir, $targetFile, $symbolicLink);
78        echo "--- クリーンアップが完了しました ---\n";
79    }
80}
81
82/**
83 * demonstrateGetLinkTarget() 関数が作成した一時ファイル、シンボリックリンク、ディレクトリを削除します。
84 *
85 * @param string $tempDir       一時ディレクトリのパス
86 * @param string $targetFile    ターゲットファイルのパス
87 * @param string $symbolicLink  シンボリックリンクのパス
88 * @return void
89 */
90function cleanupTemporaryFiles(string $tempDir, string $targetFile, string $symbolicLink): void
91{
92    // シンボリックリンクが存在すれば削除
93    if (is_link($symbolicLink) || file_exists($symbolicLink)) {
94        unlink($symbolicLink);
95    }
96    // ターゲットファイルが存在すれば削除
97    if (file_exists($targetFile)) {
98        unlink($targetFile);
99    }
100    // 一時ディレクトリが空であれば削除 (rmdir は空でないディレクトリは削除できません)
101    if (is_dir($tempDir)) {
102        // scandir の結果が . と .. のみ（配列の要素が2つ）ならディレクトリは空と判断
103        if (count(scandir($tempDir)) === 2) {
104            rmdir($tempDir);
105        } else {
106            echo "警告: 一時ディレクトリ '{$tempDir}' が空でないため削除できませんでした。手動で削除してください。\n";
107        }
108    }
109}
110
111// demonstrateGetLinkTarget 関数を実行して、getLinkTarget メソッドの動作を確認します。
112demonstrateGetLinkTarget();
113

PHPのDirectoryIterator::getLinkTarget()メソッドは、ディレクトリ内の項目がシンボリックリンクである場合に、そのリンクが指し示す元のファイルやディレクトリのパスを取得するために使用されます。このメソッドはDirectoryIteratorが返すファイル情報オブジェクト（SplFileInfoのサブクラス）から利用でき、引数を必要としません。

サンプルコードでは、まず一時的な作業ディレクトリとファイルを作成し、そのファイルへのシンボリックリンクをプログラムで作成しています。その後、DirectoryIteratorを用いてこの一時ディレクトリを走査します。ループ内で各項目についてisLink()メソッドを使い、それがシンボリックリンクであるかどうかを判定します。もしシンボリックリンクであれば、getLinkTarget()メソッドを呼び出して、そのリンクが実際に指し示しているターゲットの絶対パスを取得し、画面に表示しています。

getLinkTarget()メソッドは、リンクのターゲットパスを文字列（string）として返しますが、何らかの理由でターゲットの取得に失敗した場合はfalseを返します。この戻り値を確認することで、正常にパスが取得できたかを判断することが重要です。

サンプルコードの実行後には、作成した一時ファイルやシンボリックリンク、ディレクトリが適切に削除され、環境が元の状態に戻るようにクリーンアップ処理も含まれています。Windows環境でシンボリックリンクを作成する際には、管理者権限が必要となる場合がある点にご留意ください。

Copy
1<?php
2
3/**
4 * PHPのDirectoryIterator::getLinkTargetメソッドの使用例を示します。
5 * このスクリプトはデモンストレーションのために一時的なファイルと
6 * シンボリックリンクを作成し、そのターゲットパスを取得した後に削除します。
7 * 
8 * 注意:
9 *   - シンボリックリンクの作成にはファイルシステムへの書き込み権限が必要です。
10 *   - Windows環境でsymlink()関数を使用する場合、管理者権限でPHPを実行する必要がある場合があります。
11 */
12function demonstrateDirectoryLinkTarget(): void
13{
14    // 一時ファイルとシンボリックリンクの名前を定義
15    $targetFileName = 'example_target_file.txt';
16    $linkName = 'example_symbolic_link.txt';
17    $currentDir = __DIR__; // スクリプトが実行されている現在のディレクトリ
18
19    // フルパスの生成
20    $targetFilePath = $currentDir . DIRECTORY_SEPARATOR . $targetFileName;
21    $linkPath = $currentDir . DIRECTORY_SEPARATOR . $linkName;
22
23    try {
24        // 1. シンボリックリンクが指し示すターゲットとなる一時ファイルを作成
25        if (file_put_contents($targetFilePath, "これはシンボリックリンクのターゲットです。\n") === false) {
26            echo "エラー: ターゲットファイル '{$targetFileName}' の作成に失敗しました。\n";
27            return;
28        }
29        echo "ターゲットファイル '{$targetFileName}' を作成しました。\n";
30
31        // 2. 作成したターゲットファイルへのシンボリックリンクを作成
32        // symlink($target, $link) の順序に注意
33        if (!symlink($targetFileName, $linkPath)) {
34            echo "エラー: シンボリックリンク '{$linkName}' の作成に失敗しました。\n";
35            echo "ヒント: Windowsでは管理者権限でPHPを実行する必要があるかもしれません。\n";
36            unlink($targetFilePath); // ターゲットファイルをクリーンアップ
37            return;
38        }
39        echo "シンボリックリンク '{$linkName}' を作成しました。\n";
40
41        // 3. DirectoryIterator を使って現在のディレクトリを走査し、シンボリックリンクのターゲットを取得
42        echo "\n現在のディレクトリ '{$currentDir}' を走査しています...\n";
43        $iterator = new DirectoryIterator($currentDir);
44
45        foreach ($iterator as $fileInfo) {
46            // 現在の要素がシンボリックリンクであるかを確認
47            if ($fileInfo->isLink()) {
48                $foundLinkName = $fileInfo->getFilename();
49                $target = $fileInfo->getLinkTarget(); // シンボリックリンクのターゲットパスを取得
50
51                echo "--- シンボリックリンクが見つかりました: {$foundLinkName} ---\n";
52                if ($target !== false) {
53                    // ターゲットパスが正常に取得できた場合
54                    echo "  ターゲットパス: {$target}\n";
55                } else {
56                    // ターゲットパスの取得に失敗した場合
57                    echo "  ターゲットパスの取得に失敗しました。\n";
58                }
59            }
60        }
61    } catch (UnexpectedValueException $e) {
62        // DirectoryIteratorのコンストラクタが失敗した場合の例外処理
63        echo "エラー: ディレクトリ '{$currentDir}' の処理中に問題が発生しました: " . $e->getMessage() . "\n";
64    } finally {
65        // 4. クリーンアップ: 作成した一時ファイルとシンボリックリンクを削除
66        echo "\nクリーンアップ中...\n";
67        if (file_exists($linkPath)) {
68            if (unlink($linkPath)) {
69                echo "シンボリックリンク '{$linkName}' を削除しました。\n";
70            } else {
71                echo "エラー: シンボリックリンク '{$linkName}' の削除に失敗しました。\n";
72            }
73        }
74        if (file_exists($targetFilePath)) {
75            if (unlink($targetFilePath)) {
76                echo "ターゲットファイル '{$targetFileName}' を削除しました。\n";
77            } else {
78                echo "エラー: ターゲットファイル '{$targetFileName}' の削除に失敗しました。\n";
79            }
80        }
81    }
82}
83
84// 関数の実行
85demonstrateDirectoryLinkTarget();

PHP 8で提供されるDirectoryIteratorクラスのgetLinkTargetメソッドは、ファイルシステム上のシンボリックリンクが実際に指し示す先のパスを取得するために使用されます。このメソッドは引数をとりません。処理が成功すると、シンボリックリンクが参照しているターゲットの絶対パスまたは相対パスが文字列として返されますが、ターゲットの取得に失敗した場合はfalseを返します。

サンプルコードは、このgetLinkTargetメソッドの具体的な使用方法を実演しています。まず、デモンストレーションのために一時的なファイルと、そのファイルを参照するシンボリックリンクを現在のディレクトリに作成します。次に、DirectoryIteratorオブジェクトを生成してディレクトリの内容を走査し、isLink()メソッドで各要素がシンボリックリンクであるかを確認します。シンボリックリンクが見つかった場合、そのDirectoryIteratorオブジェクトからgetLinkTarget()メソッドを呼び出し、シンボリックリンクが指し示す先のパスを取得し、画面に表示します。最後に、作成した一時ファイルとシンボリックリンクを削除してシステムをクリーンアップします。このコードを通じて、シンボリックリンクの実際の参照先をPHPプログラムで安全に取得する方法を学ぶことができます。