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

Copy
1<?php
2
3/**
4 * このスクリプトは、PHPのPhar拡張機能を使用して
5 * Pharアーカイブ内のファイルを開く方法を示します。
6 *
7 * Phar::openFile メソッドは、既に存在するPharアーカイブ内の特定のファイルに
8 * アクセスするために使用されます。通常のファイルを開く fopen() とは異なり、
9 * アーカイブという特殊なコンテナ内のファイルを扱います。
10 *
11 * 注意: Pharアーカイブを作成・変更するには、php.iniで 'phar.readonly = 0' を設定するか、
12 * あるいは ini_set('phar.readonly', 0); を一時的に使用する必要があります。
13 * (ini_setは常にPharの動作を許可するわけではありません)
14 */
15
16// Pharアーカイブのファイル名を定義
17$pharFilename = 'example_archive.phar';
18// アーカイブ内に格納するファイルの名前と内容を定義
19$innerFilename = 'document.txt';
20$innerFileContent = "これはPharアーカイブ内部のファイルです。\nPhar::openFile メソッドで開かれました。\n";
21
22// ----------------------------------------------------
23// 1. Pharアーカイブを作成し、ファイルを追加する (Phar::openFile のための準備)
24// ----------------------------------------------------
25echo "Pharアーカイブ '{$pharFilename}' の作成を開始します...\n";
26
27try {
28    // 既存のPharアーカイブを削除 (スクリプトを複数回実行しても問題ないようにするため)
29    if (file_exists($pharFilename)) {
30        Phar::unlinkArchive($pharFilename);
31        echo "  既存のアーカイブを削除しました。\n";
32    }
33
34    // 新しいPharアーカイブを作成
35    // 第一引数: 作成するPharファイルのパス
36    // 第二引数: 0 (Phar::NONE) は圧縮なし、Phar::GZ や Phar::BZ2 で圧縮も可能
37    // 第三引数: アーカイブのエイリアス (必須)
38    $phar = new Phar($pharFilename, 0, $pharFilename);
39
40    // Pharアーカイブへの書き込み操作を開始 (複数のファイルを追加する場合に効率的)
41    $phar->startBuffering();
42
43    // アーカイブ内に新しいファイルと内容を追加
44    $phar->addFromString($innerFilename, $innerFileContent);
45    echo "  アーカイブ内に '{$innerFilename}' を追加しました。\n";
46
47    // Pharアーカイブへの書き込み操作を終了し、変更をディスクに保存
48    $phar->stopBuffering();
49
50    echo "Pharアーカイブ '{$pharFilename}' が正常に作成されました。\n";
51
52} catch (PharException $e) {
53    echo "エラー: Pharアーカイブの作成中に問題が発生しました。\n";
54    echo "  メッセージ: " . $e->getMessage() . "\n";
55    echo "  ヒント: php.iniで 'phar.readonly = 0' が設定されているか確認してください。\n";
56    exit(1); // エラーが発生した場合はスクリプトを終了
57} catch (Exception $e) {
58    echo "エラー: 予期せぬ問題が発生しました。\n";
59    echo "  メッセージ: " . $e->getMessage() . "\n";
60    exit(1); // エラーが発生した場合はスクリプトを終了
61}
62
63// ----------------------------------------------------
64// 2. Phar::openFile を使用してアーカイブ内のファイルを開く
65// ----------------------------------------------------
66echo "\nPhar::openFile を使用してアーカイブ内のファイルを開きます...\n";
67
68try {
69    // 作成したPharアーカイブを読み込み専用で開くためのPharオブジェクトを生成
70    // Phar::openFile はインスタンスメソッドなので、まずPharオブジェクトが必要です。
71    $pharReader = new Phar($pharFilename);
72
73    // Phar::openFile メソッドを呼び出し、アーカイブ内の特定のファイルを開く
74    // 第一引数: 開きたいアーカイブ内のファイル名
75    // 第二引数: ファイルを開くモード ('r' は読み込み専用)
76    // 戻り値は PharFile オブジェクト (PHPの SplFileObject を継承しています)
77    $pharFile = $pharReader->openFile($innerFilename, 'r');
78
79    echo "  アーカイブ内のファイル '{$innerFilename}' を開きました。\n";
80
81    // PharFileオブジェクトからファイルの内容を読み込む
82    // SplFileObject のメソッド (fread, eof など) が利用できます。
83    $content = '';
84    while (!$pharFile->eof()) {
85        $content .= $pharFile->fread(8192); // 8KBずつ読み込む
86    }
87
88    echo "----------------------------------------\n";
89    echo "ファイル '{$innerFilename}' の内容:\n";
90    echo $content;
91    echo "----------------------------------------\n";
92
93} catch (PharException $e) {
94    echo "エラー: Phar::openFile の実行中に問題が発生しました。\n";
95    echo "  メッセージ: " . $e->getMessage() . "\n";
96    exit(1); // エラーが発生した場合はスクリプトを終了
97} catch (Exception $e) {
98    echo "エラー: 予期せぬ問題が発生しました。\n";
99    echo "  メッセージ: " . $e->getMessage() . "\n";
100    exit(1); // エラーが発生した場合はスクリプトを終了
101} finally {
102    // ----------------------------------------------------
103    // 3. 後処理: 作成したPharアーカイブファイルを削除
104    // ----------------------------------------------------
105    echo "\n後処理として、Pharアーカイブ '{$pharFilename}' を削除します...\n";
106    if (file_exists($pharFilename)) {
107        try {
108            // Phar::unlinkArchive は静的メソッドで、Pharアーカイブファイルを削除します。
109            Phar::unlinkArchive($pharFilename);
110            echo "  Pharアーカイブ '{$pharFilename}' が正常に削除されました。\n";
111        } catch (PharException $e) {
112            echo "警告: Pharアーカイブの削除中にエラーが発生しました。\n";
113            echo "  メッセージ: " . $e->getMessage() . "\n";
114        }
115    }
116}

PHP 8のPharクラスに属するopenFileメソッドは、Pharアーカイブという、複数のファイルを一つにまとめて管理する特殊なコンテナの中から、特定のファイルを開くために使用されます。これは、一般的なファイルを開くfopen()関数とは異なり、アーカイブ内部のファイルにアクセスする点が特徴です。

このメソッドは、第一引数$filenameに開きたいアーカイブ内のファイル名を文字列で指定します。続く第二引数$modeは、ファイルをどのようなモードで開くかを示し、通常は読み込み専用を意味する'r'が使われます。残りの$use_include_pathと$contextはオプションの引数で、特定のファイルパスの検索やストリームコンテキストの適用に利用されますが、多くのケースでは省略可能です。

openFileメソッドが成功すると、戻り値としてPharFileオブジェクトを返します。このPharFileオブジェクトはPHPの標準ファイル操作クラスであるSplFileObjectを継承しており、ファイルの内容を一行ずつ読み込んだり、指定したバイト数で読み出したりするなど、通常のファイルと同様の操作を行うことができます。主に既存のPharアーカイブ内のデータを安全に読み出す目的で利用され、このメソッドを呼び出すには、事前にPharアーカイブ自体をPharクラスのインスタンスとして読み込んでおく必要があります。