【PHP8.x】AssertionError::fileプロパティの使い方

Copy
1<?php
2
3// このスクリプトが単体で動作するための設定
4// PHP 8では、`assert.exception`はデフォルトで `On (1)` ですが、明示的に設定します。
5// Zend Engineのアサーションを有効にします。
6ini_set('zend.assertions', 1);
7// アサーション失敗時に `AssertionError` をスローするように設定します。
8ini_set('assert.exception', 1);
9
10/**
11 * ファイルの内容を読み込み、その結果に対してアサーションを行う関数です。
12 * アサーションが失敗した場合、`AssertionError` を捕捉し、
13 * エラーが発生したファイル名 (`$error->file` プロパティ) を出力します。
14 *
15 * @param string $filePath 読み込むファイルのパス
16 * @param string $expectedContent 比較対象として期待されるファイルの内容
17 */
18function processFileWithAssertion(string $filePath, string $expectedContent): void
19{
20    echo "--- ファイル処理開始 ---\n";
21    echo "対象ファイル: " . $filePath . "\n";
22
23    try {
24        // `file_get_contents` でファイルの内容を読み込みます。
25        // ファイルが存在しない、または読み込めない場合は `false` を返します。
26        // `@` 演算子でファイル読み込み失敗時のPHPの警告を抑制し、
27        // アサーションでエラーをハンドリングします。
28        $content = @file_get_contents($filePath);
29
30        if ($content === false) {
31            echo "警告: ファイル '{$filePath}' の読み込みに失敗しました。\n";
32            // 意図的にアサーションを失敗させ、AssertionErrorを発生させます。
33            assert(false, "ファイル '{$filePath}' の読み込みができませんでした。");
34        } else {
35            echo "ファイル内容を読み込みました (最初の20文字): " . substr($content, 0, 20) . "...\n";
36            // 読み込んだ内容が期待値と異なることを意図的にアサーションで検証し、失敗させます。
37            // これにより、`AssertionError` がスローされます。
38            assert($content === $expectedContent, "ファイル内容が期待値と異なります。");
39        }
40    } catch (AssertionError $error) {
41        // `AssertionError` が発生した場合、ここで捕捉します。
42        echo "\n!!! AssertionError が発生しました !!!\n";
43        echo "エラーメッセージ: " . $error->getMessage() . "\n";
44
45        // `AssertionError` の `file` プロパティを使って、
46        // アサーションが失敗したコード行を含むファイル名を取得します。
47        // この場合、このスクリプト自身のファイル名が表示されます。
48        echo "エラー発生ファイル (AssertionError->file): " . $error->file . "\n";
49        echo "（このファイル名は、`assert()` 関数が失敗したコードが書かれているスクリプトファイルです）\n";
50    } catch (Throwable $e) {
51        // その他の予期せぬエラーも捕捉します。
52        echo "\n!!! 予期せぬエラーが発生しました !!!\n";
53        echo "エラータイプ: " . get_class($e) . "\n";
54        echo "エラーメッセージ: " . $e->getMessage() . "\n";
55        echo "エラー発生ファイル: " . $e->getFile() . "\n";
56    }
57
58    echo "--- ファイル処理終了 ---\n\n";
59}
60
61// --- サンプル実行 ---
62
63// ケース1: 存在しないファイルを指定し、`file_get_contents` の失敗によってアサーションがトリガーされる例
64echo "--- ケース1: 存在しないファイルを読み込もうとする ---\n";
65$nonExistentFile = 'non_existent_file.txt';
66processFileWithAssertion($nonExistentFile, 'この内容は読み込まれません。');
67
68// ケース2: 存在するファイルを指定するが、内容が期待値と異なることでアサーションが失敗する例
69echo "--- ケース2: 存在するファイルを読み込むが、アサーションが失敗する ---\n";
70$testFile = 'temp_test_file.txt';
71// テストファイルを作成し、内容を書き込みます
72file_put_contents($testFile, 'Hello, PHP 8!');
73
74// `processFileWithAssertion` 関数を呼び出し、期待値とは異なる内容を指定してアサーションを失敗させます
75processFileWithAssertion($testFile, 'これは間違った内容です。');
76
77// 作成したテストファイルを削除します
78unlink($testFile);
79
80?>

PHP 8のAssertionErrorクラスは、assert()関数を用いたアサーション（特定の条件が真であることを確認する処理）が失敗した際に発生するエラーです。このAssertionErrorオブジェクトが持つfileプロパティは、アサーションが失敗したコードが記述されているスクリプトのファイル名を文字列（string）で返します。このプロパティには引数は必要ありません。

サンプルコードでは、file_get_contents関数でファイルを読み込む処理に対してアサーションを行い、その結果を検証しています。ファイルが見つからない、または内容が期待値と異なる場合にassert()関数を失敗させ、意図的にAssertionErrorを発生させています。try...catchブロックでこのAssertionErrorを捕捉し、$error->fileプロパティを利用してエラーが発生したファイル名を出力しています。

このfileプロパティが示すのは、エラーを引き起こしたassert()文が記述されているスクリプトファイルの名前です。例えば、現在のスクリプト内でアサーションが失敗した場合、このプロパティはそのスクリプト自身のファイル名を返します。このように、AssertionErrorのfileプロパティは、プログラムが想定外の動作をした際に、問題が発生した具体的なコードの場所を特定するために非常に役立ちます。

Copy
1<?php
2
3// アサーションの設定: アサーション失敗時に `AssertionError` をスローするようにします。
4// PHP 8 では `assert.exception` のデフォルトが `1` ですが、明示的に設定することで意図を明確にします。
5ini_set('assert.exception', '1');
6
7/**
8 * アサーションエラーを捕捉し、その詳細をログファイルに記録するデモンストレーション関数。
9 *
10 * この関数は、`AssertionError` が発生した際に、エラーが発生したファイルパス (`$e->getFile()`) を含め、
11 * ログファイルに情報を書き込む方法を初心者向けに示します。
12 * `file_put_contents` 関数を使用してファイルへの書き込みを行います。
13 *
14 * @param string $logFilePath ログ情報を記録するファイルの完全パス。
15 * @return void
16 */
17function logAssertionError(string $logFilePath): void
18{
19    try {
20        // ここで意図的にアサーションを失敗させます。
21        // `assert()` は、第一引数の条件が `false` の場合、`AssertionError` をスローします。
22        assert(1 === 2, "意図的に失敗させたアサーション: 1は2と等しくありません。");
23
24    } catch (AssertionError $e) {
25        // `AssertionError` をキャッチした場合の処理です。
26        // `$e->getFile()` は、このエラーがスローされたPHPスクリプトのパスを文字列として返します。
27        $errorDetails = sprintf(
28            "[%s] AssertionError detected:\n" .
29            "  Message: %s\n" .
30            "  File: %s\n" . // エラーが発生したPHPスクリプトのファイルパス
31            "  Line: %d\n" .
32            "  Trace: %s\n\n",
33            date('Y-m-d H:i:s'),
34            $e->getMessage(),
35            $e->getFile(), // ここで `AssertionError` の `file` プロパティが使用されます。
36            $e->getLine(),
37            $e->getTraceAsString()
38        );
39
40        // ログファイルにエラー情報を追記します。
41        // `FILE_APPEND` フラグで既存のファイルに追記し、`LOCK_EX` で排他ロックをかけます。
42        if (file_put_contents($logFilePath, $errorDetails, FILE_APPEND | LOCK_EX) === false) {
43            // ログファイルへの書き込み自体が失敗した場合の処理です。
44            // 通常はPHPのエラーログに記録します。
45            error_log("Failed to write assertion error log to: " . $logFilePath);
46            echo "エラーログの書き込みに失敗しました。\n";
47        } else {
48            echo "AssertionError が発生し、ログファイル " . basename($logFilePath) . " に記録されました。\n";
49        }
50
51    } catch (Throwable $e) {
52        // `AssertionError` 以外の予期せぬエラー（`Exception` など）をキャッチした場合の処理です。
53        $errorDetails = sprintf(
54            "[%s] Unexpected Error detected:\n" .
55            "  Class: %s\n" .
56            "  Message: %s\n" .
57            "  File: %s\n" .
58            "  Line: %d\n" .
59            "  Trace: %s\n\n",
60            date('Y-m-d H:i:s'),
61            get_class($e),
62            $e->getMessage(),
63            $e->getFile(),
64            $e->getLine(),
65            $e->getTraceAsString()
66        );
67
68        if (file_put_contents($logFilePath, $errorDetails, FILE_APPEND | LOCK_EX) === false) {
69            error_log("Failed to write unexpected error log to: " . $logFilePath);
70            echo "予期せぬエラーログの書き込みに失敗しました。\n";
71        } else {
72            echo "予期せぬエラーが発生し、ログファイル " . basename($logFilePath) . " に記録されました。\n";
73        }
74    }
75}
76
77// スクリプトが実行されているディレクトリにログファイルを作成するためのパスを定義します。
78$logFileFullPath = __DIR__ . DIRECTORY_SEPARATOR . 'assertion_errors.log';
79
80// 定義した関数を実行し、アサーションエラーのログ記録をデモンストレーションします。
81logAssertionError($logFileFullPath);
82
83?>

このPHPコードは、プログラムの動作検証（アサーション）が失敗した際に発生するAssertionErrorを捕捉し、その詳細をログファイルに記録する仕組みをデモンストレーションしています。

最初にini_set('assert.exception', '1');を設定することで、assert()関数の条件が偽になった場合にAssertionErrorがスローされるようになります。これは、プログラムの前提条件が満たされない状況をエラーとして明確にするための重要な設定です。

logAssertionError関数内では、try-catchブロックを使用してエラーを適切に処理します。assert(1 === 2, ...)の部分で意図的にアサーションを失敗させ、AssertionErrorを発生させています。

catch (AssertionError $e)でエラーが捕捉されると、エラーオブジェクト$eからさまざまな情報を取得できます。ここで重要なのが$e->getFile()です。これは引数を必要とせず、AssertionErrorがスローされたPHPスクリプトの完全なファイルパスを文字列（string）として返します。このファイルパスとエラーメッセージ、発生行番号などの詳細情報をsprintf関数で整形します。

整形されたエラー情報は、file_put_contents関数を使って、指定されたログファイル（例: assertion_errors.log）に追記されます。これにより、後からどのファイルで、どのようなアサーションエラーが発生したのかを正確に確認できるため、システムのトラブルシューティングに役立てることが可能です。