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

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

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

基本的な使い方

getReturnメソッドは、PHPのFiberクラスに属し、ファイバーの実行が完了した際にその返り値を取得するために使用されるメソッドです。PHP 8.1で導入されたFiberクラスは、協調的マルチタスクを実現するための機能で、処理を中断したり再開したりすることができます。

このgetReturnメソッドは、ファイバーの実行がreturnステートメントによって正常に終了した場合にのみ、その返り値を取得するために呼び出されます。つまり、Fiber::run()メソッドなどによってファイバーの実行が完全に完了している必要があります。ファイバーがFiber::suspend()によって中断されている状態である場合や、まだ実行されていない、あるいはまだ終了していない場合には、このメソッドを呼び出すことはできません。

もしファイバーの実行が例外の発生によって終了した場合、getReturnメソッドを呼び出すと、その例外が再スローされます。これは、ファイバー内で発生したエラーを適切に処理するために重要です。

このメソッドは、ファイバーの最終的な結果を受け取りたい場合に活用されます。例えば、複数の軽量な非同期処理を行い、それぞれの処理結果を後でまとめて取得するようなシナリオで役立ちます。これにより、複雑なコールバック関数を使用することなく、より直線的で読みやすいコードで並行処理を記述できるようになります。

構文(syntax)


1<?php
2
3$fiber = new Fiber(function (): string {
4    return 'Fiberの結果';
5});
6
7$fiber->start();
8
9$returnValue = $fiber->getReturn();

引数(parameters)

引数なし

引数はありません

戻り値(return)

mixed

Fiber::getReturn() メソッドは、Fiber が正常に完了した際に返された値を返します。Fiber がまだ完了していない場合や、例外によって終了した場合は、未定義となります。

サンプルコード

PHP Fiber::getReturn() で終了値を取得する


1<?php
2
3function create_fiber(): Fiber
4{
5    return new Fiber(function (): mixed {
6        Fiber::suspend('fiber suspended');
7        return 'fiber returned';
8    });
9}
10
11$fiber = create_fiber();
12
13// Fiber を開始し、最初の suspend まで実行
14$fiber->start();
15
16// Fiber が返す値を取得
17$returnValue = $fiber->getReturn();
18
19// 結果を出力
20echo $returnValue . PHP_EOL; // fiber returned

このPHPのサンプルコードは、FiberクラスのgetReturnメソッドの使い方を示しています。Fiberは、PHP 8で導入された軽量な並行処理を可能にする機能です。

まず、create_fiber関数でFiberオブジェクトを生成しています。このFiberオブジェクトは、クロージャ（無名関数）を実行します。クロージャ内では、Fiber::suspendでFiberの実行を一時停止し、文字列 'fiber suspended' を渡しています。その後、return 'fiber returned'; で値を返しています。

次に、生成したFiberオブジェクトのstartメソッドを呼び出し、Fiberの実行を開始します。startメソッドは、Fiberが最初にsuspendされるまで実行されます。

$fiber->getReturn()は、一時停止したFiberが最後に返した値を取得するメソッドです。この例では、Fiberがreturn 'fiber returned';で返した 'fiber returned' が $returnValue に格納されます。

最後に、echo $returnValue . PHP_EOL; で取得した値を標準出力に出力しています。getReturnメソッドは、Fiberが正常に終了した場合のみ値を返します。Fiberがまだ実行中であるか、例外が発生した場合は、Error例外がスローされます。このサンプルコードは、Fiberを利用して非同期処理を行う際の基本的な流れと、getReturnメソッドによる戻り値の取得方法を理解するのに役立ちます。

Fiber::getReturn()は、ファイバーが完了後に返す値を取得するメソッドです。ファイバーがまだ完了していない場合（途中でsuspendされている場合など）は、このメソッドを呼び出すとエラーが発生します。サンプルコードでは、$fiber->start()でファイバーを開始し、Fiber::suspend()で一時停止させているため、その時点ではgetReturn()を呼ぶべきではありません。ファイバーがreturnステートメントを実行して完了した後にのみ、getReturn()を使用するように注意してください。また、ジェネレータ関数内でgetReturn()を使用する際は、ジェネレータが完全に終了していることを確認してから使用してください。