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

Copy
1<?php
2
3// このサンプルコードは、Pharアーカイブファイルの一時的な作成と削除を行います。
4// 実行にはPHPのPhar拡張が有効になっている必要があります。
5
6// 一時的なPharアーカイブのファイルパスを設定します。
7$pharFileName = __DIR__ . '/example_archive.phar';
8// アーカイブに追加するファイルの名前と内容を定義します。
9$fileInPharName = 'my_document.txt';
10$fileInPharContent = 'This is a test document inside the Phar archive.';
11
12// 以前の実行で残ったPharファイルを削除し、クリーンな状態を保ちます。
13if (file_exists($pharFileName)) {
14    unlink($pharFileName);
15}
16
17try {
18    // 1. 新しいPharアーカイブを作成します。
19    // Pharクラスのインスタンスを生成し、アーカイブファイルを指定します。
20    $phar = new Phar($pharFileName);
21
22    // Pharアーカイブへの書き込みをバッファリングします。
23    // これにより、複数のファイル追加操作を一度にディスクに書き込むことができます。
24    $phar->startBuffering();
25
26    // 2. アーカイブにファイルを追加します。
27    // addFromStringメソッドで、指定した名前と内容のファイルをアーカイブに追加します。
28    // デフォルトでは、追加されたファイルにはCRCチェックが行われます。
29    $phar->addFromString($fileInPharName, $fileInPharContent);
30
31    // バッファリングを終了し、Pharファイルへの変更を確定します。
32    $phar->stopBuffering();
33
34    echo "Pharアーカイブ '{$pharFileName}' が正常に作成されました。\n";
35    echo "ファイル '{$fileInPharName}' がアーカイブに追加されました。\n\n";
36
37    // 3. 作成したPharアーカイブを開き、ファイル情報を取得します。
38    // 同じPharオブジェクトを読み込みモードとして利用します。
39    // または、新しいPhar($pharFileName)で開くことも可能です。
40
41    // アーカイブ内の特定のファイルのPharFileInfoオブジェクトを取得します。
42    // 配列のキーとしてファイル名を指定します。
43    if (isset($phar[$fileInPharName])) {
44        /** @var PharFileInfo $fileInfo */
45        $fileInfo = $phar[$fileInPharName];
46
47        // 4. PharFileInfo::isCRCChecked() メソッドを使用してCRCチェックが行われたかを確認します。
48        // このメソッドは、ファイルがアーカイブに追加された際にCRCチェックが適用された場合にtrueを返します。
49        // キーワード: php if checked
50        if ($fileInfo->isCRCChecked()) {
51            echo "ファイル '{$fileInPharName}' はCRCチェック済みです。\n";
52        } else {
53            echo "ファイル '{$fileInPharName}' はCRCチェックされていません。\n";
54        }
55    } else {
56        echo "エラー: アーカイブ内に指定されたファイル '{$fileInPharName}' が見つかりません。\n";
57    }
58
59} catch (PharException $e) {
60    // Phar操作中に例外が発生した場合、エラーメッセージを表示します。
61    echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
62} finally {
63    // 処理の終了後、作成されたPharアーカイブファイルを削除してクリーンアップします。
64    if (file_exists($pharFileName)) {
65        unlink($pharFileName);
66        echo "\nPharアーカイブ '{$pharFileName}' が削除されました。\n";
67    }
68}
69
70?>

このサンプルコードは、PHPのPhar拡張を利用して、作成したアーカイブファイル内の特定のファイルがデータ整合性チェックであるCRC（巡回冗長検査）の対象となっているかを確認する方法を示しています。

PharFileInfo::isCRCChecked()メソッドは、PharFileInfoクラスに属しており、Pharアーカイブ内の個々のファイル情報を示すオブジェクトから呼び出されます。このメソッドは引数を受け取らず、ファイルがアーカイブに追加される際にCRCチェックが適用された場合にtrueを、そうでなければfalseをbool型で返します。

コードでは、まず一時的なPharアーカイブファイルを作成し、addFromStringメソッドでmy_document.txtというファイルをアーカイブに追加しています。デフォルトでは、追加されたファイルにはCRCチェックが行われます。その後、アーカイブからmy_document.txtのファイル情報（$fileInfo）を取得し、$fileInfo->isCRCChecked()を呼び出しています。このメソッドの戻り値はif文で評価され、ファイルがCRCチェック済みであれば「CRCチェック済みです」と、そうでなければ「CRCチェックされていません」と表示されます。これにより、アーカイブ内のファイルがデータ整合性チェックの対象であるかをプログラムで確認できます。

Copy
1<?php
2
3// 一時的なPharアーカイブのファイル名を定義します。
4// '__DIR__' は現在のスクリプトがあるディレクトリを指します。
5$pharFileName = __DIR__ . '/example.phar';
6// Pharアーカイブ内に作成するファイルの名前
7$fileNameInPhar = 'sample_file.txt';
8
9/**
10 * スクリプトの実行終了時に、作成した一時Pharアーカイブを削除するための処理を登録します。
11 * これにより、サンプルコード実行後に不要なファイルが残るのを防ぎます。
12 */
13register_shutdown_function(function() use ($pharFileName) {
14    if (file_exists($pharFileName)) {
15        try {
16            // Phar::unlinkArchive() はPharアーカイブとその関連ファイル（署名など）を安全に削除します。
17            Phar::unlinkArchive($pharFileName);
18            echo "一時Pharアーカイブ '{$pharFileName}' を削除しました。\n";
19        } catch (Exception $e) {
20            echo "一時Pharアーカイブ '{$pharFileName}' の削除に失敗しました: " . $e->getMessage() . "\n";
21        }
22    }
23});
24
25try {
26    // 1. 新しいPharアーカイブを作成します。
27    // 第一引数: 作成するPharアーカイブのパス。
28    // 第二引数: フラグ（Phar::CURRENT_API_VERSIONを推奨しますが、0でも動作します）。
29    // 第三引数: このアーカイブを参照するためのエイリアス（オプション）。
30    $phar = new Phar($pharFileName, 0, 'my_example.phar');
31
32    // バッファリングを開始し、Pharアーカイブへの書き込みを可能にします。
33    $phar->startBuffering();
34
35    // 2. Pharアーカイブ内にサンプルファイルを追加します。
36    // 'addFromString' メソッドは、指定された名前でコンテンツをアーカイブに追加します。
37    // デフォルトでは、追加されるファイルはCRC（巡回冗長検査）チェックが有効になります。
38    $fileContent = "これはPharアーカイブ内のサンプルファイルの内容です。";
39    $phar->addFromString($fileNameInPhar, $fileContent);
40
41    // バッファリングを終了し、変更をPharアーカイブに保存します。
42    $phar->stopBuffering();
43
44    echo "Pharアーカイブ '{$pharFileName}' を作成し、'{$fileNameInPhar}' を追加しました。\n";
45
46    // 3. Pharアーカイブから特定のファイルの情報を取得します。
47    // `$phar[$fileNameInPhar]` の形式で、アーカイブ内のファイルにアクセスし、
48    // PharFileInfo オブジェクトを取得できます。
49    $fileInfo = $phar[$fileNameInPhar];
50
51    // 4. PharFileInfo::isCRCChecked() メソッドを呼び出し、
52    // そのファイルがCRCチェックされているかどうかを確認します。
53    // 戻り値は bool (true または false) です。
54    $isCRCChecked = $fileInfo->isCRCChecked();
55
56    // 5. 結果を表示します。
57    if ($isCRCChecked) {
58        echo "ファイル '{$fileNameInPhar}' はCRCチェックが有効です。\n";
59    } else {
60        echo "ファイル '{$fileNameInPhar}' はCRCチェックが無効です。\n";
61    }
62
63} catch (PharException $e) {
64    // Phar関連の操作中に発生したエラーを捕捉します。
65    echo "Phar関連のエラーが発生しました: " . $e->getMessage() . "\n";
66} catch (Exception $e) {
67    // その他の予期せぬエラーを捕捉します。
68    echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
69}
70
71?>

PHPのPharFileInfo::isCRCChecked()メソッドは、PHPの拡張機能であるPharアーカイブ内の特定のファイルに対して、CRC（巡回冗長検査）チェックが有効になっているかどうかを調べるために使用されます。Pharアーカイブは、複数のファイルを一つのファイルにまとめ、アプリケーションの配布などに利用される形式です。CRCチェックは、ファイルが転送や保存中に破損したり改ざんされたりしていないかを確認するためのデータ整合性検証の一種です。このメソッドは引数を一切取らず、戻り値としてbool（真偽値）を返します。ファイルのCRCチェックが有効であればtrueを、無効であればfalseを返します。

サンプルコードでは、まず一時的なPharアーカイブを作成し、その中にsample_file.txtというファイルを追加しています。PharにファイルをaddFromStringで追加すると、デフォルトでCRCチェックが有効になります。その後、作成したPharアーカイブからsample_file.txtに対応するPharFileInfoオブジェクトを取得し、そのオブジェクトに対してisCRCChecked()メソッドを呼び出しています。これにより、追加したファイルのCRCチェックが有効になっていることをプログラム的に確認し、結果を表示しています。このメソッドは、Pharアーカイブ内のファイルの整合性状態を把握したい場合に利用できます。