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

Copy
1<?php
2
3/**
4 * PHP 8 の AssertionError クラスの 'code' プロパティの使用例を示します。
5 * このサンプルは、CodeIgniterのようなフレームワークアプリケーションの文脈で、
6 * データ検証や内部ロジックの健全性チェックに assert() 関数が使用され、
7 * それが失敗した場合の AssertionError の捕捉方法と、そのエラーコードの取得方法をデモンストレーションします。
8 *
9 * 注: assert() が AssertionError をスローするためには、
10 * php.ini または実行時に ini_set() で以下の設定が必要です。
11 * zend.assertions = 1
12 * assert.exception = 1
13 */
14function demonstrateAssertionErrorCode(): void
15{
16    // PHP 8 で assert() が AssertionError をスローするように設定を一時的に変更します。
17    // 実際のアプリケーションでは、通常 php.ini で設定することが推奨されます。
18    // ini_set() は、実行環境によってはセキュリティ上の理由で制限される場合があります。
19    ini_set('zend.assertions', '1');
20    ini_set('assert.exception', '1');
21
22    echo "--- AssertionError の発生とコードの取得デモンストレーション ---\n\n";
23
24    try {
25        $userAge = 17;
26        $minAllowedAge = 18;
27
28        echo "アサーションを実行します: 'ユーザーの年齢 ({$userAge}) は最低年齢 ({$minAllowedAge}) 以上であるか？'\n";
29        // 条件が偽 (false) なので、AssertionError がスローされます。
30        // assert() 関数はメッセージは受け取りますが、エラーコードを直接設定する引数はありません。
31        assert($userAge >= $minAllowedAge, "ユーザーの年齢が許可された最低年齢に達していません。");
32
33        echo "この行はアサーションが失敗した場合は実行されません。\n";
34
35    } catch (AssertionError $e) {
36        // AssertionError をキャッチし、そのコードプロパティを取得します。
37        echo "\n[成功] AssertionError をキャッチしました！\n";
38        echo "エラーメッセージ: " . $e->getMessage() . "\n";
39        echo "発生ファイル: " . $e->getFile() . " (行: " . $e->getLine() . ")\n";
40        // AssertionError の code プロパティは、assert() によってスローされた場合は通常 0 です。
41        // Exception クラスのコンストラクタで明示的に指定された場合にのみ異なる値になりますが、
42        // assert() はコードを指定しないため、デフォルト値 (0) が使用されます。
43        echo "エラーコード (codeプロパティ): " . $e->code . "\n";
44        // または、継承された getCode() メソッドを使用することもできます。
45        // echo "エラーコード (getCode()メソッド): " . $e->getCode() . "\n";
46    } catch (Exception $e) {
47        // その他の予期せぬ例外をキャッチします。
48        echo "\n[エラー] 予期せぬ Exception をキャッチしました！\n";
49        echo "エラーメッセージ: " . $e->getMessage() . "\n";
50        echo "発生ファイル: " . $e->getFile() . " (行: " . $e->getLine() . ")\n";
51        echo "エラーコード: " . $e->getCode() . "\n";
52    } finally {
53        echo "\n--- デモンストレーション終了 ---\n";
54    }
55}
56
57// 関数を実行してデモンストレーションを開始します。
58demonstrateAssertionErrorCode();

PHP 8におけるAssertionErrorクラスのcodeプロパティは、アサーションの失敗によって発生したエラーに紐づく数値コードを保持するプロパティです。このプロパティには引数がなく、戻り値は整数型（int）です。

AssertionErrorは、assert()関数が指定された条件を満たさない場合にスローされるエラーで、プログラムの前提条件が破られたことを示します。これは、CodeIgniterのようなWebアプリケーションフレームワークにおいて、入力値の検証や内部ロジックの健全性チェックに利用されることがあります。

サンプルコードでは、zend.assertions = 1およびassert.exception = 1という設定を一時的に有効にした上で、assert()関数が意図的に失敗する状況を作り出しています。これによりAssertionErrorがスローされ、try-catchブロックでこのエラーを捕捉しています。捕捉したAssertionErrorインスタンス（$e）から$e->codeとしてプロパティにアクセスすることで、エラーコードを取得できます。

ただし、assert()関数自体はエラーコードを直接指定する引数を持たないため、assert()によってスローされたAssertionErrorのcodeプロパティは通常0となります。このプロパティを通じてエラーコードを取得することで、システムは特定のエラー状況に応じて異なる処理を行うことが可能になります。

Copy
1<?php
2
3/**
4 * AssertionError の `code` プロパティの使用例を示します。
5 *
6 * この関数は、PHP の `assert()` 関数を使って意図的に `AssertionError` を発生させ、
7 * そのエラーオブジェクトから `code` プロパティの値を取得する方法を示します。
8 * PHP CodeSniffer などのツールは、一貫性のある適切なエラーハンドリングを
9 * コーディング標準の一部として推奨しており、例外処理の理解は重要です。
10 *
11 * 注意: このサンプルコードを動作させるためには、php.ini または実行時に
12 * `zend.assertions=1` および `assert.exception=1` の設定が必要です。
13 * 通常、本番環境では `zend.assertions=-1` を推奨します。
14 *
15 * @param mixed $value アサーションでチェックする値
16 * @return void
17 */
18function demonstrateAssertionErrorCode(mixed $value): void
19{
20    // アサーションを有効にし、失敗時に AssertionError をスローするよう設定します。
21    // これらは現在のスクリプト実行にのみ影響します。
22    ini_set('zend.assertions', '1');
23    ini_set('assert.exception', '1');
24
25    echo "--- 検証値: " . var_export($value, true) . " ---\n";
26
27    try {
28        // assert() 関数で条件をチェックします。
29        // 条件が偽の場合、AssertionError がスローされます（assert.exception=1 の設定時）。
30        // 第2引数でエラーメッセージを指定できます。
31        assert($value === true, '値は真である必要があります。');
32        echo "アサーションは成功しました。\n";
33    } catch (AssertionError $e) {
34        // AssertionError を捕捉し、その `code` プロパティにアクセスします。
35        // 標準の assert() 関数でスローされる AssertionError の `code` プロパティは、
36        // 通常は 0 となります。カスタムコードを設定することはできません。
37        echo "AssertionError が発生しました。\n";
38        echo "  メッセージ: " . $e->getMessage() . "\n";
39        echo "  エラーコード (codeプロパティ): " . $e->code . "\n";
40    } catch (Throwable $e) {
41        // その他の予期せぬエラーを捕捉する場合の例です。
42        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
43    }
44
45    echo "\n";
46}
47
48// ----------------------------------------------------
49// サンプルコードの実行例
50// ----------------------------------------------------
51
52// 成功するアサーションの例
53demonstrateAssertionErrorCode(true);
54
55// 失敗するアサーションの例 (値が false の場合)
56demonstrateAssertionErrorCode(false);
57
58// 失敗するアサーションの例 (値が null の場合)
59demonstrateAssertionErrorCode(null);

PHPのAssertionErrorクラスは、assert()関数で指定した条件が満たされなかった場合に発生するエラーです。このcodeプロパティは、エラーの種類を示す整数値（int）を返します。通常、assert()関数が条件失敗時にスローするAssertionErrorでは、このcodeプロパティの値は0となります。開発者がカスタムでエラーコードを設定する用途には使われません。

サンプルコードでは、assert()関数の挙動を理解するために、意図的にAssertionErrorを発生させています。assert($value === true, 'メッセージ')のように記述し、$valueがtrueでない場合にエラーがスローされます。このAssertionErrorをtry-catch構文で捕捉し、$e->codeとしてcodeプロパティの値を取得しています。

この機能を試すには、php.iniでzend.assertions=1とassert.exception=1を設定するか、スクリプト内でini_set()関数を使って有効にする必要があります。assert.exception=1を設定しない場合、assert()が失敗してもAssertionErrorはスローされません。PHP CodeSnifferのようなツールは、例外処理を含む適切なエラーハンドリングを推奨しており、エラーの種類を識別するcodeプロパティの理解は重要です。ただし、本番環境ではzend.assertions=-1を設定し、アサーション自体を無効にすることが一般的です。