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

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

作成日: 更新日:

基本的な使い方

『getCodeメソッドは、SQLite3Exceptionオブジェクトから、例外の原因となったSQLite3のエラーコードを整数値として取得するメソッドです。このメソッドは、PHPの基本的な例外クラスであるExceptionクラスから継承された標準的な機能です。SQLite3クラスのメソッドを用いてデータベースを操作する際、SQL構文のエラーやデータベースファイルへのアクセス失敗など、何らかの問題が発生するとSQLite3Exceptionがスローされます。try...catch構文を用いてこの例外を捕捉した際に、catchブロック内で例外オブジェクトのgetCodeメソッドを呼び出すことで、発生したエラーに固有の数値コードを知ることができます。このエラーコードは、getMessageメソッドが返す人間が読むためのエラーメッセージ文字列とは異なり、プログラムがエラーの種類を機械的に識別するために使用されます。取得したコードの値に応じて処理を分岐させるなど、より詳細で信頼性の高いエラーハンドリングを実装する際に重要な役割を果たします。

構文(syntax)

1<?php
2try {
3    // 存在しない、または権限のないデータベースファイルを開こうとします。
4    // これにより SQLite3Exception がスローされます。
5    $db = new SQLite3('/path/to/nonexistent/database.sqlite');
6} catch (SQLite3Exception $e) {
7    // 捕捉した例外オブジェクトから例外コードを取得します。
8    $exceptionCode = $e->getCode();
9
10    // 取得した例外コードを出力します。
11    // 例: 14 (SQLITE_CANTOPEN - データベースを開けなかった)
12    echo $exceptionCode;
13}
14?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

SQLite3ExceptionクラスのgetCodeメソッドは、発生したSQLiteエラーコードを整数型で返します。このコードは、エラーの原因を特定するのに役立ちます。