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

Copy
1<?php
2
3// このスクリプトは、PharDataアーカイブを作成し、ファイルを追加し、
4// そのファイルのエントリからアーカイブ内の相対パス（サブパス）を取得する方法を示します。
5// 実行にはPHPのphar拡張モジュールが有効になっている必要があります。
6
7// 一時的なPharDataアーカイブのファイル名を定義します。
8// .tar形式はPharDataで一般的に使用され、扱いが比較的シンプルです。
9$pharFileName = 'example_archive.tar';
10
11// アーカイブに追加するファイルの名前と内容を定義します。
12// このファイルはアーカイブ内で 'documents/report.txt' というパスで格納されます。
13$fileInArchive = 'documents/report.txt';
14$fileContent = "これはサンプルレポートの内容です。\nPHP PharDataのテスト用ファイル。";
15
16// --- アーカイブの作成とファイル追加 ---
17try {
18    // スクリプトの再実行時に既存のアーカイブが残っている場合を考慮し、先に削除します。
19    if (file_exists($pharFileName)) {
20        echo "既存のアーカイブ '{$pharFileName}' を削除します...\n";
21        PharData::unlinkArchive($pharFileName);
22    }
23
24    echo "PharDataアーカイブ '{$pharFileName}' を作成中...\n";
25
26    // PharDataオブジェクトを新規作成します。
27    // この時点で指定されたファイル名でアーカイブが作成（または上書き）されます。
28    $phar = new PharData($pharFileName);
29
30    // アーカイブにファイルを追加します。
31    // addFromString() メソッドは、指定したパスと内容でアーカイブ内にファイルを作成します。
32    echo "アーカイブにファイル '{$fileInArchive}' を追加中...\n";
33    $phar->addFromString($fileInArchive, $fileContent);
34
35    // アーカイブへの書き込みを完了させ、リソースを解放するためにPharDataオブジェクトをnullにします。
36    // これにより、アーカイブファイルが完全にディスクに書き込まれます。
37    $phar = null;
38    echo "アーカイブ '{$pharFileName}' の作成とファイル追加が完了しました。\n";
39
40    // --- アーカイブからの情報取得 ---
41    echo "\nアーカイブを読み込みモードでオープン中...\n";
42
43    // 読み込みモードで再度PharDataオブジェクトを作成します。
44    // これにより、既存のアーカイブの内容にアクセスできるようになります。
45    $phar = new PharData($pharFileName);
46
47    // アーカイブ内の特定のエントリ（ファイル）を取得します。
48    // 配列のオフセットアクセス（$phar['path/to/file']）でPharFileInfoオブジェクトを取得できます。
49    if (isset($phar[$fileInArchive])) {
50        $entry = $phar[$fileInArchive];
51
52        // getSubPathname() メソッドは、アーカイブのルートディレクトリからの相対パスを返します。
53        // これはアーカイブ内のファイルやディレクトリの位置を示します。
54        $subPathname = $entry->getSubPathname();
55
56        echo "アーカイブ内のファイル '{$fileInArchive}' のサブパス名（relativePath）は: '{$subPathname}'\n";
57        // この例では、'documents/report.txt' がそのまま出力されるはずです。
58
59    } else {
60        echo "エラー: アーカイブ内でファイル '{$fileInArchive}' が見つかりませんでした。\n";
61    }
62
63} catch (Exception $e) {
64    // 例外発生時のエラーハンドリング
65    echo "エラーが発生しました: " . $e->getMessage() . "\n";
66    echo "PharDataアーカイブの作成には、書き込み権限とphar拡張モジュールの有効化が必要です。\n";
67    echo "php.ini の phar.readonly が 'Off' に設定されているか確認してください。\n";
68} finally {
69    // --- クリーンアップ ---
70    // 処理が完了したら、作成した一時的なPharDataアーカイブファイルを削除します。
71    if (file_exists($pharFileName)) {
72        echo "\nクリーンアップ中: アーカイブファイル '{$pharFileName}' を削除します...\n";
73        PharData::unlinkArchive($pharFileName);
74        echo "アーカイブファイルが削除されました。\n";
75    }
76}
77
78?>

このサンプルコードは、PHPのPharDataクラスを用いてアーカイブファイル（例: .tar）を作成し、その中にファイルを追加した後、追加されたファイルのエントリからgetSubPathname()メソッドを使ってアーカイブ内の相対パスを取得する方法を、システムエンジニアを目指す初心者の方にもわかりやすく示しています。

PharDataクラスは、複数のファイルを一つのアーカイブファイルにまとめたり、そのアーカイブ内のファイルにアクセスしたりするための機能を提供します。サンプルではまず、example_archive.tarという一時的なアーカイブを新規作成し、documents/report.txtというパスでテキストファイルを追加しています。

ファイルが追加された後、再びアーカイブを読み込みモードで開き、追加したdocuments/report.txtのエントリ（PharFileInfoオブジェクト）を取得します。ここでgetSubPathname()メソッドが登場します。このメソッドは、引数を一切取らず、呼び出されたファイルエントリがアーカイブのルートディレクトリから見てどのような相対パスを持っているかを、文字列として返します。例えば、この例では"documents/report.txt"という文字列が返され、アーカイブ内でのファイルの正確な位置を把握できます。

スクリプトの実行にはPHPのphar拡張モジュールが有効になっている必要があります。また、アーカイブを作成する際は、php.ini設定のphar.readonlyがOffになっていることを確認してください。処理の最後に、作成したアーカイブファイルはクリーンアップとして削除されます。