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

Copy
1<?php
2
3/**
4 * Pharアーカイブを作成し、そのサイズをPhar::getSize()メソッドを使って取得するデモンストレーション関数。
5 *
6 * この関数はシステムエンジニアを目指す初心者の方にも理解しやすいよう、
7 * 一時的なPharアーカイブファイルを作成し、そのサイズを取得する一連のプロセスを提示します。
8 * 処理が完了した後、作成された一時ファイルは自動的に削除されます。
9 */
10function demonstratePharGetSize(): void
11{
12    // 作成するPharアーカイブのファイル名と、その中に含めるファイル名を定義
13    $pharFileName = 'my_application.phar';
14    $internalFileName = 'main.php';
15    $internalFileContent = '<?php echo "Hello from inside the Phar!";';
16
17    // 現在のスクリプトがあるディレクトリにPharファイルと一時ソースファイルを作成
18    $pharPath = __DIR__ . '/' . $pharFileName;
19    $sourceFilePath = __DIR__ . '/' . $internalFileName;
20
21    // スクリプトの再実行に備え、既に存在する一時ファイルを削除してクリーンな状態にする
22    if (file_exists($pharPath)) {
23        unlink($pharPath);
24    }
25    if (file_exists($sourceFilePath)) {
26        unlink($sourceFilePath);
27    }
28
29    try {
30        // 1. Pharアーカイブに含めるコンテンツファイルを作成
31        // このファイルがPharアーカイブの中に格納されます。
32        file_put_contents($sourceFilePath, $internalFileContent);
33        echo "一時ソースファイル '{$internalFileName}' を作成しました。\n";
34
35        // 2. 新しいPharアーカイブを作成（書き込みモードでPharオブジェクトをインスタンス化）
36        // 引数には、作成されるPharファイルのパスを指定します。
37        $phar = new Phar($pharPath);
38
39        // 3. Pharアーカイブにコンテンツファイルを追加
40        // 第一引数: 物理的なソースファイルのパス
41        // 第二引数: Pharアーカイブ内でのファイルのパス（任意。省略可能ですが明示すると分かりやすい）
42        $phar->addFile($sourceFilePath, $internalFileName);
43
44        // 4. Pharアーカイブの実行スタブ（Stub）を設定
45        // これにより、作成されたPharファイルをPHPインタープリタで直接実行できるようになります。
46        $phar->setStub($phar->createDefaultStub());
47
48        // 5. Pharオブジェクトをクローズし、Pharファイルを完成させる
49        // オブジェクトをnullに設定することで、デストラクタが呼ばれ、ファイルが適切にクローズされます。
50        // これでPharファイルへのロックが解放され、外部からファイルにアクセスできるようになります。
51        $phar = null;
52
53        echo "Pharアーカイブ '{$pharFileName}' が正常に作成されました。\n";
54
55        // 6. 作成されたPharアーカイブを読み取りモードで開き、そのサイズを取得
56        // 完成したPharファイルを読み込むために、再度Pharオブジェクトをインスタンス化します。
57        $pharRead = new Phar($pharPath);
58
59        // 7. Phar::getSize() メソッドを呼び出して、Pharアーカイブ全体のサイズ（バイト単位）を取得
60        // このサイズには、アーカイブのメタデータ、スタブ、および内部に含まれるすべてのファイルの合計が含まれます。
61        $fileSize = $pharRead->getSize();
62
63        echo "Phar::getSize() を使用して '{$pharFileName}' のサイズを取得しました: {$fileSize} バイト\n";
64
65    } catch (PharException $e) {
66        // Phar固有の操作で発生したエラーをキャッチ
67        echo "エラー: Phar操作中に問題が発生しました: " . $e->getMessage() . "\n";
68    } catch (Exception $e) {
69        // その他の一般的なエラーをキャッチ
70        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
71    } finally {
72        // 処理の成功・失敗にかかわらず、一時的に作成したファイルを削除してクリーンアップ
73        if (file_exists($sourceFilePath)) {
74            unlink($sourceFilePath);
75        }
76        if (file_exists($pharPath)) {
77            unlink($pharPath);
78        }
79        echo "一時ファイルが正常に削除されました。\n";
80    }
81}
82
83// 関数を実行してデモンストレーションを開始
84demonstratePharGetSize();
85
86?>

PHPのPharクラスは、複数のPHPファイルや関連リソースを一つのアーカイブファイル（.pharファイル）にまとめる機能を提供します。これは、アプリケーションの配布やデプロイを簡素化するのに非常に役立つ仕組みです。

Phar::getSize()メソッドは、この.pharアーカイブファイル全体のサイズをバイト単位で取得するために使用されます。このメソッドは引数を一切必要とせず、アーカイブが占めるディスク上の正確なサイズを整数（int型）として返します。返されるサイズには、アーカイブ内部のすべてのファイルコンテンツ、メタデータ、およびPharファイルを実行可能にするためのスタブデータが合計された値が含まれます。

この機能は、作成したPharアーカイブのファイルサイズをプログラムで確認したい場合や、デプロイメントの際にディスク使用量を事前に把握したい場合などに特に有用です。

サンプルコードでは、まず一時的なPharアーカイブファイルを作成し、その中にシンプルなPHPコードを含むファイルを格納しています。アーカイブが正常に作成された後、再びPharオブジェクトを読み込みモードで開いて、Phar::getSize()メソッドを呼び出しています。これにより、作成されたアーカイブのファイルサイズが正確に取得され、コンソールに表示されます。処理の完了後には、作成された一時ファイルがすべてクリーンアップされ、環境が元に戻ります。