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

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

作成日: 2025年09月11日更新日: 2025年10月27日

基本的な使い方

getCodeメソッドは、DOMExceptionが発生した際のエラーコードを返します。DOMExceptionは、DOM（Document Object Model）操作中に発生する例外を表すクラスであり、様々な理由でDOM操作が失敗した場合にスローされます。getCodeメソッドは、その例外が具体的にどのようなエラーを表しているのかを数値で示します。

このメソッドは引数を取らず、整数型の値を返します。返される値は、DOMExceptionを表す特定の定数に対応しており、W3C（World Wide Web Consortium）によって定義されています。例えば、DOMException::INDEX_SIZE_ERR や DOMException::WRONG_DOCUMENT_ERR など、DOMExceptionクラスに定義された定数に対応する数値が返されます。

システムエンジニアを目指す初心者の方にとって、getCodeメソッドは、DOM操作のエラーハンドリングにおいて重要な役割を果たします。例外が発生した場合、getCodeメソッドを使用して具体的なエラーコードを取得し、それに基づいて適切なエラー処理を行うことができます。例えば、エラーコードに応じて異なるエラーメッセージを表示したり、特定の処理をスキップしたりすることが可能です。getCodeメソッドを利用することで、より堅牢で信頼性の高いDOM操作を行うアプリケーションを開発することができます。具体的なエラー内容を把握することで、デバッグ作業も効率的に行うことが可能になります。

構文(syntax)


1public DOMException::getCode(): int

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

DOMExceptionオブジェクトに関連付けられたエラーコードを整数値で返します。

サンプルコード

PHP DOMException getCode でエラーコードを取得する


1<?php
2
3// DOMException クラスの getCode メソッドのサンプルコード
4
5try {
6  // DOMDocument を作成して、不正な XML をロードしようとする
7  $dom = new DOMDocument();
8  $dom->loadXML('<invalid-xml>'); // わざと不正な XML を渡す
9
10} catch (DOMException $e) {
11  // DOMException が発生した場合、getCode() メソッドを使用してエラーコードを取得する
12  $errorCode = $e->getCode();
13
14  // エラーコードを出力する
15  echo "DOMException が発生しました。エラーコード: " . $errorCode . PHP_EOL;
16}
17
18?>

PHPのDOMExceptionクラスにおけるgetCodeメソッドは、発生したDOM関連のエラーコードを整数値として取得するために使用します。このメソッドは引数を取らず、エラーの種類を特定するために役立つ整数値を返します。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、意図的に不正なXMLをloadXMLメソッドで読み込ませています。これにより、DOMExceptionが発生するように仕組んでいます。

try-catchブロックを使用し、DOMExceptionが発生した場合にそれを捕捉します。捕捉した例外オブジェクト $e に対して getCode() メソッドを呼び出すことで、エラーコードを取得できます。

取得したエラーコードは $errorCode 変数に格納され、その後 echo 文で出力されます。これにより、発生したDOM関連のエラーの種類を数値として確認できます。

この例では、不正なXMLを読み込ませることでDOMExceptionを発生させていますが、getCode()メソッドは、XMLの構文エラー、要素の不整合など、DOM処理中に発生する様々なエラーに対応したエラーコードを返します。errorCodeを調べることで、デバッグやエラーハンドリングに役立てることができます。getCode()を使うことで、より詳細なエラー処理を実装することが可能になります。

DOMExceptionのgetCode()メソッドは、発生したDOM関連のエラーの種類を示す整数値を返します。サンプルコードでは、意図的に不正なXMLを読み込ませ、DOMExceptionを発生させています。try-catchブロックを使用し、例外発生時のエラーハンドリングを行っています。getCode()で取得できるエラーコードは、DOM定数（例: DOM_HIERARCHY_REQUEST_ERR）に対応しているとは限りません。getCode()の値は、PHPのバージョンや設定によって異なる可能性があるため、具体的な値に依存した処理は避けるべきです。エラーメッセージ（$e->getMessage()）と組み合わせて、エラー内容を詳細に把握するように心がけてください。