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

Copy
1<?php
2
3// このスクリプトを実行するには、php.iniで 'phar.readonly = 0' を設定する必要がある場合があります。
4// これは、Pharアーカイブの作成や変更を許可するための設定です。
5
6// 一時的なPharDataアーカイブファイルのパスを定義します。
7// システムの一時ディレクトリを利用することで、どこでも動作しやすいようにします。
8$archivePath = sys_get_temp_dir() . '/sample_archive.tar';
9
10try {
11    // 新しいPharDataアーカイブを作成します。
12    // Phar::CREATE: 指定されたパスにアーカイブが存在しない場合に新しく作成します。
13    // Phar::OVERWRITE: 指定されたパスにアーカイブが既に存在する場合に上書きします。
14    // null: アーカイブのエイリアス（ここでは不要なためnull）
15    // Phar::TAR: アーカイブの形式（ここではTAR形式を指定）
16    $pharData = new PharData($archivePath, Phar::CREATE | Phar::OVERWRITE, null, Phar::TAR);
17
18    // 作成したアーカイブにサンプルファイルを追加します。
19    $pharData->addFromString('greeting.txt', 'Hello from PharData!');
20    $pharData->addFromString('data/info.txt', 'This is some important data.');
21
22    // アーカイブをGZIP形式で圧縮し、ディスクに書き込みます。
23    // この操作により、アーカイブファイルは '.tar.gz' 拡張子を持つようになります。
24    $pharData->compress(Phar::GZ);
25
26    // PharDataオブジェクトが参照しているアーカイブファイルの実際のパス（絶対パス）を取得します。
27    // このメソッドは、アーカイブファイルそのものがファイルシステム上のどこに存在するかを返します。
28    $realPath = $pharData->getRealPath();
29
30    if ($realPath !== false) {
31        echo "PharDataアーカイブファイルの実際のパス: " . $realPath . PHP_EOL;
32    } else {
33        echo "PharDataアーカイブファイルの実際のパスを取得できませんでした。" . PHP_EOL;
34    }
35
36} catch (PharException $e) {
37    // Phar関連の操作中に発生したエラーを捕捉します。
38    echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . PHP_EOL;
39} finally {
40    // 後処理として、作成したPharDataアーカイブファイルを削除します。
41    // ファイルのロックを解除するために、PharDataオブジェクトをunsetします。
42    unset($pharData);
43
44    // 圧縮後のファイル名（例: sample_archive.tar.gz）を考慮して削除します。
45    $compressedArchivePath = $archivePath . '.gz';
46    if (file_exists($compressedArchivePath)) {
47        unlink($compressedArchivePath);
48        echo "一時的なアーカイブファイル '" . $compressedArchivePath . "' を削除しました。" . PHP_EOL;
49    } elseif (file_exists($archivePath)) {
50        // もし圧縮が行われなかった場合（例: compress(Phar::NONE)）に備えて元のパスも確認します。
51        unlink($archivePath);
52        echo "一時的なアーカイブファイル '" . $archivePath . "' を削除しました。" . PHP_EOL;
53    }
54}

PharData::getRealPath()メソッドは、PHPのPharDataオブジェクトが操作するアーカイブファイル（例: .tarや.tar.gzファイルなど）の、ファイルシステム上での実際の絶対パスを取得するために使用されます。このメソッドは引数を一切取りません。

戻り値は、アーカイブファイルの絶対パスを示す文字列（string）です。しかし、パスの取得に失敗した場合や、アーカイブが物理ファイルと関連付けられていない場合にはfalseが返されます。

サンプルコードでは、まず一時ディレクトリにPharDataアーカイブ（sample_archive.tar）を作成し、いくつかのファイルをその中に追加しています。その後、アーカイブをGZIP形式で圧縮し、.tar.gzファイルに変換します。この圧縮されたアーカイブファイルに対し$pharData->getRealPath()を呼び出すことで、ファイルシステム上に存在するsample_archive.tar.gzファイルの完全なパスが取得され、画面に表示されます。この機能は、特にアーカイブファイルをプログラムで動的に作成・操作し、その最終的な保存場所を確認したい場合に非常に有用です。エラー発生時には適切なメッセージを表示し、スクリプト終了時には作成した一時ファイルを確実に削除する処理も含まれています。