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

Copy
1<?php
2
3// Pharアーカイブを操作するため、php.iniで 'phar.readonly = Off' を設定するか、
4// このスクリプトの冒頭で ini_set('phar.readonly', '0'); を実行する必要があります。
5// 本番環境では phar.readonly は On が推奨されます。
6
7/**
8 * Pharアーカイブ内のファイルがリンクである場合に、そのターゲットを取得するサンプル。
9 *
10 * この関数は、一時的なPharアーカイブを作成し、その中に通常のファイルと、
11 * そのファイルへの内部的なシンボリックリンクを追加します。
12 * その後、各エントリについて PharFileInfo::getLinkTarget() メソッドを呼び出し、
13 * ファイルがリンクである場合のターゲット（またはリンクではないことを示す）を表示します。
14 */
15function demonstratePharLinkTarget(): void
16{
17    $pharPath = __DIR__ . '/example.phar'; // 一時的なPharファイルのパス
18
19    // 既存のPharファイルがあれば削除（スクリプトの繰り返し実行のため）
20    if (file_exists($pharPath)) {
21        unlink($pharPath);
22    }
23
24    try {
25        // Pharアーカイブの書き込みを一時的に許可
26        ini_set('phar.readonly', '0');
27
28        // 新しいPharアーカイブを作成
29        $phar = new Phar($pharPath);
30        $phar->startBuffering(); // Pharファイルの変更をバッファリング開始
31
32        // 1. 通常のファイルをPharアーカイブに追加
33        $phar->addFromString('original_file.txt', 'これはオリジナルのファイルコンテンツです。');
34        echo "Pharに 'original_file.txt' を追加しました。\n";
35
36        // 2. 'original_file.txt' への内部シンボリックリンクをPharアーカイブに追加
37        $phar->addLink('link_to_original.txt', 'original_file.txt');
38        echo "Pharに 'link_to_original.txt' (original_file.txtへのリンク) を追加しました。\n";
39
40        $phar->stopBuffering(); // 変更を適用してPharファイルを閉じる
41        echo "Pharアーカイブ '{$pharPath}' を作成しました。\n\n";
42
43        // 3. 各PharエントリのPharFileInfoオブジェクトを取得し、getLinkTarget()を呼び出す
44        
45        // 通常のファイルのPharFileInfoオブジェクトを取得
46        $originalFileInfo = $phar['original_file.txt'];
47        // getLinkTarget()を呼び出し、リンクターゲットを取得
48        $originalTarget = $originalFileInfo->getLinkTarget();
49
50        echo "--- original_file.txt の情報 ---\n";
51        echo "ファイル名: " . $originalFileInfo->getFilename() . "\n";
52        // getLinkTarget()はリンクでない場合にnullを返すため、条件分岐で表示
53        echo "リンクターゲット: " . ($originalTarget === null ? "リンクではありません" : $originalTarget) . "\n\n";
54
55        // リンクファイルのPharFileInfoオブジェクトを取得
56        $linkFileInfo = $phar['link_to_original.txt'];
57        // getLinkTarget()を呼び出し、リンクターゲットを取得
58        $linkTarget = $linkFileInfo->getLinkTarget();
59
60        echo "--- link_to_original.txt の情報 ---\n";
61        echo "ファイル名: " . $linkFileInfo->getFilename() . "\n";
62        echo "リンクターゲット: " . ($linkTarget === null ? "リンクではありません" : $linkTarget) . "\n\n";
63
64    } catch (Exception $e) {
65        echo "エラーが発生しました: " . $e->getMessage() . "\n";
66    } finally {
67        // 最終処理: 作成したPharアーカイブを削除し、phar.readonly設定を元に戻す
68
69        // Pharオブジェクトの参照を解除することで、ファイルロックを解放
70        if (isset($phar)) {
71            unset($phar);
72        }
73        // Pharファイルを物理的に削除
74        if (file_exists($pharPath)) {
75            unlink($pharPath);
76            echo "Pharアーカイブ '{$pharPath}' を削除しました。\n";
77        }
78        // phar.readonly を元の推奨設定 '1' に戻す
79        ini_set('phar.readonly', '1');
80    }
81}
82
83// サンプル関数を実行
84demonstratePharLinkTarget();

PharFileInfo::getLinkTarget() メソッドは、PHPのPharアーカイブ（複数のファイルを一つにまとめたファイル）内に含まれるファイルが、他のファイルへの内部的なリンクである場合に、そのリンクが指し示すターゲットのパスを取得する際に使用されます。このメソッドは引数を必要とせず、リンクターゲットのパスを文字列として返します。もし対象のファイルがリンクではない場合は、nullを返します。

このサンプルコードでは、まず一時的なPharアーカイブを作成し、その中に通常のテキストファイル（original_file.txt）と、そのファイルへの内部シンボリックリンク（link_to_original.txt）を追加しています。その後、それぞれのファイルに対応するPharFileInfoオブジェクトを取得し、getLinkTarget() メソッドを呼び出しています。

実行結果として、original_file.txtのように通常のファイルに対してメソッドを呼び出した場合はnullが返されるため、「リンクではありません」と表示されます。一方、link_to_original.txtのように内部リンクとして作成されたファイルに対しては、リンク先であるoriginal_file.txtという文字列が正確に返され、そのターゲットが表示されることを確認できます。この機能は、Pharアーカイブの内部構造をプログラムで確認し、リンクの有無やその参照先を特定したい場合に役立ちます。

Copy
1<?php
2
3/**
4 * PharFileInfo::getLinkTarget() メソッドのサンプルコード
5 *
6 * このスクリプトは、Pharアーカイブを作成し、その中のファイル情報を取得する際に
7 * PharFileInfo::getLinkTarget() メソッドがどのように使用されるかを示します。
8 *
9 * キーワード「php get_permalink」はWebコンテンツの永続的なURLを取得する概念ですが、
10 * getLinkTarget() はPharアーカイブ内部のファイルシステム上のリンク先を取得するもので、
11 * 文脈は異なります。しかし、どちらも「リンクのターゲット」を取得するという点で関連付けられます。
12 *
13 * NOTE: Pharアーカイブの作成には、php.iniで 'phar.readonly = Off' に設定されている必要があります。
14 *       コマンドラインから実行する場合の例: php -d phar.readonly=0 your_script.php
15 */
16
17// 作成するPharアーカイブのファイル名
18$pharFileName = 'example_archive.phar';
19
20// 一時ディレクトリを作成し、アーカイブに含めるダミーファイルを準備
21$tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'phar_example_' . uniqid();
22
23// ----------------------------------------------------
24// 1. Pharアーカイブの準備
25// ----------------------------------------------------
26// 一時ディレクトリを作成
27if (!mkdir($tempDir, 0777, true) && !is_dir($tempDir)) {
28    exit("エラー: 一時ディレクトリ '$tempDir' の作成に失敗しました。\n");
29}
30
31// アーカイブに含めるダミーファイルを作成
32file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'document.txt', 'これはドキュメントファイルの内容です。');
33file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'image.jpg', 'ダミー画像データ'); // 実際には画像ではない
34file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'README.md', '# サンプルPharアーカイブ');
35
36try {
37    // Pharアーカイブを新規作成。0 は何のフラグも設定しないことを意味します。
38    // 'example_archive.phar' はアーカイブの内部名です。
39    $phar = new Phar($pharFileName, 0, 'example_archive.phar');
40    $phar->startBuffering(); // 書き込み操作をバッファリング開始
41
42    // 一時ディレクトリ内の指定された拡張子のファイルをPharアーカイブに追加
43    // Phar::buildFromDirectory() は、ファイルシステム上のシンボリックリンクを
44    // 通常、解決してPhar内部では通常のファイルとして追加します。
45    // そのため、PharFileInfo::isLink() はほとんどの場合 false を返します。
46    $phar->buildFromDirectory($tempDir, '/\.(txt|jpg|md)$/');
47
48    // Pharファイルを直接実行可能にするためのスタブを設定（オプション）
49    $phar->setStub($phar->createDefaultStub());
50    $phar->stopBuffering(); // バッファリング終了、Pharファイルを確定
51
52    echo "Pharアーカイブ '$pharFileName' を作成しました。\n";
53
54} catch (Exception $e) {
55    echo "エラー: Pharアーカイブの作成中に問題が発生しました。\n";
56    echo "メッセージ: " . $e->getMessage() . "\n";
57    goto cleanup; // エラー発生時はクリーンアップへジャンプ
58}
59
60// ----------------------------------------------------
61// 2. 作成されたPharアーカイブを開き、PharFileInfo::getLinkTarget() を使用
62// ----------------------------------------------------
63try {
64    // 読み込みモードでPharアーカイブを開く
65    $phar = new Phar($pharFileName);
66
67    echo "\n--- Pharアーカイブ内のエントリ情報 ---\n";
68    // アーカイブ内の各エントリ（ファイル）をループ処理
69    foreach ($phar as $entryName => $fileInfo) {
70        /* @var PharFileInfo $fileInfo */ // 型ヒント（IDEの支援用）
71
72        echo "エントリ名: " . $fileInfo->getFilename();
73
74        // エントリがPhar内部のリンクかどうかをチェック
75        // 通常のPhar::buildFromDirectory()で作成されたアーカイブでは、
76        // このメソッドは false を返すことがほとんどです。
77        // Phar内部の「リンク」は、特定のツール（例: PEARインストーラ）によって
78        // 特別な形式で作成されたPharアーカイブに対して主に有効です。
79        if ($fileInfo->isLink()) {
80            // エントリがリンクである場合、そのリンクが指すターゲットパスを取得します。
81            $linkTarget = $fileInfo->getLinkTarget();
82            echo " (タイプ: リンク, ターゲット: " . ($linkTarget ?? 'N/A') . ")";
83        } else {
84            // リンクではない通常のファイルの場合
85            echo " (タイプ: 通常ファイル)";
86        }
87        echo "\n";
88    }
89    echo "----------------------------------------\n";
90
91} catch (Exception $e) {
92    echo "エラー: Pharアーカイブの読み込み中に問題が発生しました。\n";
93    echo "メッセージ: " . $e->getMessage() . "\n";
94}
95
96cleanup:
97// ----------------------------------------------------
98// 3. 後処理（作成した一時ファイルとPharアーカイブを削除）
99// ----------------------------------------------------
100echo "\n一時ファイルのクリーンアップ中...\n";
101if (file_exists($pharFileName)) {
102    unlink($pharFileName);
103}
104if (is_dir($tempDir)) {
105    // 一時ディレクトリ内のファイルをすべて削除
106    $files = glob($tempDir . DIRECTORY_SEPARATOR . '*');
107    if (is_array($files)) {
108        foreach ($files as $file) {
109            if (is_file($file) || is_link($file)) {
110                unlink($file);
111            }
112        }
113    }
114    // 一時ディレクトリ自体を削除
115    rmdir($tempDir);
116}
117echo "クリーンアップ完了。\n";
118
119?>

PharFileInfo::getLinkTarget()メソッドは、PHPのPharアーカイブに含まれるファイル情報が「リンク」である場合に、そのリンクが実際に指し示すターゲットのパスを取得します。このメソッドは引数を必要としません。戻り値は?string型で、リンク先が存在すればそのパスを文字列として返し、リンクでなかったりターゲットが不明な場合はnullを返します。

このメソッドが有効となるのは、Pharアーカイブ内部で特別な形式のファイルリンクが作成されている場合です。サンプルコードで示されているように、通常Phar::buildFromDirectory()などで外部のシンボリックリンクを含むファイルをアーカイブに追加した場合、Pharはリンクを解決してその実体を通常のファイルとして格納します。そのため、ほとんどのケースではPharFileInfo::isLink()がfalseとなり、getLinkTarget()が意味のある値を返すことは稀です。

キーワードの「php get_permalink」はWebコンテンツの永続的なURLを取得する概念ですが、getLinkTarget()はPharアーカイブという独立したファイルシステム内部のリンク先を取得するもので、文脈は異なります。しかし、どちらも「リンクが指し示す先」を取得するという点で関連性を見出すことができます。