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

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

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

基本的な使い方

getMessageメソッドは、PHP 8.1で導入された非同期処理の仕組みであるFiberの実行中に発生したエラーに関するメッセージを取得するメソッドです。このメソッドは、FiberErrorクラスに属しており、Fiberの実行中に予期せぬ問題が発生し、その詳細を知りたい場合に利用されます。

Fiberは、処理を中断・再開できるコルーチンのような機能を提供し、非同期処理をより直感的に記述することを可能にします。しかし、Fiberの開始、中断、再開といったライフサイクルにおいて、何らかの異常が発生するとFiberErrorがスローされます。このgetMessageメソッドは、そのFiberErrorオブジェクトが保持するエラーの内容を説明する文字列を返します。

返される文字列は、例えば「Fiber started more than once」のように、どのような問題が起きたのかを具体的に示します。開発者はこのメソッドを使ってエラーメッセージを取得し、エラーの原因を特定し、プログラムのデバッグを行う上で重要な手がかりとすることができます。try-catchブロックでFiberErrorを捕捉した場合に、そのエラーオブジェクトからgetMessageメソッドを呼び出すことで、具体的なエラーの内容を把握できます。これにより、エラー処理をより詳細に行うことが可能になり、堅牢なアプリケーション開発に貢献します。

構文(syntax)


1<?php
2$error = new FiberError("Fiber operation failed.");
3$message = $error->getMessage();

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

FiberError::getMessage は、Fiber の実行中に発生したエラーメッセージを文字列として返します。

サンプルコード

FiberErrorメッセージを取得する


1<?php
2
3/**
4 * FiberErrorから完全なエラーメッセージを取得する例
5 *
6 * この関数は、意図的に FiberError を発生させ、catchした例外オブジェクトから
7 * getMessage() メソッドを使ってエラーメッセージを取得し表示します。
8 * getMessage() は、表示上の問題で省略(truncated)されることがあっても、
9 * メソッド自体は常に完全なエラーメッセージ文字列を返します。
10 */
11function demonstrateFiberErrorMessage(): void
12{
13    // Fiberを作成します。このFiberは一度実行されるとすぐに終了します。
14    $fiber = new Fiber(function (): void {
15        // このFiberは何もせず、すぐに終了します。
16    });
17
18    try {
19        // 1. Fiberを開始します。これによりFiberは実行され、終了(terminated)状態になります。
20        $fiber->start();
21
22        // 2. 既に終了したFiberを再度再開(resume)しようとします。
23        // これにより、"Fiber has already been terminated" というメッセージを持つ
24        // FiberError がスローされます。
25        echo "Attempting to resume a terminated fiber...\n";
26        $fiber->resume();
27    } catch (FiberError $e) {
28        // 3. スローされた FiberError をキャッチします。
29        echo "Caught a FiberError!\n";
30
31        // 4. getMessage() を使って、完全なエラーメッセージを取得して表示します。
32        $fullMessage = $e->getMessage();
33        echo "Full Message from getMessage(): " . $fullMessage . "\n";
34    }
35}
36
37// 関数を実行します
38demonstrateFiberErrorMessage();

FiberErrorクラスのgetMessage()メソッドは、Fiberの操作で発生したエラーに関する詳細なメッセージを取得するために使用します。このメソッドは引数を必要とせず、戻り値としてエラーメッセージを含む文字列（string）を返します。

サンプルコードは、意図的にFiberErrorを発生させる例です。まず、一度実行するとすぐに終了するFiberを作成し、start()で実行します。次に、すでに終了（terminated）した状態のFiberに対して再度resume()メソッドを呼び出します。この操作は許可されていないため、「Fiber has already been terminated」という内容のFiberErrorが発生します。

try...catchブロックでこのエラーを捕捉し、受け取った例外オブジェクトのgetMessage()メソッドを実行することで、エラーの原因を示す完全なメッセージ文字列を取得して表示しています。PHPの環境によっては画面に表示されるエラーメッセージが長文の場合に省略（truncated）されることがありますが、getMessage()メソッド自体は常に省略されていない完全な文字列を返します。これにより、開発者はエラーの正確な原因を把握することができます。

このサンプルコードは、終了済みのFiberを再度操作しようとすることで、意図的にエラー（FiberError）を発生させています。try-catch構文で捕捉した例外オブジェクトに対し getMessage() を使うと、エラー内容の文字列を取得できます。これはPHPにおける例外処理の基本的な方法です。注意点として、このメソッドが返すメッセージは常に完全なものですが、コンソールやログファイルへ出力する際に、設定によっては表示が途中で省略されることがあります。エラーの原因を正確に把握するためには、表示された結果だけでなく、メソッドが返した完全な文字列を確認することが重要です。