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

Copy
1<?php
2
3// 一時的なPharアーカイブファイル名
4$pharFileName = 'my_archive.phar';
5// Pharアーカイブ内に格納するファイルのパスと名前
6$filePathInPhar = 'data/example.txt';
7// ファイルの内容
8$fileContent = 'これはPharアーカイブ内のサンプルファイルです。';
9
10try {
11    // 1. Pharアーカイブを新規作成します。
12    // 第一引数: 作成するPharアーカイブのファイル名。
13    // 第二引数: Phar::NONE はアーカイブ作成時のフラグ（特に指定なし）。
14    // 第三引数: アーカイブのエイリアス（Phar::loadPhar() で読み込む際に使用できます）。
15    $phar = new Phar($pharFileName, Phar::NONE, $pharFileName);
16
17    // Pharアーカイブの読み書きを許可する設定
18    // これを設定しないと、書き込みができない場合があります。
19    $phar->setStub("<?php Phar::mapPhar('$pharFileName'); __HALT_COMPILER(); ?>");
20
21    // 2. Pharアーカイブにファイルを追加します。
22    // addFromString(アーカイブ内のパス, ファイルの内容)
23    $phar->addFromString($filePathInPhar, $fileContent);
24
25    // 3. 追加したファイルのエントリ（PharFileEntryオブジェクト）を取得します。
26    // Pharオブジェクトは配列のようにアクセスでき、指定したパスのエントリを返します。
27    // このエントリは SplFileInfo を継承しており、ファイルに関する情報を提供します。
28    $fileEntry = $phar[$filePathInPhar];
29
30    // 4. getPathname() メソッドを呼び出して、アーカイブ内のファイルのフルパス名を取得します。
31    // このメソッドは、アーカイブ内部でのファイルのパスを返します。
32    $pathname = $fileEntry->getPathname();
33
34    echo "Pharアーカイブ名: " . $pharFileName . PHP_EOL;
35    echo "Pharアーカイブ内に格納したファイル: " . $filePathInPhar . PHP_EOL;
36    echo "取得したファイルのパス名: " . $pathname . PHP_EOL;
37
38    // 5. Pharアーカイブへの変更を確定し、ディスクに書き込みます。
39    // これを呼び出さないと、Pharファイルが正しく作成されない場合があります。
40    $phar->stopBuffering();
41
42} catch (PharException $e) {
43    // Phar関連のエラーが発生した場合の処理
44    echo "PharException: " . $e->getMessage() . PHP_EOL;
45} catch (Exception $e) {
46    // その他の一般的なエラーが発生した場合の処理
47    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
48} finally {
49    // 6. 後処理として、作成した一時的なPharアーカイブファイルを削除します。
50    if (file_exists($pharFileName)) {
51        // Phar::unlinkArchive() を使用してアーカイブを安全に削除します。
52        Phar::unlinkArchive($pharFileName);
53        echo "一時的なPharアーカイブ '" . $pharFileName . "' を削除しました。" . PHP_EOL;
54    }
55}

このPHPサンプルコードは、Phar（ファー）アーカイブと呼ばれる、複数のファイルを一つのパッケージにまとめる機能において、特定のファイルがアーカイブ内でどのようなパスを持っているかを取得する方法を示しています。まず、my_archive.pharという名前でPharアーカイブを新規作成し、その中にdata/example.txtというパスでサンプルファイルを追加します。

ファイルがアーカイブに追加されると、$phar[$filePathInPhar]のようにアクセスすることで、そのファイルの詳細情報を表すPharFileEntryオブジェクトが取得できます。このPharFileEntryは、ファイルに関する様々な情報を持つオブジェクトです。

そして、この$fileEntryオブジェクトに対してgetPathname()メソッドを呼び出すと、Pharアーカイブの内部におけるそのファイルの相対パス名が文字列として返されます。このメソッドは引数を必要とせず、呼び出すだけで、今回の場合ではdata/example.txtという文字列が戻り値として得られます。このパスは、アーカイブ内でそのファイルを一意に識別するために利用されます。

コードの最後では、作成したPharアーカイブをディスクに保存し、処理の完了後には一時ファイルとして作成されたアーカイブを削除する一連の操作が行われ、Pharアーカイブ内のファイルパスの管理方法を具体的に学ぶことができます。