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

Copy
1<?php
2
3// PHPのintl拡張機能が有効になっていることを確認してください。
4// php.iniで `extension=intl` のコメントを解除する必要がある場合があります。
5
6/**
7 * TypeErrorを意図的に発生させ、その`message`プロパティを取得し、
8 * MessageFormatterを使用してよりユーザーフレンドリーな形式で表示するサンプルです。
9 *
10 * システムエンジニアを目指す初心者向けに、エラー処理の基本と
11 * 国際化されたメッセージ表示の一例を示します。
12 */
13function demonstrateTypeErrorWithMessageFormatter(): void
14{
15    // MessageFormatterを初期化します。
16    // これにより、プレースホルダー（例：`{0}`）を含むメッセージを作成し、
17    // 後からそのプレースホルダーに値を埋め込むことができます。
18    // これは、特に国際化されたアプリケーションで役立ちます。
19    $formatter = new MessageFormatter(
20        'ja_JP', // ロケールを日本語に設定
21        '処理中に型エラーが発生しました: {0}。入力データを確認してください。'
22    );
23
24    // 特定の引数型を期待する関数を定義します。
25    // 間違った型の引数が渡された場合、TypeErrorが発生します。
26    function calculateDiscount(int $originalPrice, float $discountRate): float
27    {
28        return $originalPrice * (1 - $discountRate);
29    }
30
31    echo "間違った型でcalculateDiscount関数を呼び出してみます...\n";
32
33    try {
34        // ここで意図的に間違った型の引数を渡します。
35        // PHP 8では、'1000' (文字列) を int に、'0.1' (文字列) を float に渡そうとすると、
36        // TypeError がスローされます。
37        calculateDiscount('1000', '0.1');
38    } catch (TypeError $e) {
39        // TypeErrorが発生した場合、ここでキャッチします。
40        // $e オブジェクトにはエラーに関する詳細情報が含まれています。
41
42        // TypeErrorオブジェクトの`message`プロパティは、`getMessage()`メソッドを介して取得します。
43        // これには、発生したエラーの具体的な説明が含まれています。
44        $rawErrorMessage = $e->getMessage();
45
46        echo "TypeErrorをキャッチしました！\n";
47        echo "TypeErrorからの元のエラーメッセージ: " . $rawErrorMessage . "\n";
48
49        // MessageFormatterを使用して、取得したエラーメッセージを
50        // 定義したテンプレートに挿入し、ユーザーフレンドリーな形式で出力します。
51        $formattedOutput = $formatter->format([$rawErrorMessage]);
52        echo "フォーマットされたエラー出力: " . $formattedOutput . "\n";
53
54        // エラーが発生したファイル名と行番号も取得できます。
55        echo "ファイル: " . $e->getFile() . ", 行: " . $e->getLine() . "\n";
56
57    } finally {
58        // tryまたはcatchブロックの後に常に実行されるコード
59        echo "\nTypeErrorのデモンストレーションが完了しました。\n";
60    }
61}
62
63// デモンストレーション関数を実行します。
64demonstrateTypeErrorWithMessageFormatter();

このPHPサンプルコードは、関数の引数に意図的に間違ったデータ型を渡すことでTypeErrorを発生させ、そのエラー情報を処理する方法を示しています。

まず、tryブロック内で、整数（int）と浮動小数点数（float）を期待するcalculateDiscount関数に対し、あえて文字列（string）を渡しています。PHP 8の型チェック機能により、この呼び出しでTypeErrorが発生します。

次に、catch (TypeError $e)ブロックで発生したTypeErrorを捕捉します。捕捉したエラーオブジェクト$eには、エラーに関する詳細情報が含まれています。$e->getMessage()メソッドを呼び出すと、TypeErrorのmessageプロパティに格納されている、エラーの原因を説明する文字列（string）を取得できます。このメソッドに引数は必要なく、戻り値としてエラーメッセージが返されます。

最後に、このコードではMessageFormatterを利用して、取得したエラーメッセージを「処理中に型エラーが発生しました: ...」という、より利用者に分かりやすい日本語のテンプレートに埋め込んで表示しています。これは、プログラムで発生したエラーを捕捉し、利用者に適切なフィードバックを返すための基本的なエラーハンドリングの一例です。

Copy
1<?php
2
3/**
4 * このコードを実行するには、PHPのMessagePack拡張機能(msgpack)が必要です。
5 * (`pecl install msgpack` コマンドなどでインストールできます)
6 */
7
8/**
9 * MessagePackのデコード時に発生するTypeErrorを捕捉し、エラーメッセージを表示します。
10 *
11 * msgpack_unpack() 関数は引数にバイナリ文字列を期待しますが、
12 * ここでは意図的に配列を渡すことで TypeError を発生させ、
13 * 捕捉した例外オブジェクトの `message` プロパティの値を出力します。
14 */
15function demonstrateMessagePackTypeError(): void
16{
17    // msgpack_unpack() に渡す不正なデータ（文字列ではなく配列）
18    $invalidData = ['not_a_binary_string'];
19
20    try {
21        // 文字列を期待する関数に配列を渡しているため、ここで TypeError がスローされます。
22        msgpack_unpack($invalidData);
23    } catch (TypeError $e) {
24        // catchブロックで TypeError のインスタンスを捕捉します。
25        // $e->getMessage() は、例外オブジェクトの `message` プロパティにアクセスし、
26        // エラーメッセージの文字列を返します。
27        echo "キャッチした例外: " . get_class($e) . "\n";
28        echo "エラーメッセージ: " . $e->getMessage() . "\n";
29    }
30}
31
32// 関数を実行して動作を確認します。
33demonstrateMessagePackTypeError();

このPHPコードは、TypeErrorが発生した際に、そのエラー内容を説明するメッセージを取得する方法を示しています。TypeErrorは、関数やメソッドに期待されるデータ型とは異なる型の値が渡された場合などに発生するエラーです。

サンプルコードでは、msgpack_unpack()関数に対して、期待される文字列型ではなく意図的に配列型のデータを渡しています。これによりTypeErrorが発生しますが、プログラムはtry...catch構文によってエラーを捕捉し、処理を続行します。

catchブロックでは、発生したTypeErrorの情報を持つオブジェクトが変数$eに代入されます。このオブジェクトのmessageプロパティには、なぜエラーが発生したのかを人間が読んで理解できる形の説明文が文字列として格納されています。

$e->getMessage()メソッドは、このmessageプロパティの値を取得するためのものです。このメソッドに引数はなく、戻り値としてエラーメッセージの文字列を返します。コードの最後では、このメソッドを使って取得したエラーメッセージを画面に出力しています。このように、messageプロパティを利用することで、プログラム実行中に発生したエラーの原因を具体的に知ることができます。