База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / PHP

Generator::getReturn — прочитане на върнатата стойност на генератор

Прочетете крайния резултат след нормалното приключване на генератора. Стойността от `return` е отделна от елементите, подавани чрез `yield`.

Версия: PHP 8.3

Синтаксис

public function Generator::getReturn(): mixed

Generator::getReturn е публичен метод на екземпляр на вградения клас \Generator, достъпен от PHP 7.0. Методът не изисква допълнително разширение. Извикайте го без аргументи чрез $generator->getReturn(). Извикването на генераторна функция връща обект \Generator; типът mixed в показаната сигнатура за PHP 8.3 описва крайната стойност на генератора, а не типа на този обект.

yield подава елемент за обхождане и временно спира изпълнението. return приключва генератора и стойността му не става пореден елемент в foreach. След като цикълът завърши докрай, прочетете резултата от същия обект. Получаването на последния елемент не е достатъчно: break може да остави генератора спрян на yield, а извикването на метода в това състояние хвърля \Exception.

Ако генераторът приключи нормално, без да върне стойност, методът връща null. Ако необработено изключение прекрати генератора, няма резултат за прочитане и по-късно извикване на getReturn() хвърля \Exception. При делегиране към друг генератор yield from препраща неговите елементи, а стойността на израза е крайният му резултат. Външният генератор може да върне тази стойност като свой резултат чрез return yield from $inner;.

Примери

<?php

function readings(): \Generator
{
    $total = 0;
    foreach ([4, 7] as $reading) {
        $total += $reading;
        yield $reading;
    }

    return $total;
}

$generator = readings();
foreach ($generator as $reading) {
    echo 'item: ', $reading, "\n";
}
echo 'total: ', $generator->getReturn(), "\n";

Резултат

item: 4
item: 7
total: 11

`foreach` извежда измерените стойности `4` и `7`. Едва след цикъла `getReturn()` връща сумата `11`, която не е елемент от обхождането.

Свързани уроци

  • PHP · Урок 59 · Напреднало · Версия: 2

Източници