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

getMessageメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年10月16日

基本的な使い方

getMessageメソッドは、ClosedGeneratorExceptionオブジェクトに格納されているエラーメッセージを取得するメソッドです。ClosedGeneratorExceptionは、PHPのジェネレータが既に終了している、または閉じられている状態にもかかわらず、そのジェネレータに対して値の送信や取得といった操作を行おうとした際に発生する例外です。

このメソッドを呼び出すことで、例外が発生した具体的な理由を説明する文字列型のメッセージを取得できます。例えば、「ジェネレータは既にクローズされています」といった内容のメッセージが返されます。このメッセージは、プログラムで予期せぬエラーが発生した際に、その原因を特定し、デバッグを行うための重要な情報となります。

getMessageメソッドは引数を受け取らず、例外に関する詳細な情報を含む文字列を返します。この機能は、エラーメッセージを画面に表示したり、システムログに記録したりする際に利用され、プログラムの安定性を保つためのエラーハンドリングにおいて不可欠な要素です。ClosedGeneratorExceptionだけでなく、PHPのすべての例外クラスがこのメソッドを実装しており、例外処理の基本的な構成要素として広く利用されています。

構文(syntax)


1<?php
2$closedGeneratorException = new ClosedGeneratorException();
3$exceptionMessage = $closedGeneratorException->getMessage();

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

このメソッドは、例外が発生した際の詳細なメッセージを文字列として返します。

サンプルコード

ClosedGeneratorExceptionメッセージを取得する


1<?php
2
3/**
4 * ClosedGeneratorException::getMessage() の使用例を示します。
5 *
6 * ジェネレータが閉じられた後に再度値を生成しようとした際にスローされる
7 * ClosedGeneratorException をキャッチし、そのメッセージを取得します。
8 *
9 * @return void
10 */
11function demonstrateClosedGeneratorExceptionMessage(): void
12{
13    // ジェネレータ関数を定義します。
14    function myNumberGenerator(): Generator
15    {
16        for ($i = 1; $i <= 3; $i++) {
17            yield $i;
18        }
19    }
20
21    echo "--- ClosedGeneratorException の発生とメッセージ取得 ---" . PHP_EOL;
22
23    $generator = myNumberGenerator();
24
25    // ジェネレータを一度実行し、最初の値を生成します。
26    echo "最初の値: " . $generator->current() . PHP_EOL;
27    $generator->next(); // 2番目の値に進みます
28
29    // ジェネレータを明示的に閉じます。
30    // これにより、それ以上値を生成できなくなります。
31    $generator->close();
32    echo "ジェネレータを明示的に閉じました。" . PHP_EOL;
33
34    // 閉じられたジェネレータを再開しようとすると ClosedGeneratorException がスローされます。
35    try {
36        echo "閉じられたジェネレータを再開しようとします..." . PHP_EOL;
37        $generator->next(); // ここで ClosedGeneratorException がスローされる
38        echo "この行は実行されません。" . PHP_EOL; // 例外が発生するため、この行はスキップされます
39    } catch (ClosedGeneratorException $e) {
40        // ClosedGeneratorException をキャッチし、getMessage() でメッセージを取得します。
41        echo "ClosedGeneratorException をキャッチしました！" . PHP_EOL;
42        echo "例外メッセージ: " . $e->getMessage() . PHP_EOL;
43    } catch (Throwable $e) {
44        // その他の予期せぬ例外をキャッチ
45        echo "予期せぬ例外をキャッチしました: " . $e->getMessage() . PHP_EOL;
46    }
47}
48
49// 関数を実行します。
50demonstrateClosedGeneratorExceptionMessage();

ClosedGeneratorException::getMessage()は、PHP 8において、閉じられたジェネレータから値を生成しようとした際にスローされるClosedGeneratorExceptionのメッセージを取得するメソッドです。引数はなく、例外の原因を示す文字列（string）を返します。

サンプルコードでは、myNumberGeneratorというジェネレータを作成し、一部の値を生成後にclose()で明示的に閉じます。閉じられたジェネレータに再度next()を呼び出すとClosedGeneratorExceptionが発生します。プログラムはこの例外をtry-catchで捕捉し、getMessage()でエラーメッセージを取得・表示します。これにより、閉じられたジェネレータへの誤ったアクセス状況を把握し、適切なエラーハンドリングを行えます。

getMessage() メソッドは、例外オブジェクトからエラー内容を示す文字列を取得する基本的な方法です。ClosedGeneratorException は、ジェネレータが明示的に close() された後や、全ての値を生成し終えて暗黙的に閉じられた後に、再び値を生成しようとした際に発生します。この例外は、ジェネレータが使用不可能な状態であることを示し、予期せぬ動作を防ぎます。コードの安全性向上のため、ジェネレータを使う際は、特に close() 後やループ終了後の next() 呼び出しには注意し、try-catch ブロックで ClosedGeneratorException を捕捉して例外メッセージを確認し、適切にエラー処理を行うことが重要です。