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

Copy
1<?php
2
3/**
4 * PharFileInfo::getExtension() メソッドの使用例。
5 * このスクリプトは、一時的なPharアーカイブを作成し、その中のファイルから拡張子を取得する方法を示します。
6 */
7
8// 一時的なPharアーカイブのファイル名を定義
9$pharFileName = 'example.phar';
10// アーカイブ内に格納するファイルのパスと名前（拡張子を含む）
11$filePathInPhar = 'data/report.pdf';
12// アーカイブに追加するファイルの内容
13$fileContent = 'これはPDFレポートのダミー内容です。';
14
15try {
16    // スクリプト実行前に同名のPharアーカイブが存在する場合、削除してクリーンな状態にする
17    if (file_exists($pharFileName)) {
18        unlink($pharFileName);
19    }
20
21    // 新しいPharアーカイブを書き込みモード ('w') で作成
22    // 第3引数はPharアーカイブのエイリアス。実行時にPharアーカイブを識別するために使用されます。
23    $phar = new Phar($pharFileName, 0, $pharFileName);
24
25    // Pharアーカイブの内容編集を開始（バッファリングモード）
26    // これにより、複数の変更を一度に適用し、パフォーマンスを向上させます。
27    $phar->startBuffering();
28
29    // 最小限のスタブ（Pharアーカイブが実行可能であるために必要なコード）を設定
30    // createDefaultStub() はPHPインタープリタにPharアーカイブを読み込むための基本的なスタブを生成します。
31    $phar->setStub($phar->createDefaultStub());
32
33    // 指定したパスと内容で、Pharアーカイブ内に新しいファイルを追加
34    $phar->addFromString($filePathInPhar, $fileContent);
35
36    // バッファリングを終了し、全ての変更をPharアーカイブファイルに書き込む
37    $phar->stopBuffering();
38
39    echo "Pharアーカイブ '{$pharFileName}' が正常に作成されました。\n";
40
41    // Pharアーカイブから特定のファイルの情報（PharFileInfoオブジェクト）を取得
42    // このオブジェクトは、アーカイブ内のファイルに関する様々な情報を提供します。
43    $fileInfo = $phar->offsetGet($filePathInPhar);
44
45    // getExtension() メソッドを呼び出してファイルの拡張子を取得
46    // 戻り値はファイルの拡張子部分の文字列（例: "pdf"）
47    $extension = $fileInfo->getExtension();
48
49    echo "アーカイブ内のファイル '{$filePathInPhar}' の拡張子は: '{$extension}' です。\n";
50
51} catch (PharException $e) {
52    // Phar関連の操作中に発生したエラーを捕捉
53    echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
54} catch (Exception $e) {
55    // その他の一般的なエラーを捕捉
56    echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
57} finally {
58    // スクリプトの実行終了後、作成したPharアーカイブをクリーンアップとして削除
59    if (file_exists($pharFileName)) {
60        unlink($pharFileName);
61        echo "Pharアーカイブ '{$pharFileName}' を削除しました。\n";
62    }
63}

PharFileInfo::getExtension()メソッドは、PHPのPharアーカイブ内で管理されている特定のファイルから、その拡張子を取得するための機能です。Phar（PHPアーカイブ）は、複数のPHPスクリプトやリソースファイルを一つのアーカイブファイルにまとめ、単一ファイルとして配布・実行可能にするための仕組みです。

サンプルコードでは、まず一時的にexample.pharというPharアーカイブを作成し、その中にdata/report.pdfというファイルを追加しています。Pharアーカイブ内の個々のファイルに関する情報を操作するには、PharFileInfoクラスのインスタンスが必要です。サンプルコードでは、$phar->offsetGet($filePathInPhar)を使って、追加したdata/report.pdfに対応するPharFileInfoオブジェクトを取得しています。

このPharFileInfoオブジェクトに対してgetExtension()メソッドを呼び出すことで、ファイルの拡張子を文字列として取得できます。このメソッドは引数を一切必要とせず、ファイル名から拡張子部分のみ（例えば"report.pdf"であれば"pdf"）を抽出し、その文字列を戻り値として返します。これにより、Pharアーカイブ内に含まれるファイルのタイプをプログラムで識別し、適切な処理を行うことが可能になります。