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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * MessageFormatterを使用して、ロケールに応じたメッセージを生成します。
7 *
8 * この関数は、PHPのintl拡張機能に含まれるMessageFormatterクラスを使い、
9 * 国際化(i18n)に対応したメッセージフォーマットの方法を示します。
10 * 数値に応じた単数形・複数形の切り替え(pluralization)も行います。
11 *
12 * 注意: このコードを実行するには、PHPのintl拡張機能が有効である必要があります。
13 *
14 * @param string $locale フォーマットに使用するロケール (例: 'ja_JP', 'en_US')。
15 * @param string $userName 挨拶する相手の名前。
16 * @param int $messageCount 未読メッセージの数。
17 * @return string フォーマットされたメッセージ。
18 */
19function createLocalizedWelcomeMessage(string $locale, string $userName, int $messageCount): string
20{
21    // メッセージのテンプレートを定義します。
22    // {name} : 文字列を埋め込むプレースホルダー
23    // {count, plural, ...} : 数値(count)に応じて表示を切り替える構文
24    //   =0{...}   : 0の場合のテキスト
25    //   =1{...}   : 1の場合のテキスト
26    //   other{...}: その他の場合のテキスト (# は数値を表す)
27    $pattern = 'こんにちは、{name}さん。未読メッセージが{count, plural, =0{ありません}=1{1件あります}other{#件あります}}。';
28
29    // 英語ロケール用のテンプレート
30    if ($locale === 'en_US') {
31        $pattern = 'Hello {name}, you have {count, plural, =0{no unread messages}=1{one unread message}other{# unread messages}}.';
32    }
33
34    // パラメータを配列にまとめます。
35    $params = [
36        'name' => $userName,
37        'count' => $messageCount,
38    ];
39
40    // MessageFormatter::formatMessage() は、指定したロケールとパターン、
41    // パラメータを使って静的にメッセージをフォーマットします。
42    $formattedMessage = MessageFormatter::formatMessage($locale, $pattern, $params);
43
44    // フォーマット処理でエラーが発生した場合、エラーメッセージを返します。
45    if ($formattedMessage === false) {
46        return 'Error: ' . intl_get_error_message();
47    }
48
49    return $formattedMessage;
50}
51
52// --- 実行例 ---
53
54// 日本語での表示例
55echo createLocalizedWelcomeMessage('ja_JP', '鈴木', 5) . PHP_EOL;
56echo createLocalizedWelcomeMessage('ja_JP', '佐藤', 1) . PHP_EOL;
57echo createLocalizedWelcomeMessage('ja_JP', '高橋', 0) . PHP_EOL;
58
59echo PHP_EOL;
60
61// 英語での表示例
62echo createLocalizedWelcomeMessage('en_US', 'John', 10) . PHP_EOL;
63echo createLocalizedWelcomeMessage('en_US', 'Jane', 1) . PHP_EOL;
64echo createLocalizedWelcomeMessage('en_US', 'Mike', 0) . PHP_EOL;
65
66?>

このPHPコードは、国際化対応ライブラリであるintl拡張機能のMessageFormatterクラスを利用して、ユーザーの使用言語（ロケール）に合わせたメッセージを動的に生成する方法を示しています。createLocalizedWelcomeMessage関数は、3つの引数を受け取ります。第1引数の$localeは言語と国を指定する文字列（例: 'ja_JP'）、第2引数の$userNameはメッセージに表示する名前、第3引数の$messageCountは未読メッセージの数です。関数の内部では、{name}のようなプレースホルダーを含むメッセージのテンプレートを定義しています。特に{count, plural, ...}という構文は、$messageCountの値が0、1、またはそれ以上の場合に応じて、「ありません」「1件あります」「#件あります」のように、単数形や複数形を適切に切り替えるための機能です。MessageFormatter::formatMessage静的メソッドが、これらのテンプレートと引数で渡された値を組み合わせて、最終的なメッセージ文字列を生成します。戻り値として、このフォーマット済みの文字列が返されます。実行例では、日本語と英語のロケールで、メッセージ数が変わると出力が適切に変化することが確認できます。

Copy
1<?php
2
3/**
4 * MessagePack の基本的なエンコードとデコード処理を示すクラス。
5 *
6 * このサンプルを実行するには、PHPのMessagePack拡張機能が必要です。
7 * (例: `pecl install msgpack`)
8 *
9 * MessagePackは、JSONのように構造化されたデータをシリアライズするための
10 * 高速でコンパクトなバイナリ形式です。
11 */
12class MessagePackExample
13{
14    /**
15     * データを受け取り、MessagePackでのエンコードとデコードを実行して結果を表示します。
16     *
17     * @param array<string, mixed> $data シリアライズする連想配列
18     * @return void
19     */
20    public function run(array $data): void
21    {
22        echo "--- 元のデータ ---\n";
23        print_r($data);
24        echo "\n";
25
26        // データをMessagePack形式のバイナリ文字列にエンコード（パック）します。
27        $packedData = msgpack_pack($data);
28
29        echo "--- MessagePack形式にエンコードされたデータ (16進数表記) ---\n";
30        echo bin2hex($packedData) . "\n\n";
31
32        // エンコードされたバイナリデータをデコード（アンパック）して元のPHPのデータに戻します。
33        try {
34            $unpackedData = msgpack_unpack($packedData);
35            echo "--- デコードされたデータ ---\n";
36            print_r($unpackedData);
37        } catch (Exception $e) {
38            // データが破損しているなど、デコードに失敗した場合に例外がスローされます。
39            // Exceptionクラスが持つ `message` プロパティ（`getMessage()`メソッドで取得）を
40            // 使って、エラーメッセージを表示します。
41            // これは `ClosedGeneratorException` のような特定の例外でも同様に使われます。
42            echo "デコード中にエラーが発生しました。\n";
43            echo "エラーメッセージ: " . $e->getMessage() . "\n";
44        }
45    }
46}
47
48// サンプルデータを作成します。
49$sampleData = [
50    'id'      => 1001,
51    'user'    => 'Taro Yamada',
52    'active'  => true,
53    'tags'    => ['php', 'messagepack', 'example'],
54    'profile' => null,
55];
56
57// クラスのインスタンスを作成し、処理を実行します。
58$example = new MessagePackExample();
59$example->run($sampleData);
60

ClosedGeneratorExceptionクラスが持つmessageプロパティは、発生した例外に関する説明的なメッセージを文字列として保持します。このプロパティは、PHPの基本的なExceptionクラスから継承されているため、ClosedGeneratorExceptionだけでなく、他の多くの種類の例外オブジェクトでも共通して利用できます。

サンプルコードでは、try-catchブロックを使って、MessagePack形式のデータをデコードする際に発生しうるエラーを捕捉しています。デコードに失敗するとExceptionオブジェクトが生成され、catchブロックで受け取られます。このとき、$e->getMessage()メソッドを呼び出すことで、messageプロパティに格納された具体的なエラー内容を取得し、画面に表示しています。

getMessage()メソッドは引数を取らず、戻り値としてエラーメッセージの文字列（string）を返します。このように、プログラムの実行中に予期せぬ問題が発生した際、messageプロパティを参照することで、エラーの原因を特定するための重要な情報を得ることができます。