CKTIS / PHP
Generator::getReturn — získání návratové hodnoty generátoru
Získejte konečný výsledek po řádném dokončení generátoru. Návratová hodnota z `return` je oddělená od položek poskytovaných pomocí `yield`.
Verze: PHP 8.3
Syntaxe
public function Generator::getReturn(): mixedGenerator::getReturn je veřejná instanční metoda vestavěné třídy \Generator, dostupná od PHP 7.0. Nevyžaduje žádné volitelné rozšíření. Volejte ji bez argumentů jako $generator->getReturn(). Volání generátorové funkce vrací objekt \Generator; návratový typ mixed v uvedené signatuře pro PHP 8.3 popisuje konečnou hodnotu generátoru, nikoli typ tohoto objektu.
yield předá položku do iterace a pozastaví provádění generátoru. return generátor ukončí a jeho hodnota se nestane další položkou v foreach. Po úplném průchodu cyklem přečtěte výsledek ze stejného objektu. Získat poslední položku nestačí: break může nechat generátor pozastavený na yield a volání metody v tomto stavu vyvolá \Exception.
Pokud generátor řádně skončí bez vrácení hodnoty, metoda vrátí null. Jestliže generátor ukončí nezachycená výjimka, žádný výsledek není k dispozici a pozdější volání getReturn() vyvolá \Exception. Při delegování na jiný generátor předává yield from jeho položky dál a hodnotou výrazu je jeho konečný výsledek. Vnější generátor ho může vrátit jako vlastní pomocí return yield from $inner;.
Příklady
<?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";
Výsledek
item: 4 item: 7 total: 11
`foreach` vypíše naměřené hodnoty `4` a `7`. Až po skončení cyklu vrátí `getReturn()` součet `11`, který není položkou iterace.
Související lekce
- PHP · Lekce 59 · Pokročilá · Verze: 2