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

getCodeメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

『getCodeメソッドは、スローされたLengthExceptionオブジェクトに設定されている例外コードを取得するメソッドです。LengthExceptionは、PHPにおける例外クラスの一つで、主に文字列や配列などの長さが不正である場合に発生するエラーを示します。このgetCodeメソッドは、LengthExceptionクラスが直接定義しているものではなく、全ての例外クラスの基底となるExceptionクラスから継承しています。例外コードとは、例外が発生した際に、そのエラーの種類をプログラム的に識別するために開発者が任意で設定できる数値のことです。例えば、try...catch構文でLengthExceptionを捕捉した際に、このメソッドを使って例外コードを取得し、その値に応じてエラーメッセージを変えたり、特定の回復処理を行ったりするなど、より詳細なエラーハンドリングを実装できます。戻り値は整数(int)型であり、例外をスローする際にコードが指定されなかった場合は、デフォルトで0が返されます。

構文(syntax)

1<?php
2
3try {
4    $password = "short";
5
6    if (strlen($password) < 8) {
7        // 文字数が足りない場合、例外コード `1001` を指定してLengthExceptionをスローします。
8        throw new LengthException("パスワードが短すぎます。", 1001);
9    }
10} catch (LengthException $e) {
11    // 捕捉した例外オブジェクトから、指定された例外コードを取得して出力します。
12    // 出力: 1001
13    echo $e->getCode();
14}

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

LengthExceptionクラスのgetCodeメソッドは、例外が発生した際に割り当てられている整数コードを返します。

関連コンテンツ

関連プログラミング言語