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

codeプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

『codeプロパティは、スローされた例外に関する整数値のコードを保持するプロパティです。このプロパティはDomainExceptionクラスが直接定義しているものではなく、PHPの全ての例外クラスの元となるExceptionクラスから継承されています。例外がスローされる際、コンストラクタの第2引数として任意の整数値を指定することで、このcodeプロパティに値を設定できます。例外コードを指定しなかった場合、デフォルト値として0が設定されます。このプロパティの主な目的は、catchブロックで例外を捕捉した際に、エラーメッセージの文字列だけでなく、数値によってエラーの種類をプログラム的に識別することです。例えば、同じDomainExceptionであっても、codeの値が1の場合は「値が小さすぎる」、2の場合は「値が大きすぎる」といったように処理を分岐させることが可能になります。これにより、より詳細で柔軟なエラーハンドリングを実装でき、アプリケーションの堅牢性を高めるのに役立ちます。

構文(syntax)

1<?php
2
3try {
4    // 第2引数にエラーコードを指定して例外をスローします。
5    throw new DomainException("値が不正です。", 400);
6} catch (DomainException $e) {
7    // getCode()メソッドを使って、例外のコードを取得します。
8    $errorCode = $e->getCode();
9    echo $errorCode; // 400 が出力されます。
10}

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

DomainException クラスの code プロパティは、例外が発生した際の識別コードを表す整数値を返します。