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

Copy
1<?php
2
3// システムエンジニアを目指す初心者の方へ：
4// PHPでPharアーカイブを操作するには、通常 phar.readonly 設定を無効にする必要があります。
5// 開発環境やスクリプト実行時のみ一時的に設定を変更することを想定しています。
6// 本番環境でPharアーカイブを動的に作成・変更することはセキュリティリスクを伴うため、推奨されません。
7// CLIで実行する場合は `php -d phar.readonly=0 your_script.php` のように指定することもできます。
8ini_set('phar.readonly', 0);
9
10/**
11 * 指定されたファイルをPharアーカイブに追加するサンプル関数。
12 *
13 * この関数は、ZIP形式のPharアーカイブを新規作成し、
14 * 指定されたファイルをそのアーカイブ内に格納します。
15 * 処理後、作成したPharアーカイブとダミーファイルをクリーンアップします。
16 *
17 * @param string $archiveFilename Pharアーカイブのファイル名（例: 'my_application.phar.zip'）
18 * @param string $fileToAddFilename アーカイブに追加するソースファイル名（例: 'config.txt'）
19 */
20function createAndAddFileToPharArchive(string $archiveFilename, string $fileToAddFilename): void
21{
22    // 一時的なディレクトリにファイルを作成し、クリーンアップしやすくします。
23    $tempDir = sys_get_temp_dir();
24    $pharPath = $tempDir . DIRECTORY_SEPARATOR . $archiveFilename;
25    $filePath = $tempDir . DIRECTORY_SEPARATOR . $fileToAddFilename;
26
27    echo "Pharアーカイブを作成するパス: {$pharPath}\n";
28    echo "Pharアーカイブに追加するファイルのパス: {$filePath}\n\n";
29
30    // 1. アーカイブに追加するダミーファイルを準備します。
31    $fileContent = "これはPharアーカイブに追加されるテストファイルの内容です。\n";
32    if (file_put_contents($filePath, $fileContent) === false) {
33        echo "エラー: ダミーファイル '{$fileToAddFilename}' の作成に失敗しました。\n";
34        return;
35    }
36    echo "ダミーファイル '{$fileToAddFilename}' を作成しました。\n";
37
38    try {
39        // 2. Pharオブジェクトをインスタンス化し、新しいアーカイブを作成します。
40        //    Phar::ZIP は、PharアーカイブをZIP形式で作成することを示します。
41        //    これにより、生成された .phar.zip ファイルは通常のZIP解凍ツールで開くことができます。
42        $phar = new Phar($pharPath, 0, basename($pharPath), Phar::ZIP);
43        echo "Pharアーカイブ '{$archiveFilename}' を作成しました。\n";
44
45        // 3. Phar::addFile() メソッドを使用して、ファイルをアーカイブに追加します。
46        //    - 第1引数: ディスク上のソースファイルのパス。
47        //    - 第2引数 (オプション): アーカイブ内でファイルに与える名前。
48        //      省略すると、ソースファイルのファイル名がアーカイブ内で使用されます。
49        $phar->addFile($filePath, $fileToAddFilename);
50        echo "ファイル '{$fileToAddFilename}' をPharアーカイブに追加しました。\n";
51
52        // 4. アーカイブ内のファイルを確認します（オプション）。
53        echo "\n--- Pharアーカイブ '{$archiveFilename}' 内のファイル --- \n";
54        foreach ($phar as $fileInfo) {
55            echo "- " . $fileInfo->getFilename() . "\n";
56        }
57        echo "--------------------------------------------------\n";
58
59    } catch (Exception $e) {
60        // エラーが発生した場合の処理
61        echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
62    } finally {
63        // 5. 処理後のクリーンアップ：作成したPharアーカイブとダミーファイルを削除します。
64        //    これにより、スクリプトを複数回実行しても一時ファイルが残らず、環境を汚しません。
65        if (file_exists($pharPath)) {
66            unlink($pharPath);
67            echo "\nPharアーカイブ '{$archiveFilename}' を削除しました。\n";
68        }
69        if (file_exists($filePath)) {
70            unlink($filePath);
71            echo "ダミーファイル '{$fileToAddFilename}' を削除しました。\n";
72        }
73    }
74}
75
76// サンプル関数の実行：
77// 'my_application.phar.zip' という名前のPharアーカイブを作成し、
78// 'settings.txt' という名前のダミーファイルをその中に含めます。
79createAndAddFileToPharArchive('my_application.phar.zip', 'settings.txt');
80
81?>

PHPのPhar::addFileメソッドは、Pharアーカイブにファイルを追加するために利用されます。このメソッドは、指定されたファイルを既存または新規作成されたPharアーカイブ内に格納する役割を担います。

第一引数$filenameには、ディスク上に存在する、Pharアーカイブに追加したいファイルのパスを指定します。第二引数$localNameはオプションで、アーカイブ内でファイルに与える名前を指定することができます。この引数を省略した場合、第一引数で指定したファイルのファイル名がアーカイブ内で使用されます。このメソッドはファイルの追加が完了しても、特別な戻り値は持ちません。

サンプルコードでは、ini_set('phar.readonly', 0);でPharアーカイブへの書き込みを許可し、Phar::ZIPオプションを使用してZIP形式のPharアーカイブを新規作成しています。その後、addFileメソッドを用いて準備したダミーファイルをそのアーカイブに追加しています。これにより、一般的なZIP解凍ツールで内容を確認できる形式のPharアーカイブが作成され、処理後に作成したPharアーカイブとダミーファイルは適切にクリーンアップされます。

Copy
1<?php
2
3/**
4 * Phar::addFile() メソッドを使用して、ファイルとディレクトリ構造を含むPharアーカイブを作成するサンプルコード。
5 *
6 * この関数は、システムエンジニアを目指す初心者向けに、以下の手順で動作します。
7 * 1. Pharアーカイブ作成のための準備として、一時的なディレクトリとダミーファイルを生成します。
8 * 2. `Phar::addFile()` を使い、生成したファイルをPharアーカイブに追加します。
9 *    - 第一引数でディスク上のファイルパスを指定します。
10 *    - 第二引数 (オプション) でアーカイブ内のファイルパスを指定し、ディレクトリ構造を表現します。
11 * 3. 作成されたPharアーカイブの内容を確認します。
12 * 4. 最後に、作成したPharアーカイブと一時ファイルをクリーンアップします。
13 *
14 * @param string $archivePath 作成するPharアーカイブの完全なファイルパス。例: __DIR__ . '/my_application.phar'
15 */
16function createPharArchiveWithAddFileExample(string $archivePath): void
17{
18    // PHP設定: phar.readonly が '1' (読み取り専用) の場合、Pharアーカイブの作成や変更ができません。
19    // そのため、一時的に '0' (書き込み可能) に設定します。
20    // 注意: 本番環境でこの設定を変更することは推奨されない場合があります。
21    $originalPharReadonly = ini_get('phar.readonly');
22    if ($originalPharReadonly === '1') {
23        ini_set('phar.readonly', '0');
24        echo "警告: 'phar.readonly' が '1' のため、一時的に '0' に設定しました。\n";
25    }
26
27    // --- 1. 一時ディレクトリとダミーファイルの準備 ---
28    // システムの一時ディレクトリ内にユニークな名前で作業ディレクトリを作成
29    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'phar_example_' . uniqid();
30    $subdirPath = $tempDir . DIRECTORY_SEPARATOR . 'config'; // アーカイブに含めるサブディレクトリを想定
31    $file1Path = $tempDir . DIRECTORY_SEPARATOR . 'index.php';
32    $file2Path = $subdirPath . DIRECTORY_SEPARATOR . 'settings.ini';
33
34    try {
35        // 一時ディレクトリとサブディレクトリを作成
36        if (!mkdir($subdirPath, 0777, true)) {
37            throw new Exception("一時ディレクトリの作成に失敗しました: {$subdirPath}");
38        }
39
40        // ダミーファイルを作成
41        file_put_contents($file1Path, '<?php echo "Hello from Phar Archive!";');
42        file_put_contents($file2Path, '[database]' . PHP_EOL . 'host=localhost');
43
44        echo "一時ファイルを作成しました:\n";
45        echo " - " . $file1Path . "\n";
46        echo " - " . $file2Path . "\n\n";
47
48        // 既存のPharアーカイブを削除 (同じ名前で作成する場合の衝突回避とクリーンアップのため)
49        if (file_exists($archivePath)) {
50            unlink($archivePath); // ファイルシステムから削除
51            Phar::unlinkArchive($archivePath); // Pharキャッシュをクリア (PHP 5.3+)
52            echo "既存のPharアーカイブ '{$archivePath}' を削除しました。\n";
53        }
54
55        // --- 2. `Phar::addFile()` を使ってファイルをPharアーカイブに追加 ---
56        // 新しいPharアーカイブを作成するPharオブジェクトをインスタンス化
57        $phar = new Phar($archivePath);
58
59        // 複数のファイルを効率的に追加するため、バッファリングを開始
60        $phar->startBuffering();
61
62        // index.php をアーカイブのルートに 'index.php' として追加
63        $phar->addFile($file1Path, 'index.php');
64        echo "Phar::addFile('{$file1Path}', 'index.php') でファイルを追加しました。\n";
65
66        // settings.ini をアーカイブ内の 'config/' ディレクトリに 'settings.ini' として追加
67        // 第二引数でスラッシュ区切りのパスを指定することで、アーカイブ内にディレクトリ構造を構築できます。
68        $phar->addFile($file2Path, 'config/settings.ini');
69        echo "Phar::addFile('{$file2Path}', 'config/settings.ini') でファイルを追加しました。\n";
70
71        // バッファリングを終了し、Pharアーカイブへの変更を確定
72        $phar->stopBuffering();
73
74        echo "\nPharアーカイブ '{$archivePath}' が正常に作成されました。\n";
75
76        // --- 3. 作成されたPharアーカイブの内容を確認 (オプション) ---
77        echo "\n作成されたPharアーカイブの中身:\n";
78        $pharReader = new Phar($archivePath);
79        foreach ($pharReader as $file) {
80            echo " - " . $file->getFilename() . "\n";
81        }
82
83    } catch (Exception $e) {
84        echo "Pharアーカイブの作成中にエラーが発生しました: " . $e->getMessage() . "\n";
85        // エラー発生時は作成中のPharアーカイブを削除
86        if (file_exists($archivePath)) {
87            unlink($archivePath);
88            Phar::unlinkArchive($archivePath);
89        }
90    } finally {
91        // --- 4. 後処理: 一時ディレクトリとファイルを削除 ---
92        echo "\n一時ファイルをクリーンアップしています...\n";
93        if (file_exists($file1Path)) {
94            unlink($file1Path);
95        }
96        if (file_exists($file2Path)) {
97            unlink($file2Path);
98        }
99        if (is_dir($subdirPath)) {
100            rmdir($subdirPath);
101        }
102        if (is_dir($tempDir)) {
103            rmdir($tempDir);
104        }
105        // phar.readonly 設定を元の値に戻す
106        if ($originalPharReadonly === '1') {
107            ini_set('phar.readonly', $originalPharReadonly);
108        }
109        echo "クリーンアップが完了しました。\n";
110    }
111}
112
113// サンプルコードの実行
114// このスクリプトと同じディレクトリに 'my_sample_app.phar' という名前でアーカイブを作成します。
115createPharArchiveWithAddFileExample(__DIR__ . DIRECTORY_SEPARATOR . 'my_sample_app.phar');
116
117?>

Phar::addFileメソッドは、PHPのPharアーカイブに個別のファイルを追加するために利用されます。このメソッドは、ディスク上に存在するファイルを効率的にPharアーカイブの内部に格納する役割を持っています。

第一引数$filenameには、Pharアーカイブに追加したい、実際のディスク上のファイルパスを指定します。第二引数$localNameはオプションですが、Pharアーカイブ内部でそのファイルがどのようなパスで保存されるかを定義します。例えば、「config/settings.ini」のようにスラッシュを含むパスを$localNameとして指定することで、アーカイブ内に「config」という仮想的なディレクトリを作成し、その中に「settings.ini」というファイルを配置するといった、ディレクトリ構造を構築することが可能です。このメソッドはファイルを追加する処理のみを行い、特に戻り値はありません。

サンプルコードでは、まずPharアーカイブ作成のための準備として一時的なファイルとディレクトリを作成します。次に、Phar::startBuffering()とPhar::stopBuffering()を使用して効率的にファイルをPharアーカイブに追加しています。この際、Phar::addFile()の第二引数を活用し、アーカイブのルートに「index.php」を、また「config/settings.ini」としてアーカイブ内にディレクトリ構造を持たせたファイルをそれぞれ追加しています。PHP設定phar.readonlyが'0'でないとPharアーカイブの作成や変更ができないため、サンプルコードでは一時的に設定を変更している点も重要です。処理の最後には、作成されたアーカイブの内容確認と一時ファイルのクリーンアップが行われます。