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

Copy
1<?php
2
3/**
4 * ゼロ除算を意図的に発生させる関数。
5 *
6 * PHP 8 以降では、整数のゼロ除算は DivisionByZeroError をスローします。
7 * 浮動小数点数のゼロ除算は Inf, -Inf, NaN を返します。
8 * この例では整数を使用しているため、エラーが発生します。
9 *
10 * @param int $numerator   分子
11 * @param int $denominator 分母
12 * @return float 割り算の結果
13 * @throws DivisionByZeroError 分母が0の場合
14 */
15function performDivision(int $numerator, int $denominator): float
16{
17    return $numerator / $denominator;
18}
19
20try {
21    echo "ゼロ除算を試行します。\n";
22    // ここで DivisionByZeroError が発生します
23    performDivision(10, 0);
24    echo "この行はエラー発生後なので実行されません。\n";
25} catch (DivisionByZeroError $e) {
26    echo "--- DivisionByZeroError が捕捉されました ---\n";
27    echo "エラーメッセージ: " . $e->getMessage() . "\n";
28    // DivisionByZeroError::file プロパティ（getFile()メソッド）で、
29    // エラーが発生したファイルのパスを取得します。
30    echo "発生ファイル: " . $e->getFile() . "\n";
31    echo "発生行: " . $e->getLine() . "\n";
32
33    // キーワード: file_get_contents
34    // エラーが発生したファイルの内容を読み込みます。
35    // デバッグ目的で、エラー発生箇所のコードを確認する際などに利用できます。
36    $filePath = $e->getFile();
37    if (file_exists($filePath) && is_readable($filePath)) {
38        echo "\n--- エラー発生元のファイル内容 (最初の200文字) ---\n";
39        $fileContent = file_get_contents($filePath);
40        // ファイルの内容が長い場合に備え、一部のみ表示
41        echo mb_substr($fileContent, 0, 200, 'UTF-8') . "...\n";
42        echo "----------------------------------------\n";
43    } else {
44        echo "\nエラー発生元のファイルを読み込めませんでした。\n";
45    }
46} catch (Throwable $e) {
47    // DivisionByZeroError 以外の予期せぬエラーを捕捉します
48    echo "--- 予期せぬエラーが捕捉されました ---\n";
49    echo "エラータイプ: " . get_class($e) . "\n";
50    echo "エラーメッセージ: " . $e->getMessage() . "\n";
51}

PHP 8では、整数に対するゼロ除算を行うとDivisionByZeroErrorというエラーが発生し、プログラムの実行が停止してしまいます。このエラーは、try-catch文を使用することで捕捉し、適切に処理することができます。

DivisionByZeroErrorクラスにはfileプロパティ（またはそれに対応するgetFile()メソッド）が用意されており、これはエラーが実際に発生したソースコードファイルの絶対パスを文字列として返します。このプロパティは引数を取らず、戻り値は常にstring型です。システム開発において、エラー発生時にどのファイルが原因であるかを正確に把握することは、デバッグ作業において非常に重要な情報となります。

提供されたサンプルコードでは、performDivision関数で意図的にゼロ除算を発生させ、DivisionByZeroErrorを捕捉しています。catchブロック内では、$e->getFile()メソッドを使ってエラー発生元のファイルパスを取得し、それを画面に表示しています。さらに、取得したファイルパスを利用してfile_get_contents関数を呼び出し、エラーが発生したファイルのコード内容を読み込んで一部を表示する例も示しています。これにより、エラーメッセージだけでは分かりにくい場合でも、問題発生箇所の実際のコードを直接確認できるため、開発者はエラーの原因を素早く特定し、修正作業を効率的に進めることができます。

Copy
1<?php declare(strict_types=1);
2
3/**
4 * 0による除算エラーを意図的に発生させ、その情報をログに記録する関数。
5 *
6 * DivisionByZeroError がスローされた際に、エラーが発生したファイル名（fileプロパティ）と
7 * エラーメッセージをログファイルに記録する例を示します。
8 *
9 * @param int $numerator 割られる数
10 * @param int $denominator 割る数
11 * @param string $logFilePath エラー情報を書き込むログファイルのパス
12 * @return void
13 */
14function demonstrateDivisionByZeroErrorLogging(int $numerator, int $denominator, string $logFilePath): void
15{
16    try {
17        // 0で除算を試みることで DivisionByZeroError を意図的に発生させます。
18        // PHP 8では、0による除算は DivisionByZeroError をスローします。
19        $result = $numerator / $denominator;
20        echo "計算結果: " . $result . PHP_EOL;
21    } catch (DivisionByZeroError $e) {
22        // DivisionByZeroError が捕捉された場合の処理です。
23        $errorMessage = "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
24        
25        // DivisionByZeroError の file プロパティは、エラーが発生したソースコードのファイル名を返します。
26        $errorFile = "エラー発生ファイル: " . $e->getFile() . PHP_EOL;
27
28        // エラー情報（メッセージと発生ファイル名）をログファイルに追記します。
29        // FILE_APPEND フラグにより、既存のファイル内容を消さずに追記します。
30        file_put_contents($logFilePath, $errorMessage . $errorFile, FILE_APPEND);
31
32        echo "0による除算エラーが発生し、詳細情報がログファイル '{$logFilePath}' に記録されました。" . PHP_EOL;
33    }
34}
35
36// ログファイルのパスを定義します。このスクリプトと同じディレクトリに生成されます。
37$logFile = __DIR__ . '/division_error.log';
38
39// 前回の実行で作成されたログファイルが存在すれば削除し、クリーンな状態にします。
40if (file_exists($logFile)) {
41    unlink($logFile);
42}
43
44echo "--- 0による除算エラーのログ記録デモンストレーション ---" . PHP_EOL;
45
46// 例1: 正常な除算の実行（エラーは発生しません）
47echo "例1: 正常な除算 (10 / 2)" . PHP_EOL;
48demonstrateDivisionByZeroErrorLogging(10, 2, $logFile);
49echo PHP_EOL;
50
51// 例2: 0による除算の実行（DivisionByZeroError が発生し、ログに記録されます）
52echo "例2: 0による除算 (10 / 0)" . PHP_EOL;
53demonstrateDivisionByZeroErrorLogging(10, 0, $logFile);
54echo PHP_EOL;
55
56echo "デモンストレーション完了。" . PHP_EOL;
57echo "ログファイル '{$logFile}' を確認してください。" . PHP_EOL;

このPHPコードは、0による除算が発生した際にスローされるDivisionByZeroErrorを捕捉し、そのエラー情報をログファイルに記録する手順を示しています。

demonstrateDivisionByZeroErrorLogging関数では、try-catchブロックを使用して、意図的に0で除算を試みています。PHP 8以降では、0による除算はDivisionByZeroErrorという例外をスローするため、catchブロックでこのエラーを捕捉できます。エラーが捕捉されると、$e->getFile()のようにエラーオブジェクトのfileプロパティにアクセスすることで、エラーが発生したPHPスクリプトのファイル名（string型）を取得できます。これにより、どのファイルで問題が起きたのかを正確に特定するのに役立ちます。

さらに、取得したエラーメッセージやファイル名をfile_put_contents関数を使ってログファイルに書き込んでいます。この関数は、第1引数で指定されたファイルパス（string）に、第2引数で与えられた内容（string）を書き込みます。第3引数にFILE_APPENDフラグを指定することで、既存のファイル内容を消さずに末尾に追記することが可能です。この一連の処理により、プログラム実行中に発生した予期せぬエラーの詳細を記録し、開発者が迅速に問題箇所を特定し対処するための基本的なログ記録手法を学ぶことができます。