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

Copy
1<?php
2
3/**
4 * テスト用のPharDataアーカイブを作成するヘルパー関数。
5 *
6 * @param string $archivePath 作成するアーカイブの完全パス。
7 */
8function createTestPharDataArchive(string $archivePath): void
9{
10    // アーカイブが既に存在する場合は削除し、常に新しい状態から始める
11    if (file_exists($archivePath)) {
12        unlink($archivePath);
13    }
14
15    try {
16        // 新しいPharDataアーカイブを作成 (TAR形式)
17        // PharDataオブジェクトは、既存のアーカイブを開くか、新しいアーカイブを作成するために使用されます。
18        $phar = new PharData($archivePath, 0, null, Phar::TAR);
19
20        // アーカイブにファイルを追加
21        $phar->addFromString('file1.txt', 'これはファイル1の内容です。');
22        $phar->addFromString('folder/file2.txt', 'これはfolder内のファイル2の内容です。');
23        $phar->addFromString('folder/subfolder/file3.txt', 'これはsubfolder内のファイル3の内容です。');
24
25        echo "テストアーカイブ '{$archivePath}' が正常に作成されました。\n";
26    } catch (PharException $e) {
27        // Phar関連のエラーが発生した場合
28        echo "PharDataアーカイブの作成中にエラーが発生しました: " . $e->getMessage() . "\n";
29        // エラーが発生した場合も、作成途中のファイルを削除してクリーンアップ
30        if (file_exists($archivePath)) {
31            unlink($archivePath);
32        }
33        exit(1);
34    }
35}
36
37/**
38 * PharData::getSubPath の使用例を示す関数。
39 *
40 * PharDataオブジェクトをイテレートし、各エントリのgetSubPathメソッドを使用して、
41 * アーカイブ内の相対パスを取得します。
42 */
43function demonstratePharDataGetSubPath(): void
44{
45    // 一時ディレクトリにアーカイブファイルを作成
46    $tempDir = sys_get_temp_dir();
47    $archiveFileName = 'example_archive_' . uniqid() . '.tar'; // ユニークなファイル名を生成
48    $archivePath = $tempDir . DIRECTORY_SEPARATOR . $archiveFileName;
49
50    // テスト用のPharDataアーカイブを作成
51    createTestPharDataArchive($archivePath);
52
53    echo "\n--- PharData::getSubPath の使用例 ---\n";
54
55    try {
56        // 作成したアーカイブをPharDataオブジェクトとして開く
57        $phar = new PharData($archivePath);
58
59        // RecursiveIteratorIteratorを使用してアーカイブ内の全エントリを再帰的にイテレート
60        // 各 $file は PharFileInfo のように振る舞い、アーカイブ内のエントリを表します。
61        foreach (new RecursiveIteratorIterator($phar) as $file) {
62            // getSubPath() メソッドを呼び出し、アーカイブ内のルートからの相対パスを取得
63            // このメソッドは、アーカイブ内のエントリの階層構造を把握するのに役立ちます。
64            $subPath = $file->getSubPath();
65            echo "エントリ名: " . $file->getFilename() . ", アーカイブ内の相対パス: " . ($subPath !== null ? $subPath : 'null') . "\n";
66        }
67
68    } catch (Exception $e) {
69        // アーカイブの読み込みや処理中に発生した例外をキャッチ
70        echo "アーカイブの処理中にエラーが発生しました: " . $e->getMessage() . "\n";
71    } finally {
72        // クリーンアップ: 作成した一時アーカイブファイルを削除
73        if (file_exists($archivePath)) {
74            unlink($archivePath);
75            echo "\nテストアーカイブ '{$archivePath}' が削除されました。\n";
76        }
77    }
78}
79
80// スクリプトの実行を開始
81demonstratePharDataGetSubPath();
82
83?>

PHP 8のPharDataクラスは、.tarや.zipといったファイルアーカイブを操作するための機能を提供します。その中のgetSubPathメソッドは、アーカイブ内部のファイルやディレクトリのエントリが、アーカイブのルートから見てどの親ディレクトリに位置しているかを示す相対パスを取得するために使用されます。

このメソッドは引数を一切取らず、戻り値としてstring型またはnullを返します。具体的には、アーカイブ内のエントリの親ディレクトリのパスが存在する場合、そのパスが文字列で返されます。例えば、「folder/subfolder/file3.txt」というエントリの場合、getSubPathは「folder/subfolder」という文字列を返します。もしエントリがアーカイブのルート直下にある場合、このメソッドはnullを返します。

サンプルコードでは、まず一時的なPharDataアーカイブを作成し、その中に階層構造を持つファイルをいくつか追加しています。その後、作成したアーカイブを開き、RecursiveIteratorIteratorを使ってアーカイブ内のすべてのエントリを一つずつ処理します。各エントリ（$file）に対してgetSubPath()を呼び出すことで、そのエントリが所属する親ディレクトリの相対パスを確認し、画面に出力しています。この機能は、アーカイブの内容をツリー構造として表示したり、特定の親ディレクトリにあるファイルだけを抽出したりする際に役立ちます。