PHPのAssertionErrorとは？assert()によるアサーション失敗時のエラー処理を解説

はじめに

AssertionError クラスは、Error クラスのサブクラスです。このエラーは、assert() が FALSE を返した場合、つまりアサーション（表明）が失敗したときにスローされます。

assert() は与えられたアサーションが真か偽かをチェックし、偽であった場合に AssertionError をスローします。assert() 関数は以下のように定義されています。

構文

PHP 5 および PHP 7
assert ( mixed $assertion [, string $description ] ) : bool

PHP 7 のみ
assert ( mixed $assertion [, Throwable $exception ] ) : bool

パラメータ

PHP 7.0 以降、assert() は関数ではなく言語構造となりました。これにより、assertion パラメータには式を直接指定でき、第2引数には例外オブジェクトまたは説明文を渡せるようになっています。なお、PHP 7.2 以降では文字列による description の指定は非推奨となり、E_DEPRECATED 警告が発生する点に注意してください。

また、assert() によってスローされた AssertionError は、php.ini で assert.exception=on が有効になっている場合にのみ catch ブロックへ送られます。

AssertionError の使用例

次の例では、条件が真であることを assert() で検証しています。条件が真の場合は try ブロックが正常に実行され、偽の場合は catch ブロックから AssertionError のメッセージが表示されます。

コード例

<?php
$a = 10;
$b = 20;
try {
    if (assert($a == $b, "assert($a == $b) failed.")) {
        echo("assert($a == $b) was successful.");
    }
} catch (AssertionError $e) {
    echo $e->getMessage();
}
?>

実行結果

上記のコードを実行すると、以下のような結果が出力されます。

assert(10 == 20) failed.

この例では $a と $b の値が異なるため、アサーションが失敗し、catch ブロック内で設定したエラーメッセージが出力されています。開発段階での前提条件の検証やデバッグに assert() を活用することで、想定外の状態を早期に検出できます。