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

Copy
1<?php
2
3// このスクリプトはPharアーカイブの作成と操作を行うため、
4// php.ini の 'phar.readonly' 設定が '0' になっているか、
5// または一時的に許可される環境で実行する必要があります。
6
7// 一時的なPharファイル名
8$pharFileName = 'my_sample_archive.phar';
9// Pharアーカイブ内に格納するダミーファイル名
10$internalFileName = 'sample_content.txt';
11// ダミーファイルの内容
12$fileContent = 'これはPharアーカイブに格納されたテストコンテンツです。';
13
14try {
15    // 1. 新しいPharアーカイブを作成（もし既存なら上書き）
16    // new Phar() の第一引数にファイル名を指定し、新しいPharアーカイブを作成します。
17    // PHPはデフォルトでPharの書き込みを制限している場合があるため、
18    // 実行環境によっては php.ini で 'phar.readonly = 0' の設定が必要です。
19    $phar = new Phar($pharFileName);
20    $phar->startBuffering(); // 書き込み操作のパフォーマンスを向上させるためにバッファリングを開始
21
22    // 2. Pharアーカイブにファイルを文字列として追加
23    // addFromString() メソッドを使って、アーカイブ内に新しいファイルを作成し、内容を設定します。
24    $phar->addFromString($internalFileName, $fileContent);
25
26    // 3. バッファリングを終了し、アーカイブをディスクに書き込む
27    $phar->stopBuffering();
28
29    echo "Pharアーカイブ '{$pharFileName}' が作成され、内部に '{$internalFileName}' が追加されました。\n\n";
30
31    // 4. 作成したPharアーカイブから、特定のファイルのエントリ（PharFileInfoオブジェクト）を取得
32    // Pharオブジェクトは配列のように扱え、内部のファイル名をキーとしてアクセスできます。
33    // ここで取得される `$pharFileInfo` は `PharFileInfo` オブジェクトです。
34    /** @var PharFileInfo $pharFileInfo */
35    $pharFileInfo = $phar[$internalFileName];
36
37    echo "Pharアーカイブ内の '{$internalFileName}' の元の情報:\n";
38    echo "  元のクラス: " . get_class($pharFileInfo) . "\n";
39    echo "  ファイル名: " . $pharFileInfo->getFilename() . "\n";
40    echo "  サイズ: " . $pharFileInfo->getSize() . " バイト\n\n";
41
42    // 5. PharFileInfo::getFileInfo() メソッドを使って SplFileInfo オブジェクトを取得
43    // getFileInfo() は、Pharアーカイブ内のファイルを表す `SplFileInfo` オブジェクトを返します。
44    // これにより、通常のファイルシステム上のファイルと同じように情報を取得できます。
45    $splFileInfo = $pharFileInfo->getFileInfo();
46
47    // 6. 取得した SplFileInfo オブジェクトの情報を表示
48    if ($splFileInfo instanceof SplFileInfo) {
49        echo "getFileInfo() メソッドで取得した情報:\n";
50        echo "  戻り値のクラス: " . get_class($splFileInfo) . "\n";
51        echo "  ファイル名 (getFilename): " . $splFileInfo->getFilename() . "\n";
52        echo "  パス名 (getPathname): " . $splFileInfo->getPathname() . "\n";
53        echo "  ファイルサイズ (getSize): " . $splFileInfo->getSize() . " バイト\n";
54        echo "  読み込み可能か (isReadable): " . ($splFileInfo->isReadable() ? 'はい' : 'いいえ') . "\n";
55    } else {
56        // 基本的には発生しないはずですが、戻り値の型ヒントが ?SplFileInfo なので null の可能性も考慮
57        echo "エラー: getFileInfo() が SplFileInfo オブジェクトを返しませんでした。\n";
58    }
59
60} catch (Exception $e) {
61    // エラーが発生した場合、そのメッセージを表示
62    echo "エラーが発生しました: " . $e->getMessage() . "\n";
63    echo "ヒント: 'phar.readonly = 0' を php.ini に設定する必要があるかもしれません。\n";
64} finally {
65    // 7. サンプル実行後に作成したPharファイルを削除（クリーンアップ）
66    // Phar::unlinkPhar() を使ってPharアーカイブファイルを安全に削除します。
67    if (file_exists($pharFileName)) {
68        Phar::unlinkPhar($pharFileName);
69        echo "\nPharアーカイブ '{$pharFileName}' を削除しました。\n";
70    }
71}
72

PharFileInfo::getFileInfoメソッドは、PHPのPharアーカイブ内に格納されている特定のファイルに関する詳細な情報を、通常のファイルシステム上のファイルと同じように扱えるSplFileInfoオブジェクトとして取得するために利用されます。このメソッドは引数をとりません。

サンプルコードでは、まずmy_sample_archive.pharという名前のPharアーカイブを作成し、その内部にsample_content.txtというファイルを追加する一連の流れを示しています。Pharアーカイブは、複数のファイルを単一のアーカイブにまとめ、必要に応じて実行可能にできるPHPの機能です。

アーカイブ作成後、$phar[$internalFileName]のようにアクセスすることで、アーカイブ内の指定されたファイル（この場合はsample_content.txt）に対応するPharFileInfoオブジェクトを取得します。このPharFileInfoオブジェクトは、Pharアーカイブ内のファイルに特化した情報を提供します。

取得したPharFileInfoオブジェクトに対し、getFileInfo()メソッドを呼び出すと、その内部ファイルが一般的なファイルシステム上のファイルと同様に扱えるSplFileInfoオブジェクトとして返されます。このSplFileInfoオブジェクトからは、ファイル名、パス名、サイズ、読み込み可否など、通常のファイル操作で利用する多様な情報を取得できます。

戻り値の型が?SplFileInfoであるため、何らかの理由で情報が取得できなかった場合はnullが返される可能性もありますが、通常は有効なSplFileInfoオブジェクトが提供されます。これにより、Pharアーカイブの内部ファイルを透過的に扱えるようになります。

Copy
1<?php
2
3// このスクリプトは、Pharアーカイブ（PHPアーカイブ）内のファイル情報を取得する方法を示します。
4// システムエンジニアを目指す初心者向けに、PharFileInfo::getFileInfo メソッドの使用例を簡潔に提供します。
5
6/**
7 * Pharアーカイブ内のファイル情報を取得するサンプルスクリプトです。
8 *
9 * 1. 一時的なテキストファイルを作成します。
10 * 2. それらのファイルを含むPharアーカイブを作成します。
11 * 3. 作成したPharアーカイブを開き、各エントリ（ファイル）を反復処理します。
12 * 4. 各PharFileInfoオブジェクトに対してgetFileInfo()を呼び出し、SplFileInfoオブジェクトを取得して情報を表示します。
13 * 5. 最後に、作成した一時ファイルとPharアーカイブを削除します。
14 */
15
16// 一時的なファイル名とPharアーカイブのパスを定義します
17$tempDir = __DIR__;
18$pharFileName = 'my_sample.phar';
19$pharFilePath = $tempDir . DIRECTORY_SEPARATOR . $pharFileName;
20$file1Name = 'sample_file1.txt';
21$file2Name = 'sample_file2.txt';
22$file1Path = $tempDir . DIRECTORY_SEPARATOR . $file1Name;
23$file2Path = $tempDir . DIRECTORY_SEPARATOR . $file2Name;
24
25try {
26    // --- 準備: Pharアーカイブに含める一時的なファイルを作成 ---
27    file_put_contents($file1Path, "これはサンプルファイル1の内容です。\n");
28    file_put_contents($file2Path, "これはサンプルファイル2の内容です。\n");
29    echo "一時ファイルを作成しました：" . $file1Path . ", " . $file2Path . PHP_EOL;
30
31    // 既存のPharアーカイブがあれば削除 (スクリプトの再実行時に問題を起こさないため)
32    if (file_exists($pharFilePath)) {
33        unlink($pharFilePath);
34    }
35
36    // --- 1. Pharアーカイブの作成とファイルの追加 ---
37    // Pharオブジェクトを作成します。
38    // 第1引数: Pharファイルのパス
39    // 第2引数: フラグ (FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::KEY_AS_FILENAME は、Pharをイテレートする際の挙動を設定)
40    // 第3引数: Pharアーカイブ名 (内部的な識別子)
41    $phar = new Phar($pharFilePath, FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::KEY_AS_FILENAME, $pharFileName);
42
43    // バッファリングを開始し、複数のファイル追加を効率的に行います
44    $phar->startBuffering();
45
46    // 作成した一時ファイルをPharアーカイブに追加します。
47    // 第1引数: 外部ファイルのパス
48    // 第2引数: Pharアーカイブ内のパス (省略すると外部ファイル名と同じ)
49    $phar->addFile($file1Path, 'phar_inner_file1.txt');
50    $phar->addFile($file2Path, 'phar_inner_file2.txt');
51
52    // バッファリングを終了し、変更をPharファイルに書き込みます
53    $phar->stopBuffering();
54
55    // Pharオブジェクトをunsetすることで、ファイルハンドルが閉じられ、Pharファイルが完成します
56    unset($phar);
57
58    echo "Pharアーカイブを作成しました: " . $pharFilePath . PHP_EOL . PHP_EOL;
59
60    // --- 2. 作成したPharアーカイブを開き、ファイルリストを取得して情報を表示 ---
61    echo "Pharアーカイブ '" . $pharFileName . "' 内のファイル情報:" . PHP_EOL;
62
63    // 作成したPharアーカイブを読み込みモードで開きます
64    $phar = new Phar($pharFilePath);
65
66    // Pharアーカイブ内の各エントリ（ファイル）をループ処理します
67    foreach ($phar as $fileNameInPhar => $pharFileInfo) {
68        // $pharFileInfo は PharFileInfo クラスのインスタンスです
69        echo "----------------------------------------" . PHP_EOL;
70        echo "Phar内のパス: " . $fileNameInPhar . PHP_EOL;
71
72        // PharFileInfo::getFileInfo() メソッドを呼び出し、SplFileInfo オブジェクトを取得します。
73        // このメソッドは、Pharアーカイブ内のエントリに対応するSplFileInfoオブジェクトを返します。
74        // 戻り値は ?SplFileInfo (nullまたはSplFileInfo) 型です。
75        $splFileInfo = $pharFileInfo->getFileInfo();
76
77        if ($splFileInfo instanceof SplFileInfo) {
78            echo "  [SplFileInfo からの追加情報]:" . PHP_EOL;
79            echo "    ファイル名: " . $splFileInfo->getFilename() . PHP_EOL;
80            echo "    サイズ: " . $splFileInfo->getSize() . " バイト" . PHP_EOL;
81            echo "    最終変更日時: " . date('Y-m-d H:i:s', $splFileInfo->getMTime()) . PHP_EOL;
82            echo "    読み込み可能: " . ($splFileInfo->isReadable() ? 'はい' : 'いいえ') . PHP_EOL;
83            echo "    ディレクトリ: " . ($splFileInfo->isDir() ? 'はい' : 'いいえ') . PHP_EOL;
84        } else {
85            echo "  getFileInfo() が SplFileInfo オブジェクトを返しませんでした。" . PHP_EOL;
86        }
87    }
88    echo "----------------------------------------" . PHP_EOL;
89
90} catch (PharException $e) {
91    // Phar関連のエラーを捕捉します
92    echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . PHP_EOL;
93} catch (Exception $e) {
94    // その他の予期せぬエラーを捕捉します
95    echo "スクリプト実行中に予期せぬエラーが発生しました: " . $e->getMessage() . PHP_EOL;
96} finally {
97    // --- 後処理: 作成した一時ファイルとPharアーカイブを削除 ---
98    echo PHP_EOL . "--- クリーンアップ ---" . PHP_EOL;
99    if (file_exists($file1Path)) {
100        unlink($file1Path);
101        echo "一時ファイル '" . $file1Path . "' を削除しました。" . PHP_EOL;
102    }
103    if (file_exists($file2Path)) {
104        unlink($file2Path);
105        echo "一時ファイル '" . $file2Path . "' を削除しました。" . PHP_EOL;
106    }
107    if (file_exists($pharFilePath)) {
108        // Phar::unlinkArchive() はPHP 8.0で削除されたため、unlink() を使用します
109        unlink($pharFilePath);
110        echo "Pharアーカイブ '" . $pharFilePath . "' を削除しました。" . PHP_EOL;
111    }
112    echo "クリーンアップが完了しました。" . PHP_EOL;
113}

PHPのPharFileInfo::getFileInfoメソッドは、Pharアーカイブ（PHPの実行可能なアーカイブファイル）内に格納されている個々のファイルに関する詳細な情報を取得するために使用されます。このメソッドは引数を必要とせず、Pharアーカイブ内の特定のエントリ（ファイル）に対応するSplFileInfoオブジェクトを返します。SplFileInfoはファイルシステム上のファイルに関する汎用的な情報を提供するPHPの標準クラスであり、ファイル名、サイズ、最終変更日時、読み込み可能かどうかといった多岐にわたる属性にアクセスできます。メソッドの戻り値は?SplFileInfo型であり、これはSplFileInfoオブジェクトが返されるか、あるいは情報が取得できなかった場合にnullが返される可能性があることを示します。

提供されたサンプルコードでは、まず一時的なファイルをいくつか作成し、それらをまとめてmy_sample.pharというPharアーカイブを作成しています。その後、作成したPharアーカイブを開いて内部のファイルを一つずつ処理する際、各ファイルを表すPharFileInfoオブジェクトに対してgetFileInfo()を呼び出しています。これにより取得したSplFileInfoオブジェクトを利用して、アーカイブ内のファイルの具体的な情報を詳細に表示し、PharFileInfo::getFileInfoメソッドがPharアーカイブのファイル内容を深く理解するための重要な手段であることを示しています。この機能は、Pharアーカイブをプログラムで管理したり、その内容を検証したりする際に非常に役立ちます。