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

Copy
1<?php
2
3// Pharアーカイブの書き込みを一時的に許可します。
4// 通常、本番環境ではphp.iniで 'phar.readonly = Off' と設定するか、
5// この設定をスクリプト内で変更することは推奨されません。
6// このサンプルコードは学習目的のため、一時的に設定を変更しています。
7ini_set('phar.readonly', 0);
8
9/**
10 * Phar::addFromString メソッドを使用して、新しいPharアーカイブを作成し、
11 * 指定された文字列コンテンツからファイルをアーカイブに追加するサンプル関数。
12 *
13 * @param string $archiveName 作成するPharアーカイブのファイル名（例: 'my_archive.phar'）
14 * @return void
15 */
16function createPharArchiveWithStrings(string $archiveName): void
17{
18    // 既存のPharアーカイブが存在する場合は、クリーンアップのために削除します。
19    if (file_exists($archiveName)) {
20        unlink($archiveName);
21        echo "既存のPharアーカイブ '{$archiveName}' を削除しました。\n";
22    }
23
24    try {
25        // 新しいPharアーカイブを作成します。
26        // ファイルが存在しない場合は作成されます。
27        $phar = new Phar($archiveName);
28
29        // バッファリングを開始し、Pharファイルへの変更を一時的にメモリに保持します。
30        // これにより、複数のファイル追加操作を効率的に行えます。
31        $phar->startBuffering();
32
33        // Phar::addFromString メソッドを使用して、文字列の内容からファイルをアーカイブに追加します。
34        // 第1引数: アーカイブ内でのファイルのパスと名前。
35        // 第2引数: ファイルとして追加する文字列の内容。
36        $phar->addFromString('readme.txt', 'これはPharアーカイブ内に含まれる、READMEファイルの内容です。');
37        $phar->addFromString('config/settings.json', json_encode(['version' => '1.0', 'author' => 'Developer'], JSON_PRETTY_PRINT));
38        $phar->addFromString('src/main.php', "<?php\n\necho 'Hello from main.php inside the Phar archive!';\n");
39
40        // バッファリングを終了し、全ての変更をPharファイルに書き込み、ファイルを閉じます。
41        $phar->stopBuffering();
42
43        echo "Pharアーカイブ '{$archiveName}' が正常に作成され、ファイルが追加されました。\n";
44
45        // 作成されたPharアーカイブの内容を確認します（オプション）。
46        echo "\n--- アーカイブされたファイル一覧 ---\n";
47        $pharReader = new Phar($archiveName);
48        foreach ($pharReader as $file) {
49            echo "- " . $file->getPathname() . " (サイズ: " . $file->getSize() . "バイト)\n";
50        }
51        echo "-------------------------------------\n";
52
53    } catch (PharException $e) {
54        // Phar操作に関連するエラーを捕捉します。
55        echo "Pharアーカイブ作成中にエラーが発生しました: " . $e->getMessage() . "\n";
56        // エラーが発生した場合、部分的に作成されたファイルを削除してクリーンアップします。
57        if (file_exists($archiveName)) {
58            unlink($archiveName);
59        }
60    } catch (Exception $e) {
61        // その他の予期せぬエラーを捕捉します。
62        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
63    }
64}
65
66// サンプル関数を実行します。
67$myArchive = 'my_application.phar';
68createPharArchiveWithStrings($myArchive);
69
70// スクリプト実行後に作成されたPharファイルを削除したい場合は、
71// 以下のコメントを解除してください。
72// if (file_exists($myArchive)) {
73//     unlink($myArchive);
74//     echo "\nPharアーカイブ '{$myArchive}' を削除しました。\n";
75// }

PHPのPhar::addFromStringメソッドは、Phar（PHP Archive）形式のアーカイブファイルに、指定した文字列の内容をあたかもファイルであるかのように追加する際に使用します。Pharアーカイブは、複数のPHPファイルや関連リソースを一つのファイルにまとめ、アプリケーションの配布やデプロイを簡素化するのに役立ちます。

このメソッドは、string $localNameとstring $contentsという2つの引数を取ります。$localNameには、Pharアーカイブ内でそのファイルがどのように保存されるかを示すパスとファイル名を指定します。例えば、'src/script.php'のように指定すると、アーカイブ内にsrcディレクトリが作られ、その中にscript.phpとして内容が保存されます。$contentsには、アーカイブに追加したいファイルの中身となる文字列そのものを指定します。PHPのコードや設定ファイルのJSON文字列などを直接渡すことができます。

このメソッドは、ファイル追加後に特別な値を返しません。戻り値なしの操作です。サンプルコードでは、まずini_set('phar.readonly', 0)でPharアーカイブへの書き込みを一時的に許可し、Pharクラスのインスタンスを作成しています。その後、addFromStringを使用してreadme.txtやconfig/settings.json、src/main.phpといったファイルを文字列から作成し、Pharアーカイブに追加しています。これにより、PHPアプリケーションを単一のファイルとして配布する準備ができます。Pharアーカイブは、ZIPファイルのように複数のファイルをまとめる機能を提供します。

Copy
1<?php
2
3// このサンプルコードを実行する前に、PHPの設定ファイル (php.ini) で 'phar.readonly = 0' を設定してください。
4// 設定しない場合、Pharアーカイブの作成や変更が許可されず、PharExceptionが発生します。
5// 例: C:\php\php.ini または /etc/php/8.x/cli/php.ini ファイルを編集し、
6// 'phar.readonly = 1' の行を 'phar.readonly = 0' に変更してください。
7
8/**
9 * Pharアーカイブに文字列データをファイルとして追加するサンプル。
10 *
11 * この関数は、指定されたPharファイルを作成または開き、
12 * その中に指定されたパスと内容で新しいファイルを仮想的に追加します。
13 * Pharアーカイブは、複数のファイルを一つのアーカイブにまとめることができる形式です。
14 */
15function createPharWithStringsExample(): void
16{
17    $pharFile = 'my_application.phar'; // 作成するPharアーカイブのファイル名
18    $alias = 'my_app';                 // Pharアーカイブのエイリアス（Pharストリームラッパーでアクセスする際に使用）
19
20    // デモンストレーションのために、既に存在するPharファイルを削除します。
21    // 本番環境で使用する際は、この処理を削除するか慎重に扱ってください。
22    if (file_exists($pharFile)) {
23        unlink($pharFile);
24        echo "既存の '{$pharFile}' を削除しました。\n";
25    }
26
27    try {
28        // 新しいPharアーカイブを作成します。
29        // 第2引数: FilesystemIterator のフラグ (ここでは標準的なものを指定)。
30        // 第3引数: エイリアス。この名前で phar:// ストリームとしてアクセスできます。
31        $phar = new Phar($pharFile, FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::KEY_AS_FILENAME, $alias);
32
33        // addFromString メソッドを使用して、Pharアーカイブ内にファイルを文字列データで追加します。
34        // 第1引数: アーカイブ内のファイルのパスと名前。
35        // 第2引数: ファイルとして保存する文字列の内容。
36        $phar->addFromString('index.php', '<?php echo "Hello from my_application.phar!";');
37        echo "Pharアーカイブに 'index.php' を追加しました。\n";
38
39        // サブディレクトリにファイルを配置する例
40        $phar->addFromString('config/settings.json', '{"appName": "MyPharApp", "version": "1.0.0"}');
41        echo "Pharアーカイブに 'config/settings.json' を追加しました。\n";
42
43        $phar->addFromString('docs/README.md', '# My Application\nThis is a sample application packaged in a Phar file.');
44        echo "Pharアーカイブに 'docs/README.md' を追加しました。\n";
45
46        // Pharアーカイブの変更を確定し、ディスクに書き込みます。
47        // これを呼び出さない場合でもスクリプト終了時に自動保存されることがありますが、明示的に行うことが推奨されます。
48        $phar->stopBuffering();
49
50        echo "\nPharアーカイブ '{$pharFile}' が正常に作成されました。\n";
51
52        // 作成されたPharアーカイブ内のファイル内容を読み込んで確認します。
53        echo "\n--- Pharアーカイブ内のファイル内容を確認 ---\n";
54        echo "phar://{$alias}/index.php の内容:\n";
55        echo file_get_contents("phar://{$alias}/index.php") . "\n";
56
57        echo "\nphar://{$alias}/config/settings.json の内容:\n";
58        echo file_get_contents("phar://{$alias}/config/settings.json") . "\n";
59
60        echo "\nphar://{$alias}/docs/README.md の内容:\n";
61        echo file_get_contents("phar://{$alias}/docs/README.md") . "\n";
62        echo "-------------------------------------------\n";
63
64    } catch (PharException $e) {
65        // Phar関連のエラーが発生した場合の処理
66        echo "Pharエラーが発生しました: " . $e->getMessage() . "\n";
67        echo "php.ini で 'phar.readonly = 0' が設定されているか確認してください。\n";
68    } catch (Exception $e) {
69        // その他の一般的なエラーが発生した場合の処理
70        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
71    }
72}
73
74// 上記で定義した関数を実行します。
75createPharWithStringsExample();

PHPのPharクラスのaddFromStringメソッドは、複数のファイルを一つにまとめるPharアーカイブ内に、文字列データを直接ファイルとして追加する際に使用します。このメソッドは、指定した名前で新しいファイルをアーカイブ内に作成し、そのファイルの内容として指定した文字列を格納します。

引数$localNameには、Pharアーカイブ内で作成されるファイルのパスと名前を文字列で指定します。例えば「index.php」や「config/settings.json」のように、サブディレクトリを含むパスも指定可能です。引数$contentsには、作成されるファイルに書き込む内容を文字列で渡します。このメソッドは、アーカイブへの追加が成功すれば役割を終えるため、戻り値はありません。

サンプルコードでは、まずPharオブジェクトを新しく作成し、その後addFromStringを複数回呼び出して「index.php」や「config/settings.json」といったファイルをアーカイブに追加しています。これにより、物理的にファイルが存在しなくても、直接コード内でファイル内容を定義してアーカイブに組み込むことが可能です。なお、Pharアーカイブを作成したり変更したりするには、PHPの設定ファイル（php.ini）でphar.readonly = 0と設定しておく必要があります。設定しない場合、エラーが発生しますのでご注意ください。作成されたPharアーカイブ内のファイルは、「phar://」ストリームラッパーを使ってアクセスできます。