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

messageプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年12月19日

基本的な使い方

messageプロパティは、例外に関する説明的なメッセージを保持するプロパティです。このプロパティはRangeExceptionクラスに属しますが、実際にはその親クラスであるExceptionクラスから継承されたものです。PHPにおける全ての組み込み例外はExceptionクラスを継承しているため、messageプロパティはほとんどの例外オブジェクトが共通して持つ基本的な要素となります。RangeExceptionは、プログラムのロジックにおいて、ある値が期待される有効な範囲を超えていた場合にスローされる例外です。その際、なぜ例外が発生したのかという具体的な理由を説明する文字列が、このmessageプロパティに格納されます。例えば、new RangeException("引数は1から10の間でなければなりません")のようにインスタンスを生成すると、指定した文字列がこのプロパティの値となります。この値は、getMessage()メソッドを通じて取得することができ、エラーログの記録やデバッグ時の原因特定に役立つ重要な情報源として利用されます。

構文(syntax)


1<?php
2try {
3    throw new RangeException("値が有効な範囲にありません。");
4} catch (RangeException $e) {
5    // 例外オブジェクトからメッセージを取得します。
6    echo $e->getMessage();
7}

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

このプロパティは、例外が発生した原因を示す文字列を返します。

サンプルコード

PHP RangeException message をメッセージボックス表示する


1<?php
2
3declare(strict_types=1);
4
5/**
6 * ユーザーの年齢を検証し、範囲外の場合は RangeException をスローします。
7 * 捕捉された例外のメッセージは、簡易的なメッセージボックスとして画面に表示されます。
8 *
9 * @param int $age 検証する年齢
10 * @return void
11 * @throws RangeException 年齢が 0〜120 の範囲外の場合
12 */
13function validateUserAge(int $age): void
14{
15    // 年齢が有効な範囲（0歳から120歳）にあるかチェック
16    if ($age < 0 || $age > 120) {
17        // 範囲外の場合、RangeException をスローする
18        // コンストラクタに渡した文字列が、'message' プロパティに格納される
19        throw new RangeException("入力された年齢 ({$age}歳) は有効な範囲外です。");
20    }
21
22    echo "<p>年齢 {$age}歳 は有効です。</p>";
23}
24
25try {
26    // 正常なケース：有効な年齢を渡す
27    validateUserAge(25);
28
29    // 例外が発生するケース：無効な年齢を渡す
30    validateUserAge(150);
31
32    // 上の行で例外がスローされるため、この行は実行されない
33    echo "<p>このメッセージは表示されません。</p>";
34
35} catch (RangeException $e) {
36    // RangeException を捕捉（キャッチ）する
37    // $e->getMessage() を使って、例外オブジェクトの 'message' プロパティを取得
38    $errorMessage = htmlspecialchars($e->getMessage(), ENT_QUOTES, 'UTF-8');
39
40    // 取得したエラーメッセージを、HTMLとCSSで「メッセージボックス」風に表示
41    echo <<<HTML
42<div style="border: 1px solid #d9534f; background-color: #f2dede; color: #a94442; padding: 15px; margin: 20px; border-radius: 4px; font-family: sans-serif;">
43    <strong>エラー:</strong> {$errorMessage}
44</div>
45HTML;
46}
47
48?>

このPHPサンプルコードは、RangeExceptionのmessageプロパティを利用して、値が有効な範囲外であることを示すエラーメッセージを表示する例です。

validateUserAge関数は、引数の年齢が0歳から120歳の範囲にない場合に、throw new RangeException()で意図的に例外を発生させます。このとき、RangeExceptionの作成時に渡された「入力された年齢...」という文字列が、その例外オブジェクトのmessageプロパティにエラーメッセージとして保存されます。

tryブロックでこの関数を実行し、例外が発生するとプログラムは直ちにcatchブロックへ処理を移します。catchブロックでは、発生したRangeExceptionオブジェクトを$eという変数で受け取ります。

そして、$e->getMessage()メソッドを呼び出すことで、messageプロパティに格納されているエラーメッセージ文字列を取得できます。このメソッドに引数はなく、戻り値は文字列（string）です。コードの最後では、取得したメッセージをHTMLで装飾し、画面にメッセージボックスとして表示しています。このようにmessageプロパティは、例外発生時の具体的な理由をユーザーに分かりやすく伝えるために利用されます。

throw new RangeException()の引数に渡した文字列が、catchブロックで$e->getMessage()メソッドを使って取得されるエラーメッセージとなります。例外がスローされると、tryブロック内のそれ以降のコードは実行されず、直ちにcatchブロックに処理が移る点に注意してください。最も重要な点は、getMessage()で取得した値をHTML上に出力する際は、サンプルコードのようにhtmlspecialchars()関数を使い必ずエスケープ処理を行うことです。これを怠ると、クロスサイトスクリプティング（XSS）というセキュリティ上の脆弱性につながる危険があります。また、エラーの種類に応じてRangeExceptionのような具体的な例外クラスを選択すると、コードがより分かりやすくなります。

PHPでメッセージキューを実装する


1<?php
2
3/**
4 * シンプルなメッセージキューを表現するクラス
5 */
6class SimpleMessageQueue
7{
8    // メッセージを格納する配列
9    private array $queue = [];
10
11    // キューの最大サイズ
12    private readonly int $maxSize;
13
14    /**
15     * コンストラクタ
16     * @param int $maxSize キューに格納できるメッセージの最大数
17     */
18    public function __construct(int $maxSize = 5)
19    {
20        $this->maxSize = $maxSize;
21    }
22
23    /**
24     * キューにメッセージを追加する
25     * @param string $message 追加するメッセージ
26     * @throws RangeException キューが満杯の場合にスローされる
27     */
28    public function addMessage(string $message): void
29    {
30        // 現在のキューのサイズが最大サイズ以上であれば例外をスロー
31        if (count($this->queue) >= $this->maxSize) {
32            // RangeExceptionを生成し、エラーメッセージを設定する
33            throw new RangeException("キューが満杯です。最大サイズ: {$this->maxSize}");
34        }
35        $this->queue[] = $message;
36        echo "メッセージを追加しました: '{$message}'" . PHP_EOL;
37    }
38
39    /**
40     * キューからメッセージを1つ取り出す
41     * @return string|null メッセージ、またはキューが空の場合はnull
42     */
43    public function processMessage(): ?string
44    {
45        // 配列の先頭から要素を取り出す (FIFO: First-In, First-Out)
46        return array_shift($this->queue);
47    }
48}
49
50// キューのインスタンスを最大サイズ3で作成
51$queue = new SimpleMessageQueue(3);
52
53try {
54    // メッセージをキューに追加していく
55    $queue->addMessage("タスク1: ユーザー登録処理");
56    $queue->addMessage("タスク2: メール送信");
57    $queue->addMessage("タスク3: ログ記録");
58
59    // ここでキューは満杯になる (サイズ3)
60
61    // さらにメッセージを追加しようとすると、RangeExceptionがスローされる
62    echo PHP_EOL . "4つ目のメッセージを追加しようとしています..." . PHP_EOL;
63    $queue->addMessage("タスク4: バックアップ作成");
64
65} catch (RangeException $e) {
66    // スローされた例外(RangeException)をキャッチする
67    echo "エラーが発生しました。" . PHP_EOL;
68
69    // Exceptionクラスから継承したgetMessage()メソッドを使い、
70    // 例外オブジェクトに設定されたエラーメッセージを取得・表示する
71    // これが RangeException->message プロパティの値にあたる
72    echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
73}
74

このPHPコードは、シンプルなメッセージキューの仕組みを通して、RangeException という例外クラスの message プロパティの役割を解説します。RangeException は、ある値が決められた有効な範囲を超えた場合に発生するエラーです。このサンプルでは、キューに追加できるメッセージの最大数を超えた場合に、この例外を意図的に発生させています。

addMessage メソッド内でキューが満杯になると、throw new RangeException("キューが満杯です...") のように、エラーメッセージを引数に渡して RangeException オブジェクトが生成され、スローされます。このとき渡された「キューが満杯です。最大サイズ: 3」という文字列が、RangeException オブジェクトの message プロパティに保存されます。

try...catch構文の catch ブロックで、スローされた RangeException オブジェクトを $e という変数で受け取ります。$e->getMessage() を呼び出すことで、message プロパティに保存されているエラーメッセージ文字列を取得できます。この getMessage() メソッドは引数を取らず、戻り値として文字列を返します。この仕組みにより、プログラムはエラーで停止することなく、発生した問題の具体的な内容を画面に出力できます。

このコードは、キューのサイズが上限を超えた場合に RangeException という例外を意図的に発生させています。throw はプログラムの正常な流れを中断し、エラーが発生したことを知らせるための仕組みです。この例外を適切に処理するために try...catch 構文が不可欠です。もし try ブロックで囲まなければ、例外が発生した時点でプログラムはエラーとなり停止してしまいます。catch ブロックでは、発生した例外の情報を持つオブジェクト（変数 $e）を受け取ります。そして $e->getMessage() メソッドを使うことで、例外発生時に設定されたエラーメッセージ「キューが満杯です...」を取得できます。これにより、エラーの原因を具体的に把握し、適切な対応をとることが可能になります。