CKTIS / PHP
Generator::getReturn — wartość zwracana przez generator
Odczytaj końcowy wynik generatora po jego normalnym zakończeniu. Wartość zwrócona przez `return` jest oddzielna od elementów przekazywanych przez `yield`.
Wersja: PHP 8.3
Składnia
public function Generator::getReturn(): mixedGenerator::getReturn jest publiczną metodą instancji wbudowanej klasy \Generator, dostępną od PHP 7.0. Nie wymaga żadnego opcjonalnego rozszerzenia. Wywołaj ją bez argumentów jako $generator->getReturn(). Wywołanie funkcji generatora zwraca obiekt \Generator; typ mixed w pokazanej sygnaturze metody dla PHP 8.3 dotyczy końcowej wartości generatora, a nie typu tego obiektu.
yield przekazuje element do iteracji i wstrzymuje wykonywanie generatora. return kończy jego działanie, a zwrócona wartość nie staje się kolejnym elementem foreach. Po pełnym przejściu pętli odczytaj wynik z tego samego obiektu. Samo odebranie ostatniego elementu nie wystarcza: break może pozostawić generator wstrzymany na yield, a wywołanie metody w tym stanie zgłasza \Exception.
Jeśli generator zakończy się normalnie bez zwrócenia wartości, metoda zwróci null. Jeśli jego wykonanie przerwie nieprzechwycony wyjątek, nie ma wyniku do odczytania, a późniejsze wywołanie getReturn() zgłosi \Exception. Przy delegowaniu do innego generatora wyrażenie yield from przekazuje jego elementy i przyjmuje jego wartość końcową. Generator zewnętrzny może ją zwrócić jako własną, używając return yield from $inner;.
Przykłady
<?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";
Wynik
item: 4 item: 7 total: 11
`foreach` wypisuje odczyty `4` i `7`. Dopiero po pętli `getReturn()` udostępnia sumę `11`, która nie jest elementem iteracji.
Powiązane lekcje
- PHP · Lekcja 59 · Zaawansowany · Wersja: 2