Generator::getReturn

(PHP 7, PHP 8)

Generator::getReturn — ジェネレータの戻り値を取得する

説明

public Generator::getReturn(): mixed

パラメータ

この関数にはパラメータはありません。

戻り値

ジェネレータの実行が終了すると、その戻り値を返します。

例

例1 Generator::getReturn() の例

<?php

$gen = (function() {
    yield 1;
    yield 2;

    return 3;
})();

foreach ($gen as $val) {
    echo $val, PHP_EOL;
}

echo $gen->getReturn(), PHP_EOL;

上の例の出力は以下となります。

1
2
3