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

Copy
1<?php
2
3/**
4 * AssertionError の getCode() メソッドのサンプルコード。
5 *
6 * assert() 関数が失敗した際にスローされる AssertionError から、
7 * 設定されたエラーコードを取得する方法を示します。
8 * PHP 8以降では、assert.exception ディレクティブがデフォルトで1に設定されており、
9 * アサーションが失敗すると AssertionError がスローされます。
10 */
11function demonstrateAssertionErrorCode(): void
12{
13    try {
14        // 意図的に失敗するアサーションを作成し、第3引数でカスタムエラーコード (12345) を指定します。
15        assert(false, 'カスタムアサーションメッセージ: この処理は条件を満たしませんでした。', 12345);
16
17        // 上のアサーションが失敗するため、この行は実行されません。
18        echo "この行は実行されません。\n";
19
20    } catch (AssertionError $e) {
21        // AssertionError が捕捉された場合に実行されます。
22        echo "AssertionError が捕捉されました。\n";
23        echo "エラーメッセージ: " . $e->getMessage() . "\n";
24        echo "取得されたエラーコード (getCode()): " . $e->getCode() . "\n"; // getCode() を呼び出してコードを取得
25    } catch (Throwable $e) {
26        // その他の予期せぬエラー（AssertionError以外のThrowable）を捕捉する場合。
27        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
28    }
29}
30
31// サンプル関数を実行します。
32demonstrateAssertionErrorCode();
33
34?>

AssertionError::getCode()メソッドは、PHPのassert()関数が失敗した際にスローされるAssertionErrorから、そのエラーコードを取得するために利用されます。

PHPのassert()関数は、プログラムの特定の条件が真であることを検証するために使用されます。この条件が偽だった場合、つまりアサーションが失敗した場合、PHP 8以降ではデフォルトでAssertionErrorという例外がスローされる動作になっています。

このgetCode()メソッドは引数を一切取りません。呼び出すと、スローされたAssertionErrorオブジェクトに設定されているエラーコードを整数値（int）として返します。サンプルコードでは、assert(false, '...', 12345)のように、assert()関数の第3引数でエラーコードとして12345を明示的に指定しています。アサーションが失敗してAssertionErrorが捕捉された際に、$e->getCode()を呼び出すことで、この指定した12345というカスタムエラーコードが取得されていることが確認できます。

これにより、アサーションの失敗原因を数値で識別し、状況に応じた詳細なエラーハンドリングを行うことが可能になります。プログラムの信頼性を高め、エラー発生時の原因特定を容易にする上で役立つ機能です。

Copy
1<?php
2
3/**
4 * PHPのAssertionError::getCode()メソッドの使用例を示します。
5 *
6 * この関数は、意図的にAssertionErrorを発生させ、
7 * そのエラーコードを取得する方法を実演します。
8 */
9function demonstrateAssertionErrorCode(): void
10{
11    // アサーションが有効になり、失敗時にAssertionErrorをスローするように設定します。
12    // この設定がないと、assert()が失敗してもAssertionErrorは発生しません。
13    ini_set('zend.assertions', '1');
14    ini_set('assert.exception', '1');
15
16    echo "AssertionErrorを発生させようとしています...\n";
17
18    try {
19        // このアサーションは失敗するため、AssertionErrorをスローします。
20        assert(1 === 2, "1と2は等しくありません");
21    } catch (AssertionError $e) {
22        // AssertionErrorを捕捉します。
23        echo "AssertionErrorが捕捉されました！\n";
24        echo "エラーメッセージ: " . $e->getMessage() . "\n";
25        // getCode()メソッドを呼び出し、エラーコード（整数）を取得します。
26        echo "エラーコード: " . $e->getCode() . "\n";
27    } catch (Throwable $e) {
28        // 予期しないその他のエラーを捕捉します。
29        echo "予期せぬエラーが捕捉されました: " . $e->getMessage() . "\n";
30    }
31
32    echo "デモンストレーションが完了しました。\n";
33
34    // デモ目的のため、設定を元に戻す必要はありませんが、
35    // 実際のアプリケーションでは、必要に応じてini_restore()を検討してください。
36}
37
38// 関数を実行してデモンストレーションを開始します。
39demonstrateAssertionErrorCode();

PHP 8のAssertionErrorクラスに属するgetCode()メソッドは、プログラムのアサーション（仮定）が失敗してAssertionErrorが発生した際に、そのエラーの詳細な情報を数値コードとして取得するために利用されます。

このサンプルコードでは、まずini_set関数を使ってPHPのアサーション機能を有効化し、アサーションの失敗時にAssertionErrorが投げられるように設定しています。これにより、assert(1 === 2)という意図的に失敗するアサーションが実行されると、AssertionErrorがスローされます。

発生したAssertionErrorはtry-catchブロックで適切に捕捉されます。捕捉されたエラーオブジェクト $e から $e->getCode() を呼び出すことで、このアサーションエラーに紐づく整数値のエラーコードを取得できます。getCode()メソッドは引数を一切取らず、常にint型の数値を戻り値として返します。このエラーコードは、エラーの種類を識別したり、エラーハンドリングのロジックで特定のケースに対応したりする際に活用でき、システムの安定性向上に貢献します。

Copy
1<?php
2
3/**
4 * AssertionErrorの発生とgetCode()メソッドの利用例を示す関数。
5 *
6 * この関数は、PHPのアサーション機能を使って意図的にAssertionErrorを発生させ、
7 * そのエラーを捕捉してgetCode()メソッドでエラーコードを取得する方法を示します。
8 * システムエンジニアを目指す初心者の方が、例外処理とエラーコードの取得方法を
9 * 理解するのに役立ちます。
10 */
11function demonstrateAssertionErrorGetCode(): void
12{
13    // アサーションが失敗した際にAssertionErrorをスローするように設定します。
14    // PHP 8では 'assert.exception' ディレクティブがデフォルトで有効なことが多いですが、
15    // 明示的に設定することで意図が明確になり、動作の確実性が増します。
16    assert_options(ASSERT_ACTIVE, 1);    // アサーションを有効にします。
17    assert_options(ASSERT_WARNING, 0);   // 警告を無効にします (AssertionErrorをスローするため)。
18    assert_options(ASSERT_EXCEPTION, 1); // アサーション失敗時にAssertionErrorをスローします。
19
20    try {
21        echo "アサーションを実行します...\n";
22
23        // 意図的にfalseとなるアサーションを実行します。
24        // 第2引数にAssertionErrorオブジェクトを直接渡し、カスタムエラーコード (1001) を設定します。
25        $expectedValue = 10;
26        $actualValue = 5;
27        assert(
28            $actualValue === $expectedValue,
29            new AssertionError('値が期待する値 (' . $expectedValue . ') と異なります。', 1001)
30        );
31
32        // 上記のアサーションは失敗するため、この行は実行されません。
33        echo "アサーションは成功しました。\n";
34
35    } catch (AssertionError $e) {
36        // AssertionErrorが発生した場合、このcatchブロックで捕捉されます。
37        echo "AssertionErrorが発生しました！\n";
38        echo "メッセージ: " . $e->getMessage() . "\n";
39        // getCode()メソッドを呼び出して、AssertionErrorに設定されたエラーコードを取得します。
40        echo "エラーコード: " . $e->getCode() . "\n";
41    } catch (Throwable $e) {
42        // AssertionError以外の予期せぬエラーが発生した場合に捕捉します。
43        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
44        echo "エラーコード: " . $e->getCode() . "\n";
45    }
46}
47
48// 上記で定義した関数を実行します。
49demonstrateAssertionErrorGetCode();

このサンプルコードは、PHPのアサーション機能を使って意図的にAssertionErrorを発生させ、そのエラーを捕捉した際にgetCode()メソッドを利用してエラーコードを取得する方法を示しています。AssertionErrorは、PHPのアサーション（プログラムの特定の状態が真であると仮定する機能）が失敗し、例外としてスローされるように設定されている場合に発生するエラークラスです。

コードではまず、assert_options()関数でアサーションが失敗した際にAssertionErrorをスローするよう設定しています。次にtry-catchブロック内で、assert()関数を使って意図的に失敗する条件を記述しています。このとき、assert()関数の第2引数にnew AssertionError()のインスタンスを渡し、メッセージと共にカスタムのエラーコード（例: 1001）を設定しています。

アサーションが失敗すると、catch (AssertionError $e)ブロックでエラーが捕捉されます。このブロック内で$e->getCode()を呼び出すことにより、AssertionError発生時に設定したエラーコード（この例では1001）をint型で取得できます。getCode()メソッドは引数を取りません。これにより、システムエンジニアは発生したエラーを数値で識別し、エラーの種類に応じた適切な処理やログ記録を行うことが可能になります。