CKTIS / PHP
Generator::getReturn — de retourwaarde van een generator uitlezen
Lees het eindresultaat van een generator nadat deze normaal is afgelopen. De waarde van `return` staat los van de elementen die `yield` oplevert.
Versie: PHP 8.3
Syntax
public function Generator::getReturn(): mixedGenerator::getReturn is een openbare instantiemethode van de ingebouwde klasse \Generator en is beschikbaar sinds PHP 7.0. Er is geen optionele extensie nodig. Roep de methode zonder argumenten aan met $generator->getReturn(). Een aanroep van een generatorfunctie levert een \Generator-object op. Het retourtype mixed in de getoonde signatuur voor PHP 8.3 beschrijft de eindwaarde van de generator, niet het type van dat object.
yield levert een element voor de iteratie en pauzeert de uitvoering. return beëindigt de generator; de retourwaarde is geen extra element in foreach. Lees het resultaat uit hetzelfde object nadat de lus volledig is doorlopen. Het laatste element ontvangen is niet genoeg: een break kan de generator bij een yield gepauzeerd laten. Een aanroep van de methode in die toestand werpt een \Exception op.
Als de generator normaal eindigt zonder een waarde terug te geven, geeft de methode null terug. Als een niet-afgevangen uitzondering de generator beëindigt, is er geen resultaat en werpt een latere aanroep van getReturn() een \Exception op. Bij delegatie aan een andere generator geeft yield from diens elementen door en levert de expressie diens eindwaarde op. De buitenste generator kan die waarde als eigen resultaat teruggeven met return yield from $inner;.
Voorbeelden
<?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";
Resultaat
item: 4 item: 7 total: 11
`foreach` toont de meetwaarden `4` en `7`. Pas na de lus geeft `getReturn()` het totaal `11` terug, dat geen element van de iteratie is.
Gerelateerde lessen
- PHP · Les 59 · Gevorderd · Versie: 2