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

Copy
1<?php
2
3// SQLite3Exception クラスの __toString メソッドのサンプル
4try {
5    $db = new SQLite3(':memory:');
6    $db->exec('CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT)');
7    $db->exec('INSERT INTO users (name) VALUES ("John Doe")');
8
9    // 存在しないカラムを指定して例外を発生させる
10    $result = $db->query('SELECT email FROM users');
11} catch (SQLite3Exception $e) {
12    // 例外オブジェクトを文字列として出力する
13    echo "例外が発生しました:\n";
14    echo $e; // __toString メソッドが暗黙的に呼ばれる
15    echo "\n";
16} finally {
17    if (isset($db)) {
18        $db->close();
19    }
20}

このサンプルコードは、PHPのSQLite3拡張におけるSQLite3Exceptionクラスの__toStringメソッドの動作を示しています。__toStringメソッドは、オブジェクトを文字列として表現するために使用される特別なメソッドです。

この例では、まずSQLite3データベースへの接続を確立し、テーブルを作成してデータを挿入しようとしています。次に、存在しないカラムemailを指定したSELECTクエリを実行し、SQLite3Exceptionを発生させています。

catchブロックでは、発生したSQLite3Exceptionオブジェクトを変数$eで受け取ります。そして、echo $e;とすることで、$eオブジェクトの__toStringメソッドが暗黙的に呼び出されます。__toStringメソッドは、例外に関する情報を文字列として返します。具体的には、例外メッセージ、ファイル名、行番号などが含まれます。

この例では、__toStringメソッドによって生成された文字列が画面に出力されるため、発生した例外の内容を簡単に確認できます。__toStringメソッドは引数を取りませんが、例外の内容を表す文字列を戻り値として返します。finallyブロックでは、データベース接続を閉じ、リソースを解放しています。このサンプルは、例外処理と__toStringメソッドの連携を示す良い例です。

Copy
1<?php
2
3class Database {
4    private SQLite3 $db;
5
6    public function __construct(string $dbPath) {
7        try {
8            $this->db = new SQLite3($dbPath);
9        } catch (SQLite3Exception $e) {
10            // SQLite3Exception オブジェクトを文字列として扱います。
11            echo "データベース接続エラー: " . $e . PHP_EOL;
12            exit(1);
13        }
14    }
15
16    public function execute(string $sql): SQLite3Result|bool {
17        return $this->db->query($sql);
18    }
19
20    public function close(): void {
21        $this->db->close();
22    }
23}
24
25// データベース接続とエラーハンドリングの例
26$dbPath = 'test.db'; // データベースのパス
27
28try {
29    $database = new Database($dbPath);
30
31    // テーブル作成
32    $database->execute('CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT)');
33
34    // データ挿入
35    $database->execute("INSERT INTO users (name) VALUES ('John Doe')");
36
37    // データ取得
38    $result = $database->execute('SELECT * FROM users');
39
40    while ($row = $result->fetchArray()) {
41        echo "ID: " . $row['id'] . ", Name: " . $row['name'] . PHP_EOL;
42    }
43
44    $database->close();
45
46} catch (Exception $e) {
47    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
48}

このサンプルコードは、PHPのSQLite3拡張を利用したデータベース接続と操作の例を示しています。特に、SQLite3Exceptionクラスの__toStringメソッドに注目しています。__toStringメソッドは、PHPの特殊メソッドの一つで、オブジェクトが文字列として扱われる際に自動的に呼ばれます。

このコードでは、Databaseクラスのコンストラクタ内でSQLite3データベースへの接続を試みています。もし接続に失敗した場合、SQLite3Exceptionが発生します。この例外をcatchブロックで捉え、echo "データベース接続エラー: " . $e . PHP_EOL;という部分で例外オブジェクト $e を文字列として出力しています。

ここで、SQLite3Exceptionオブジェクトが文字列として扱われる際に、自動的に__toStringメソッドが呼び出されます。__toStringメソッドは引数を取らず、例外に関する情報を含む文字列を返します。これにより、エラーメッセージを簡潔に表示できます。

サンプルコード全体としては、データベースへの接続、テーブルの作成、データの挿入、データの取得、そしてデータベースのクローズという一連の操作を示しています。try-catchブロックを使用することで、エラーが発生した場合でもプログラムが予期せぬ終了をしないように、例外処理を行っています。また、データベース操作中に発生する可能性のある一般的な例外（Exception）も捕捉し、エラーメッセージを表示しています。