【PHP8.x】Phar::CURRENT_AS_FILEINFO定数の使い方

Copy
1<?php
2
3/**
4 * Phar::CURRENT_AS_FILEINFO 定数の使用例をデモンストレーションします。
5 * この定数は、Pharアーカイブ内のエントリをイテレートする際に、
6 * 各エントリが SplFileInfo (またはその子クラスである PharFileInfo) オブジェクトとして
7 * 返されることを指定するフラグです。これは Phar イテレータのデフォルトの挙動です。
8 *
9 * PHP の推奨コーディングスタイルに従っています。
10 * 単体で動作可能で、一時的なファイルとPharアーカイブを作成し、最後にクリーンアップします。
11 */
12function demonstratePharCurrentAsFileInfo(): void
13{
14    // 一時ファイルとPharアーカイブのパスを定義
15    $pharPath = __DIR__ . '/example_archive.phar';
16    $fileInPhar1 = 'first_file.txt';
17    $fileInPhar2 = 'nested/second_file.txt';
18    $tempFile1Path = __DIR__ . '/' . $fileInPhar1;
19    $tempFile2Path = __DIR__ . '/temp_nested_dir/' . basename($fileInPhar2);
20    $tempNestedDirPath = dirname($tempFile2Path);
21
22    // クリーンアップ処理を定義
23    $cleanup = function() use ($pharPath, $tempFile1Path, $tempNestedDirPath) {
24        // Pharアーカイブが存在する場合、削除を試みる
25        if (file_exists($pharPath)) {
26            // Pharオブジェクトがまだメモリにあると削除に失敗する場合があるため、
27            // @ を付けてエラーを抑制しつつ削除を試みる
28            @unlink($pharPath);
29            // .phar.gz などの圧縮ファイルが生成された場合も削除
30            @unlink($pharPath . '.gz');
31        }
32        // 一時ファイルを削除
33        if (file_exists($tempFile1Path)) {
34            unlink($tempFile1Path);
35        }
36        // 一時ディレクトリと内容を削除
37        if (is_dir($tempNestedDirPath)) {
38            $iterator = new RecursiveIteratorIterator(
39                new RecursiveDirectoryIterator($tempNestedDirPath, FilesystemIterator::SKIP_DOTS),
40                RecursiveIteratorIterator::CHILD_FIRST
41            );
42            foreach ($iterator as $item) {
43                if ($item->isDir()) {
44                    rmdir($item->getPathname());
45                } else {
46                    unlink($item->getPathname());
47                }
48            }
49            rmdir($tempNestedDirPath);
50        }
51    };
52
53    // 以前の実行で残ったファイルをクリーンアップ
54    $cleanup();
55
56    // Pharアーカイブ作成のための準備
57    echo "Pharアーカイブ作成のための準備を開始します。\n";
58    file_put_contents($tempFile1Path, "これは最初のファイルの内容です。\n");
59    if (!is_dir($tempNestedDirPath)) {
60        mkdir($tempNestedDirPath, 0777, true);
61    }
62    file_put_contents($tempFile2Path, "これはネストされたディレクトリ内のファイルです。\n");
63    echo "一時ファイルとディレクトリが作成されました。\n\n";
64
65    $phar = null; // Pharオブジェクトを初期化
66
67    try {
68        // php.ini で 'phar.readonly = Off' が設定されている必要があります。
69        // 設定されていない場合、PharException がスローされます。
70        // 第3引数はPharアーカイブのエイリアスです。
71        $phar = new Phar($pharPath, 0, 'example_archive.phar');
72
73        // アーカイブへの書き込み準備を開始
74        $phar->startBuffering();
75
76        // ファイルをPharアーカイブに追加
77        // 第一引数はローカルファイルのパス、第二引数はアーカイブ内のパス
78        $phar->addFile($tempFile1Path, $fileInPhar1);
79        $phar->addFile($tempFile2Path, $fileInPhar2);
80
81        // デフォルトのスタブを作成し、アーカイブを実行可能にする
82        // スタブはPharアーカイブの先頭に付加されるPHPコードです。
83        $phar->setStub($phar->createDefaultStub('index.php'));
84
85        // アーカイブへの書き込みを確定
86        $phar->stopBuffering();
87
88        echo "Pharアーカイブ '{$pharPath}' が正常に作成されました。\n\n";
89
90        // --- Phar::CURRENT_AS_FILEINFO のデモンストレーション開始 ---
91
92        echo "デフォルトのイテレーション動作の確認:\n";
93        echo "Phar::CURRENT_AS_FILEINFO フラグは、各エントリが PharFileInfo オブジェクトとして返されることを意味します。\n";
94        echo "これは Phar イテレータのデフォルトの動作です。\n\n";
95
96        // Pharオブジェクトをイテレートし、返されるオブジェクトの型を確認
97        foreach ($phar as $key => $file) {
98            echo "  Pharアーカイブ内のパス: " . $key . "\n";
99            echo "  返されたオブジェクトの型: " . get_class($file) . "\n";
100            if ($file instanceof SplFileInfo) { // PharFileInfo は SplFileInfo を継承しています
101                echo "  ファイル名: " . $file->getFilename() . "\n";
102                echo "  ファイルサイズ: " . $file->getSize() . " バイト\n";
103                // ファイルの内容は、PharFileInfo::getContents() で取得できます。
104                echo "  内容の先頭20文字: '" . substr($file->getContents(), 0, 20) . "...'\n";
105            }
106            echo "\n";
107        }
108        echo "デフォルトのイテレーション動作の確認が終了しました。\n\n";
109
110        echo "Phar::setIteratingFlags() で Phar::CURRENT_AS_FILEINFO を明示的に設定した場合の確認:\n";
111        echo "明示的に設定した場合も、デフォルトの動作と同じ結果が得られます。\n\n";
112
113        // Phar::setIteratingFlags() を使用して明示的にフラグを設定します。
114        // 他のフラグと組み合わせることも可能ですが、ここでは単独での使用を示します。
115        // 例: $phar->setIteratingFlags(Phar::CURRENT_AS_FILEINFO | Phar::KEY_AS_FILENAME);
116        $phar->setIteratingFlags(Phar::CURRENT_AS_FILEINFO);
117
118        foreach ($phar as $key => $file) {
119            echo "  Pharアーカイブ内のパス: " . $key . "\n";
120            echo "  返されたオブジェクトの型: " . get_class($file) . "\n";
121            if ($file instanceof SplFileInfo) {
122                echo "  ファイル名: " . $file->getFilename() . "\n";
123                echo "  ファイルサイズ: " . $file->getSize() . " バイト\n";
124                echo "  内容の先頭20文字: '" . substr($file->getContents(), 0, 20) . "...'\n";
125            }
126            echo "\n";
127        }
128        echo "Phar::CURRENT_AS_FILEINFO を明示的に設定した場合の確認が終了しました。\n\n";
129
130    } catch (PharException $e) {
131        echo "Phar関連のエラーが発生しました: " . $e->getMessage() . "\n";
132        echo "ヒント: Pharアーカイブを作成するには、php.ini で 'phar.readonly = Off' が設定されている必要があります。\n";
133    } catch (Exception $e) {
134        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
135    } finally {
136        // Pharオブジェクトをunsetすることで、ファイルへのロックが解除されやすくなります。
137        unset($phar);
138        // 処理が完了したら、一時ファイルとPharアーカイブをクリーンアップ
139        $cleanup();
140        echo "一時ファイルとPharアーカイブがクリーンアップされました。\n";
141    }
142}
143
144// デモンストレーション関数を実行
145demonstratePharCurrentAsFileInfo();
146
147?>

PHPのPhar::CURRENT_AS_FILEINFO定数は、Phar拡張機能で使用される定数で、Pharアーカイブ内のファイルを順に処理（イテレート）する際の挙動を制御するために使われます。この定数は引数を取らず、戻り値もありません。

この定数を指定すると、Pharアーカイブ内の各ファイルやディレクトリ（エントリ）が、ファイルに関する詳細な情報を持つPharFileInfoオブジェクトとして返されます。PharFileInfoはPHP標準のSplFileInfoクラスを継承しており、これによって、イテレータで得られる各エントリから、ファイル名、ファイルサイズ、最終更新日時、そしてファイルの内容といった多岐にわたる情報に簡単にアクセスできるようになります。これにより、アーカイブ内のコンテンツを効率的に調べて操作することが可能になります。

Phar::CURRENT_AS_FILEINFOは、Pharイテレータのデフォルトの動作を定義するものであり、通常は明示的に設定しなくてもこの挙動が適用されます。サンプルコードでは、まず特にフラグを指定しないデフォルトのイテレーションでPharFileInfoオブジェクトが返されることを確認しています。続いて、Phar::setIteratingFlags()メソッドを使ってこの定数を明示的に設定した場合も、同様にPharFileInfoオブジェクトが返され、その詳細な属性にアクセスできる様子が示されており、定数の役割が明確に理解できます。

Copy
1<?php
2
3// このスクリプトは、Pharアーカイブを作成し、Phar::CURRENT_AS_FILEINFO 定数を使用して
4// その内容をイテレートする方法を示します。
5// この定数により、イテレーション中に各エントリが詳細情報を持つPharFileInfoオブジェクトとして扱われます。
6
7// Phar拡張機能がPHPに読み込まれているかを確認します。
8if (!extension_loaded('phar')) {
9    echo "エラー: Phar拡張機能が有効になっていません。PHPの構成を確認してください。\n";
10    exit(1);
11}
12
13// Pharアーカイブを作成するために、'phar.readonly' を一時的に無効にします。
14// セキュリティ上の理由から、本番環境では注意して使用するか、ビルド時にのみ使用してください。
15$originalPharReadonly = ini_get('phar.readonly');
16if ($originalPharReadonly === '1') {
17    ini_set('phar.readonly', '0');
18    // ini_setが成功したか確認
19    if (ini_get('phar.readonly') === '1') {
20        echo "エラー: 'phar.readonly' を無効にできませんでした。php.iniまたはWebサーバーの設定を確認してください。\n";
21        exit(1);
22    }
23}
24
25$pharFilePath = __DIR__ . '/example.phar'; // 作成するPharアーカイブのパス
26
27// 前回の実行で残ったPharファイルを削除し、クリーンな状態にします。
28if (file_exists($pharFilePath)) {
29    unlink($pharFilePath);
30}
31
32try {
33    // 1. Pharアーカイブの作成
34    echo "--- Pharアーカイブの作成を開始します ---\n";
35    $phar = new Phar($pharFilePath);
36
37    // Pharファイルを書き込み可能にするためにバッファリングを開始します。
38    $phar->startBuffering();
39
40    // アーカイブにファイルを追加します。
41    // 第1引数はアーカイブ内のパス、第2引数はファイルの内容です。
42    $phar->addFromString('first_file.txt', 'これはアーカイブ内の最初のファイルです。');
43    $phar->addFromString('data/second_file.txt', 'これはdataディレクトリ内の2番目のファイルです。');
44
45    // Pharアーカイブの実行スタブ（Pharファイルを直接実行したときに実行されるPHPコード）を設定します。
46    $phar->setDefaultStub('<?php __HALT_COMPILER(); ?>');
47
48    // バッファリングを停止し、変更をPharファイルに書き込みます。
49    $phar->stopBuffering();
50    echo "Pharアーカイブ '{$pharFilePath}' が正常に作成されました。\n\n";
51
52    // 2. Pharアーカイブの読み込みと内容のイテレート
53    echo "--- Phar::CURRENT_AS_FILEINFO を使用してアーカイブ内容をイテレートします ---\n";
54    // 作成したPharアーカイブを読み込みモードで開きます。
55    $phar = new Phar($pharFilePath);
56
57    // イテレータのフラグを設定します。
58    // Phar::CURRENT_AS_FILEINFO を設定すると、foreachループで取得される各エントリが
59    // PharFileInfo オブジェクトとして扱われます。これにより、ファイル名、サイズ、更新日時などの
60    // 詳細なファイルプロパティにアクセスできます。
61    $phar->setIteratorsFlags(Phar::CURRENT_AS_FILEINFO);
62
63    // Pharアーカイブ内の各エントリをループで処理します。
64    foreach ($phar as $pathInPhar => $fileInfo) {
65        // $fileInfo は PharFileInfo クラスのインスタンスです。
66        if ($fileInfo instanceof PharFileInfo) {
67            echo "  アーカイブ内パス: " . $fileInfo->getPathname() . "\n";
68            echo "  ファイル名: " . $fileInfo->getFilename() . "\n";
69            echo "  ファイルサイズ: " . $fileInfo->getSize() . " バイト\n";
70            echo "  最終更新日時: " . date('Y-m-d H:i:s', $fileInfo->getMTime()) . "\n";
71            echo "  ディレクトリか？: " . ($fileInfo->isDir() ? 'はい' : 'いいえ') . "\n";
72            echo "----------------------------------------\n";
73        } else {
74            echo "  エラー: 予期しないオブジェクトタイプが検出されました: " . get_class($fileInfo) . "\n";
75        }
76    }
77
78} catch (PharException $e) {
79    // Phar関連の操作で発生する例外を捕捉します。
80    echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
81} catch (Exception $e) {
82    // その他の予期せぬエラーを捕捉します。
83    echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
84} finally {
85    // クリーンアップ: スクリプトの終了時に作成したPharファイルを削除します。
86    if (file_exists($pharFilePath)) {
87        unlink($pharFilePath);
88        echo "\nクリーンアップ: 作成したPharアーカイブ '{$pharFilePath}' を削除しました。\n";
89    }
90
91    // 'phar.readonly' 設定を元の状態に戻します。
92    if ($originalPharReadonly === '1' && ini_get('phar.readonly') === '0') {
93        ini_set('phar.readonly', '1');
94    }
95}

このPHPサンプルコードは、複数のファイルを一つにまとめるPharアーカイブの作成と、その内容を詳細に読み解く方法を示しています。特にPhar::CURRENT_AS_FILEINFO定数の使い方に焦点を当てています。この定数はPharクラスのメソッドsetIteratorsFlags()に設定するフラグの一つで、Pharアーカイブ内のファイルを一つずつ取り出す（イテレートする）際に、それぞれのファイルをPharFileInfoという特別なオブジェクトとして扱わせる役割があります。この定数自体には引数や戻り値はありません。通常、イテレート時にはファイル名のみが得られますが、この定数を指定することで、ファイル名だけでなく、ファイルサイズ、最終更新日時、ディレクトリであるかなどの詳細な情報にアクセスできるようになります。サンプルコードでは、phar.readonly設定を一時的に無効にしてアーカイブを作成した後、Phar::CURRENT_AS_FILEINFOを設定してアーカイブを読み込み、foreachループで各ファイルのPharFileInfoオブジェクトから多様なプロパティを取得し、表示しています。これにより、Pharアーカイブの内容をより深く理解し、柔軟に処理することが可能になります。