【PHP8.x】PDOException::messageプロパティの使い方

messageプロパティは、PDOExceptionオブジェクトが保持するエラーメッセージを表す文字列を保持するプロパティです。

PDOExceptionクラスは、PHPでデータベースを扱うためのPDO (PHP Data Objects) 拡張機能を使用している際に、データベースへの接続失敗やSQL文の構文エラーなど、データベース操作に関連する何らかの問題が発生した場合にスローされる（発生する）例外を表します。このmessageプロパティには、そのデータベースエラーの具体的な内容を説明するテキスト情報が格納されます。

例えば、「データベースへの接続に失敗しました」というような一般的なエラーメッセージから、「SQLSTATE[HY000]: General error: 2002 Connection refused」のようなより詳細な技術的エラーコードや説明まで、発生した問題の詳細がこのプロパティの値として提供されます。

システムエンジニアがデータベース関連のエラーを調査・デバッグする際には、try-catchブロックでPDOExceptionを捕捉し、このmessageプロパティの値を確認することで、何が問題を引き起こしたのかを正確に理解することができます。また、アプリケーションでエラーが発生した際に、ユーザーに対してより分かりやすいメッセージを表示したり、システムログに詳細な情報を記録したりする際にも、このプロパティの情報は非常に有用です。

messageプロパティは読み取り専用であり、PDOExceptionオブジェクトが生成されたときに一度設定されると、その内容を後から変更することはできません。これにより、エラー発生時の正確な情報が保証されます。

Copy
1<?php
2
3try {
4    // 存在しないデータベースに接続しようとして、PDOExceptionを発生させる例
5    $pdo = new PDO('mysql:host=localhost;dbname=non_existent_db', 'username', 'password');
6} catch (PDOException $e) {
7    // 捕捉したPDOExceptionオブジェクトからmessageプロパティの値にアクセスする
8    echo $e->message;
9}
10
11?>

引数なし

引数はありません

string

PDOExceptionクラスのmessageプロパティは、発生したデータベースエラーに関する詳細なメッセージを文字列として返します。