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

isCRCCheckedメソッドは、Pharアーカイブ内の個々のファイルのCRC（Cyclic Redundancy Check）チェックが、そのPharファイルオブジェクト作成時に既に検証されているかどうかを確認するメソッドです。

このメソッドは、PHPのPhar拡張機能で使用されるPharFileInfoクラスの一部であり、Pharアーカイブに格納されているファイルやディレクトリの一つ一つに関する情報を提供します。Pharアーカイブは、複数のPHPファイルを一つのアーカイブとしてまとめるための形式で、配布やデプロイを容易にします。

CRCチェックは、データ転送や保存においてデータの整合性を検証するための一般的なエラー検出メカニズムです。Pharアーカイブの文脈では、アーカイブ内のファイルデータが破損していないか、または改ざんされていないかを保証するために重要な役割を果たします。

isCRCCheckedメソッドがtrueを返す場合、対象のPharファイルのエントリがPharアーカイブに書き込まれた際に、そのCRCチェックが適切に実行され、整合性が確認済みであることを意味します。逆にfalseが返される場合、CRCチェックがまだ実行されていないか、何らかの理由で検証されなかったことを示します。このメソッドを利用することで、Pharアーカイブからファイルを読み込む前に、そのデータの信頼性をプログラム的に確認することが可能になります。

Copy
1<?php
2$pharPath = __DIR__ . '/example.phar';
3@unlink($pharPath); // 以前のファイルを削除 (存在しない場合はエラーを抑制)
4
5try {
6    // 新しいPharアーカイブを作成し、ファイルを追加
7    $phar = new Phar($pharPath);
8    $phar->addFromString('my_document.txt', 'This is some sample content.');
9    $phar = null; // Pharオブジェクトを閉じてファイルをディスクに書き出す
10
11    // 保存されたPharアーカイブを再度開く
12    $phar = new Phar($pharPath);
13
14    // アーカイブ内のファイルに対応するPharFileInfoオブジェクトを取得
15    $fileInfo = $phar['my_document.txt'];
16
17    // isCRCChecked() メソッドを呼び出し、CRCチェックが有効かどうかを確認
18    $isCRCChecked = $fileInfo->isCRCChecked();
19
20    // 結果を出力 (通常、addFromStringで追加したファイルはデフォルトでCRCチェックされないため false を返すことが多い)
21    echo "ファイル 'my_document.txt' のCRCチェックは有効ですか？ " . ($isCRCChecked ? 'true' : 'false') . "\n";
22
23} catch (PharException $e) {
24    echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
25} finally {
26    // 生成した一時ファイルをクリーンアップ
27    if (file_exists($pharPath)) {
28        unlink($pharPath);
29    }
30}

引数なし

引数はありません

bool

PharFileInfo::isCRCChecked は、Phar ファイルの CRC チェックが有効である場合に true を、そうでなければ false を返します。