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

Copy
1<?php
2
3/**
4 * DOMException を捕捉し、そのメッセージを MessageFormatter で整形して出力する関数。
5 * システムエンジニアを目指す初心者にも分かりやすいように、
6 * DOM操作で発生する例外の扱いと、多言語対応メッセージの整形方法を示します。
7 */
8function handleDomExceptionWithMessageFormatter(): void
9{
10    // DOMDocument をインスタンス化します。XML文書を扱うためのクラスです。
11    $dom = new DOMDocument();
12
13    // 存在しないXMLファイルをロードしようとすると、DOMException が発生します。
14    // これは、DOMException を意図的に発生させる一般的な方法の一つです。
15    $nonExistentFile = 'non_existent_document.xml';
16
17    try {
18        // 存在しないファイルをロードしようと試みます。
19        // この操作が失敗すると、DOMException がスローされます。
20        $dom->load($nonExistentFile);
21        
22        // 例外が発生しなかった場合、この行が出力されますが、
23        // 上記のケースでは通常到達しません。
24        echo "XMLが正常にロードされました。\n"; 
25
26    } catch (DOMException $e) {
27        // DOMException がスローされた場合、ここで捕捉されます。
28        // $e は DOMException クラスのインスタンスです。
29
30        // リファレンス情報に基づき、DOMException オブジェクトの 'message' プロパティから
31        // エラーメッセージを取得します。
32        $exceptionMessage = $e->message;
33
34        // MessageFormatter を使用して、ユーザー向けのメッセージを整形します。
35        // これは、国際化対応 (i18n) されたメッセージを生成するのに役立ちます。
36        // 第1引数はロケール（ここでは日本語 'ja_JP'）。
37        // 第2引数はメッセージのフォーマット文字列です。
38        // 波括弧 {} で囲まれた部分はプレースホルダーとして機能し、後で値が挿入されます。
39        $formatter = new MessageFormatter(
40            'ja_JP',
41            "エラーが発生しました: \"{originalMessage}\"。ファイル '{filename}' の読み込み中に問題がありました。システム管理者にお問い合わせください。(エラーコード: {errorCode})"
42        );
43
44        // MessageFormatter::format() メソッドに、プレースホルダーに対応する連想配列を渡します。
45        // これにより、整形された最終的なメッセージが生成されます。
46        $formattedOutput = $formatter->format([
47            'originalMessage' => $exceptionMessage, // DOMException から取得したメッセージ
48            'filename'        => $nonExistentFile,  // 存在しないファイル名
49            'errorCode'       => $e->getCode()      // 例外の数値コード
50        ]);
51
52        // 元の例外メッセージと MessageFormatter によって整形されたメッセージの両方を出力します。
53        echo "--- 例外をキャッチしました ---\n";
54        echo "元の例外メッセージ: " . $exceptionMessage . "\n";
55        echo "MessageFormatterによる整形後メッセージ:\n" . $formattedOutput . "\n";
56    }
57}
58
59// 定義した関数を実行して、DOMException の発生とメッセージ整形を確認します。
60handleDomExceptionWithMessageFormatter();

このサンプルコードは、PHPにおけるDOMExceptionの処理と、MessageFormatterを用いたメッセージの整形方法を初心者向けに解説します。まず、DOMDocumentクラスで存在しないXMLファイルの読み込みを試みることで、意図的にDOMExceptionを発生させます。

プログラムはtry-catchブロックを使ってこの例外を捕捉します。捕捉されたDOMExceptionオブジェクト（変数$e）から、$e->messageプロパティを使用してエラーメッセージを取得します。このmessageプロパティは引数を取らず、例外の具体的な内容を示す文字列を戻り値として返します。

取得したエラーメッセージは、そのままユーザーに表示するのではなく、MessageFormatterクラスを使って整形されます。MessageFormatterは、国際化対応（i18n）されたメッセージを生成するために利用され、指定したロケール（例: ja_JP）とフォーマット文字列に基づいて、エラーメッセージ、ファイル名、エラーコードなどの情報をプレースホルダーに埋め込みます。これにより、元の技術的な例外メッセージが、ユーザーにとって理解しやすく、より親切な形式で提示されるようになります。最終的に、整形前と整形後の両方のメッセージが出力され、その違いを確認できます。

Copy
1<?php
2
3/**
4 * MessagePack データを扱い、DOMException のメッセージ取得例を示す関数。
5 * システムエンジニアを目指す初心者向けに、例外処理の基本と特定の例外のメッセージ取得方法を示します。
6 *
7 * DOMException は通常、XML/HTML の DOM 操作中に発生する例外ですが、
8 * ここではその message プロパティの動作を示すために意図的にスローする例を含みます。
9 * 実際の MessagePack 処理で DOMException が直接発生することは稀です。
10 */
11function handleMessagePackAndShowExceptionMessage(): void
12{
13    echo "--- MessagePack データの処理例 ---" . PHP_EOL;
14
15    // MessagePack でエンコードするサンプルデータ
16    $data = [
17        'name' => 'John Doe',
18        'age' => 30,
19        'isStudent' => false,
20        'grades' => [90, 85, 92]
21    ];
22
23    try {
24        // PHP の MessagePack 拡張機能がインストールされているか確認
25        if (extension_loaded('msgpack')) {
26            echo "元のデータ: " . json_encode($data) . PHP_EOL;
27
28            // データを MessagePack 形式にエンコード（バイナリ形式に変換）
29            $packedData = msgpack_pack($data);
30            echo "MessagePack エンコード後のバイナリデータ (Hex): " . bin2hex($packedData) . PHP_EOL;
31
32            // MessagePack 形式からデコード（元のデータ構造に戻す）
33            $unpackedData = msgpack_unpack($packedData);
34            echo "MessagePack デコード後のデータ: " . json_encode($unpackedData) . PHP_EOL;
35
36            // 元のデータとデコードしたデータが一致するか確認
37            if ($data === $unpackedData) {
38                echo "エンコードとデコードは成功し、データは一致しました。" . PHP_EOL;
39            } else {
40                echo "Warning: エンコードとデコード後にデータが一致しませんでした。" . PHP_EOL;
41            }
42
43        } else {
44            echo "Warning: PHP の MessagePack 拡張機能がインストールされていません。" . PHP_EOL;
45            echo "MessagePack の処理はスキップされます。`pecl install msgpack` でインストールしてください。" . PHP_EOL;
46        }
47
48    } catch (Throwable $e) {
49        // MessagePack 関連の処理で発生した可能性のある一般的な例外を捕捉
50        // この $e->getMessage() は、DOMException 以外の例外でもメッセージを取得できます。
51        echo "MessagePack 処理中にエラーが発生しました: " . $e->getMessage() . PHP_EOL;
52    }
53
54    echo PHP_EOL . "--- DOMException のメッセージ取得例 ---" . PHP_EOL;
55
56    // DOMException の message プロパティの動作を示すために、意図的にこの例外をスローします。
57    // 実際のアプリケーションでは、DOMException は DOMDocument などの DOM 操作が失敗したときに発生します。
58    try {
59        // DOMException を意図的にスローする例
60        // ここで指定する文字列が、例外のメッセージになります。
61        throw new DOMException("無効なDOMノードが見つかりました。", 5);
62    } catch (DOMException $e) {
63        // 捕捉した DOMException オブジェクトからメッセージを取得します。
64        // message プロパティは、コンストラクタに渡されたメッセージ文字列を保持します。
65        echo "捕捉した DOMException のメッセージ: " . $e->message . PHP_EOL;
66        // $e->getMessage() メソッドも同じメッセージを返します。
67        echo "（補足: \$e->getMessage() も同じ結果を返します: " . $e->getMessage() . "）" . PHP_EOL;
68        echo "例外コード: " . $e->getCode() . PHP_EOL;
69        echo "例外が発生したファイル: " . $e->getFile() . PHP_EOL;
70        echo "例外が発生した行: " . $e->getLine() . PHP_EOL;
71    } catch (Throwable $e) {
72        // DOMException 以外の予期せぬ例外を捕捉する場合
73        echo "その他の種類の例外が発生しました: " . $e->getMessage() . PHP_EOL;
74    }
75}
76
77// 定義した関数を実行します。
78handleMessagePackAndShowExceptionMessage();
79

このPHPサンプルコードは、システムエンジニアを目指す初心者向けに、例外処理の基本と、DOMExceptionクラスのmessageプロパティによるメッセージ取得方法を解説します。

コード前半では、MessagePackというデータフォーマットを使ったデータのエンコード（変換）とデコード（復元）の例を通じて、try-catch文を用いた一般的なエラーハンドリングの仕組みを示しています。ここでは、extension_loaded関数で拡張機能の有無を確認し、もしMessagePack処理中に問題があればcatchブロックでエラーメッセージを表示する流れがわかります。

次に、コード後半では、DOMExceptionクラスのmessageプロパティに焦点を当てます。DOMExceptionは通常、XMLやHTMLなどのドキュメントオブジェクトモデル（DOM）操作中にエラーが発生した際に利用される例外です。このmessageプロパティは、例外発生時にどのような問題が起きたかを説明する文字列（string型）を保持します。引数はなく、常に例外オブジェクトが持つメッセージ文字列を返します。サンプルコードでは、throw new DOMException(...)としてこの例外を意図的に発生させ、catch (DOMException $e)で捕捉した後、$e->messageと記述することで、例外が持つ具体的なメッセージ内容を取得できることを示しています。このmessageプロパティに格納される文字列は、例外オブジェクトを生成する際にコンストラクタに渡されたものです。また、$e->getMessage()メソッドでも同じメッセージを取得できます。