【PHP8.x】getCodeメソッドの使い方

Copy
1<?php
2
3/**
4 * 2つの数値を割り算する関数。
5 * 除数が0の場合、ArithmeticErrorがスローされます。
6 *
7 * @param int $numerator 割られる数
8 * @param int $denominator 割る数
9 * @return float|int 割り算の結果
10 */
11function safeDivide(int $numerator, int $denominator): float|int
12{
13    // PHP 8では、0による除算はArithmeticErrorを発生させます。
14    // この関数は、その振る舞いを直接示します。
15    return $numerator / $denominator;
16}
17
18// ArithmeticErrorの発生とgetCode()メソッドの使用例
19try {
20    // 意図的に0による除算を行い、ArithmeticErrorを発生させます。
21    $result = safeDivide(10, 0);
22    echo "結果: " . $result . PHP_EOL;
23} catch (ArithmeticError $e) {
24    // ArithmeticErrorを捕捉します。
25    echo "ArithmeticErrorが発生しました！" . PHP_EOL;
26    echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
27    
28    // getCode()メソッドを使用して、エラーコードを取得します。
29    // PHPの組み込みArithmeticErrorの場合、通常は0を返します。
30    echo "エラーコード: " . $e->getCode() . PHP_EOL;
31    
32    echo "エラー発生ファイル: " . $e->getFile() . PHP_EOL;
33    echo "エラー発生行: " . $e->getLine() . PHP_EOL;
34} catch (Throwable $e) {
35    // ArithmeticError以外の予期せぬエラーも捕捉します（念のため）。
36    echo "予期せぬエラーが発生しました: " . $e->getMessage() . PHP_EOL;
37    echo "エラーコード: " . $e->getCode() . PHP_EOL;
38}
39
40?>

このサンプルコードは、PHP 8で導入されたArithmeticErrorクラスと、そのgetCodeメソッドの使い方をシステムエンジニアを目指す初心者にも分かりやすく説明しています。ArithmeticErrorは、ゼロ除算のように、数値計算において不正な操作が行われた場合に発生するエラーを扱うための例外クラスです。

コードでは、safeDivide関数を使って2つの数値を割り算していますが、意図的に第二引数に0を渡すことで、ArithmeticErrorを発生させています。PHP 8からは、このようなゼロによる除算が自動的にArithmeticErrorとして処理されるようになりました。

この発生したエラーは、try-catchブロックを用いて捕捉されます。catch (ArithmeticError $e)ブロック内では、捕捉したArithmeticErrorオブジェクト$eから、getMessage()メソッドでエラーの詳細な説明を取得できるほか、本サンプルコードの目的であるgetCode()メソッドを呼び出すことで、エラーに関連付けられた数値コードを取得しています。getCode()メソッドは引数を必要とせず、常に整数型（int）の値を返します。PHPの組み込みのArithmeticErrorでは、通常は0が返されることが一般的です。これにより、プログラムの安定性を高めるためのエラーハンドリングの基本を学ぶことができます。

Copy
1<?php
2
3/**
4 * ArithmeticError::getCode() メソッドの使用例を示します。
5 *
6 * この関数は、数値計算に関連するエラー（ArithmeticError）を意図的に発生させ、
7 * そのエラーを捕捉し、getCode() メソッドを使ってエラーコードを取得する方法を示します。
8 */
9function demonstrateArithmeticErrorGetCode(): void
10{
11    echo "ArithmeticError::getCode() のデモンストレーションを開始します。\n";
12
13    try {
14        echo "0で除算を試みます。これは ArithmeticError の一種である DivisionByZeroError を発生させます。\n";
15        // 0除算は DivisionByZeroError を発生させる。
16        // DivisionByZeroError は ArithmeticError を継承しています。
17        $numerator = 10;
18        $denominator = 0;
19        $result = $numerator / $denominator;
20        echo "結果: " . $result . "\n"; // この行は実行されません
21    } catch (ArithmeticError $e) {
22        // ArithmeticError またはその子クラスの例外を捕捉します。
23        echo "ArithmeticError を捕捉しました！\n";
24        echo "エラーメッセージ: " . $e->getMessage() . "\n";
25        // getCode() メソッドを使用して、エラーに関連付けられたコードを取得します。
26        // PHPの組み込み ArithmeticError 系では通常 '0' が返されます。
27        echo "エラーコード: " . $e->getCode() . "\n";
28        echo "発生ファイル: " . $e->getFile() . "\n";
29        echo "発生行: " . $e->getLine() . "\n";
30    } catch (Throwable $e) {
31        // 上記以外の予期せぬエラーを捕捉する汎用的なブロックです。
32        echo "予期せぬエラーを捕捉しました: " . $e->getMessage() . "\n";
33    }
34
35    echo "デモンストレーションが終了しました。\n";
36}
37
38// 関数を実行します。
39demonstrateArithmeticErrorGetCode();
40

PHPのArithmeticError::getCode()メソッドは、数値計算に関連するエラーが発生した際に、そのエラーを示すコードを取得するために使用されます。このメソッドは、ArithmeticErrorクラス、またはそれを継承するDivisionByZeroErrorのような特定のエラーオブジェクトから呼び出されます。引数を必要とせず、エラーコードを示す整数型（int）の値を戻り値として返します。

サンプルコードでは、意図的に0での除算を試みることで、ArithmeticErrorの子クラスであるDivisionByZeroErrorを発生させています。try-catchブロックを使用し、catch (ArithmeticError $e)でこのエラーを捕捉した後、$e->getCode()を呼び出してエラーコードを取得しています。PHPの組み込みArithmeticError系では、通常「0」がエラーコードとして返されることが一般的です。

このメソッドを使うことで、プログラムは発生した数値計算エラーの種類を判別し、それぞれに応じたエラー処理を行うことが可能になります。エラーメッセージと合わせて利用することで、問題の原因特定やユーザーへの適切なフィードバックに役立ちます。