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

Copy
1<?php
2
3/**
4 * このスクリプトは、PHPのPhar拡張機能を使用してアーカイブを作成し、
5 * その中の各ファイルのサブパス名（アーカイブ内での相対パス）を取得する方法を示します。
6 *
7 * 注意: Pharアーカイブを作成するには、php.ini設定の 'phar.readonly' が 'Off' である必要があります。
8 *       CLI環境では通常 'Off' ですが、ウェブサーバー環境では 'On' の場合があります。
9 */
10
11// 一時的なPharファイルを作成するパスを定義します
12$pharFilePath = __DIR__ . '/my_sample_archive.phar';
13
14// 既存のPharファイルがあれば、クリーンアップのために削除します
15if (file_exists($pharFilePath)) {
16    unlink($pharFilePath);
17}
18
19// ----------------------------------------------------
20// ステップ1: Pharアーカイブの作成とファイル格納
21// ----------------------------------------------------
22try {
23    // 新しいPharアーカイブを作成します (書き込みモード)
24    $phar = new Phar($pharFilePath);
25
26    // Pharアーカイブに文字列データをファイルとして追加します
27    // サブディレクトリを含むパスを指定することで、getSubPathnameの動作を確認できます
28    $phar->addFromString('file1.txt', 'This is the content of file1.');
29    $phar->addFromString('subdir/file2.txt', 'This is the content of file2 in a subdirectory.');
30    $phar->addFromString('another_subdir/deep/file3.txt', 'Content of file3 in a deeper subdirectory.');
31
32    echo "Pharアーカイブ '{$pharFilePath}' を作成し、ファイルを格納しました。\n\n";
33
34} catch (PharException $e) {
35    echo "エラー: Pharアーカイブの作成中に問題が発生しました: " . $e->getMessage() . "\n";
36    // エラーが発生した場合も、一時ファイルは削除して終了します
37    if (file_exists($pharFilePath)) {
38        unlink($pharFilePath);
39    }
40    exit(1);
41}
42
43// Pharオブジェクトをunsetすることで、アーカイブが適切に閉じられ、ディスクに書き込まれます
44unset($phar);
45
46// ----------------------------------------------------
47// ステップ2: 作成したPharアーカイブを開き、各エントリのサブパス名を取得
48// ----------------------------------------------------
49try {
50    // 既存のPharアーカイブを読み込みモードで開きます
51    $phar = new Phar($pharFilePath);
52
53    echo "Pharアーカイブ内の各エントリのサブパス名:\n";
54    echo "------------------------------------------\n";
55
56    // Pharアーカイブ内の各ファイル（エントリ）をイテレートします
57    foreach ($phar as $file) {
58        // 各$fileはPharFileInfoオブジェクトです
59        // getSubPathname() メソッドは、アーカイブのルートからの相対パスを文字列として返します。
60        // これは、ユーザーがキーワードとして示した 'getsubpathname' に最も関連性の高い情報です。
61        $subPathname = $file->getSubPathname();
62        echo "- " . $subPathname . "\n";
63    }
64
65    echo "------------------------------------------\n";
66
67} catch (PharException $e) {
68    echo "エラー: Pharアーカイブの読み込み中に問題が発生しました: " . $e->getMessage() . "\n";
69    exit(1);
70} finally {
71    // ----------------------------------------------------
72    // ステップ3: 作成したPharアーカイブをクリーンアップ
73    // ----------------------------------------------------
74    if (file_exists($pharFilePath)) {
75        // サンプルとして作成したPharファイルを削除します
76        unlink($pharFilePath);
77        echo "\nPharアーカイブ '{$pharFilePath}' を削除しました。\n";
78    }
79}

このPHPサンプルコードは、Phar（PHP Archive）拡張機能を使って作成されたアーカイブ内部の各ファイルの相対パスを取得する方法を示しています。Pharは、複数のPHPファイルや関連リソースを一つのアーカイブファイルにまとめ、配布やデプロイを容易にするための機能です。

まず、サンプルでは一時的なPharアーカイブを作成し、「file1.txt」や「subdir/file2.txt」のように、サブディレクトリを含む形で複数のファイルを格納しています。 次に、作成されたPharアーカイブを開き、その中にある各ファイルのエントリを一つずつ処理しています。ここで注目すべきは、各エントリを表すPharFileInfoオブジェクトに対して呼び出されるgetSubPathname()メソッドです。

getSubPathname()メソッドは引数を一切取りません。このメソッドは、Pharアーカイブのルートディレクトリからの相対パスを文字列として返します。例えば、「subdir/file2.txt」のように、アーカイブ内部でのファイルの正確な位置を階層構造を含めて取得することができます。これは、アーカイブの内容を分析したり、特定のファイルを見つけ出したりする際に非常に役立ちます。戻り値は、常にファイルがアーカイブ内で持つ正確な相対パスの文字列です。 この機能により、Pharアーカイブの内部構造を理解し、効率的にファイルを操作することが可能になります。