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

Copy
1<?php
2
3/**
4 * このサンプルコードは、PHPのPhar::offsetExistsメソッドの使用方法を初心者向けに示します。
5 * Pharアーカイブ内に特定のファイルが存在するかどうかを効率的に確認できます。
6 *
7 * 動作にはPhar拡張が有効になっている必要があります。
8 *
9 * 注意: Pharアーカイブを作成・変更するには、php.ini の 'phar.readonly' 設定が '0' である必要があります。
10 *       このスクリプトは、一時的にこの設定を変更して単体で動作できるようにしていますが、
11 *       本番環境で ini_set() を使用することは推奨されません。開発環境でのみ行ってください。
12 */
13
14// php.ini の 'phar.readonly' 設定の現在の状態を保存し、一時的に '0' に設定します。
15// これにより、スクリプトがPharアーカイブを作成・変更できるようになります。
16$originalPharReadonlySetting = ini_get('phar.readonly');
17if ($originalPharReadonlySetting === '1') {
18    ini_set('phar.readonly', '0');
19}
20
21/**
22 * Phar::offsetExists メソッドのデモンストレーションを行います。
23 *
24 * 指定されたPharファイルを作成し、テストファイルを追加した後、
25 * offsetExists を使用してファイルの存在を確認します。
26 *
27 * @param string $pharArchiveName 作成するPharアーカイブのファイル名。
28 * @param string $internalFileName Pharアーカイブ内部でのファイル名（パス）。
29 */
30function demonstratePharOffsetExists(string $pharArchiveName, string $internalFileName): void
31{
32    // 1. Pharに含める一時的なソースファイルを作成します。
33    //    このファイルが、後でPharアーカイブに追加されます。
34    $sourceTempFileName = 'source_for_phar_entry.txt';
35    file_put_contents($sourceTempFileName, 'This is a test content for the Phar entry.');
36    echo "一時的なソースファイル '{$sourceTempFileName}' を作成しました。\n";
37
38    try {
39        // 2. 新しいPharアーカイブを作成します。
40        //    既存のファイルがあれば上書きされます。
41        $phar = new Phar($pharArchiveName);
42
43        // 3. 作成した一時ファイルをPharアーカイブに追加します。
44        //    addFile(ソースファイルのパス, Phar内部でのファイル名)
45        //    $internalFileNameはPhar内部でのパスとなります。
46        $phar->addFile($sourceTempFileName, $internalFileName);
47        echo "Pharアーカイブ '{$pharArchiveName}' に '{$internalFileName}' (元は '{$sourceTempFileName}') を追加しました。\n";
48
49        echo "\n--- Phar::offsetExists を使ったファイル存在チェック ---\n";
50
51        // 4. Phar::offsetExists メソッドを使って、ファイルが存在するか確認します。
52        //    引数にはPharアーカイブ内部のファイル名（$internalFileName）を指定します。
53        if ($phar->offsetExists($internalFileName)) {
54            echo "[成功] '{$internalFileName}' はPharアーカイブ内に存在します。\n";
55        } else {
56            echo "[失敗] '{$internalFileName}' はPharアーカイブ内に存在しませんでした。\n";
57        }
58
59        // 5. 存在しないファイルをチェックし、期待通りの結果が得られるか確認します。
60        $nonExistentFileName = 'non_existent_file.txt';
61        if ($phar->offsetExists($nonExistentFileName)) {
62            echo "[失敗] '{$nonExistentFileName}' は予期せずPharアーカイブ内に存在します。\n";
63        } else {
64            echo "[成功] '{$nonExistentFileName}' はPharアーカイブ内に存在しません（期待通り）。\n";
65        }
66
67        echo "\n--- ArrayAccess (isset) を使ったファイル存在チェック ---\n";
68
69        // 6. Phar::offsetExists は ArrayAccess インターフェースの一部であるため、
70        //    isset() 関数と配列のような構文を使って同様に確認できます。
71        if (isset($phar[$internalFileName])) {
72            echo "[成功] '{$internalFileName}' は ArrayAccess (isset) で存在します。\n";
73        } else {
74            echo "[失敗] '{$internalFileName}' は ArrayAccess (isset) で存在しませんでした。\n";
75        }
76
77    } catch (PharException $e) {
78        // Phar操作中にエラーが発生した場合の処理
79        echo "エラー: Phar操作中に問題が発生しました: " . $e->getMessage() . "\n";
80    } finally {
81        // 7. Pharオブジェクトがファイルロックを適切に解除できるように、unset します。
82        //    これにより、Pharファイルを後で削除できるようになります。
83        if (isset($phar)) {
84            unset($phar);
85        }
86        // 8. 一時的に作成したソースファイルをクリーンアップします。
87        if (file_exists($sourceTempFileName)) {
88            unlink($sourceTempFileName);
89            echo "\n一時的なソースファイル '{$sourceTempFileName}' を削除しました。\n";
90        }
91    }
92}
93
94// --- デモンストレーションの実行 ---
95// 作成するPharアーカイブのファイル名と、その内部に含めるファイルのパスを指定します。
96$pharArchiveName = 'my_example_app.phar';
97$internalFileName = 'src/main.php'; // Phar内部でのパスを想定
98demonstratePharOffsetExists($pharArchiveName, $internalFileName);
99
100// --- クリーンアップ ---
101// 9. デモンストレーションで作成したPharアーカイブを削除します。
102if (file_exists($pharArchiveName)) {
103    unlink($pharArchiveName);
104    echo "作成されたPharアーカイブ '{$pharArchiveName}' を削除しました。\n";
105}
106
107// 10. スクリプトの冒頭で変更した 'phar.readonly' の設定を元の状態に戻します。
108if ($originalPharReadonlySetting === '1') {
109    ini_set('phar.readonly', $originalPharReadonlySetting);
110}
111

Phar::offsetExistsは、PHPでアプリケーションを単一のアーカイブファイル（Pharファイル）として配布する際に利用するPharクラスのメソッドです。このメソッドは、指定されたPharアーカイブ内に、特定のファイルやディレクトリが存在するかどうかを効率的に確認するために使用されます。

引数$localNameには、確認したいファイルやディレクトリのパスをPharアーカイブ内部での相対パスとして文字列で渡します。メソッドは、このパスが存在すればtrueを、存在しなければfalseを真偽値（bool）として返します。

サンプルコードでは、まず新しいPharアーカイブを作成し、その中にテスト用のファイルを格納しています。その後、Phar::offsetExistsメソッドを呼び出して、追加したファイルがアーカイブ内に存在するかどうかを確認し、その結果を表示します。存在しないファイル名で確認を試みた場合はfalseが返され、期待通りの動作を示します。

PharクラスはArrayAccessインターフェースを実装しているため、isset($phar['ファイル名'])のような配列形式の構文でも同様にファイルの存在を確認することができます。これは、offsetExistsの挙動に基づいています。Pharアーカイブを作成したり内容を変更したりする際には、php.iniのphar.readonly設定が0である必要がある点にご留意ください。