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

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

作成日: 更新日:

基本的な使い方

『getCodeメソッドは、DOM操作で発生した例外のエラーコードを取得するために実行するメソッドです』

このメソッドは、PHPの基本的な例外処理クラスであるExceptionクラスから継承されたものです。プログラムがXMLやHTMLドキュメントを操作している最中に何らかの問題が発生すると、dom\domexceptionオブジェクトが生成されてスロー(送出)されます。この例外オブジェクトには、エラーの内容を示すメッセージだけでなく、エラーの種類を識別するための整数値である「例外コード」も保持されています。getCodeメソッドの役割は、この保持されている例外コードを返すことです。

通常、このメソッドはtry...catchブロックの中で使用されます。catchブロックでdom\domexceptionオブジェクトを捕捉した際に、getCodeメソッドを呼び出すことで、どのような種類のエラーが発生したのかを数値で具体的に特定できます。例えば、DOM仕様で定義されているDOM_INDEX_SIZE_ERRDOM_NOT_FOUND_ERRといった定数と比較することで、エラーに応じた適切な処理を分岐させることが可能となり、より信頼性の高いエラーハンドリングを実装するのに役立ちます。

構文(syntax)

1<?php
2try {
3    $doc = new DOMDocument();
4    // 階層が正しくないため、DOMExceptionが発生します
5    $doc->appendChild(new DOMText('Error'));
6} catch (DOMException $e) {
7    // 例外オブジェクトからエラーコードを取得します
8    $errorCode = $e->getCode();
9    echo $errorCode;
10}
11?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

DOMExceptionオブジェクトで発生したエラーコードを整数で返します。

【PHP8.x】getCodeメソッドの使い方 | いっしー@Webエンジニア