CKTIS / PHP
Generator::getReturn — Rückgabewert eines Generators auslesen
Lies das Endergebnis eines Generators nach seinem regulären Abschluss aus. Der Wert aus `return` ist von den mit `yield` gelieferten Elementen getrennt.
Version: PHP 8.3
Syntax
public function Generator::getReturn(): mixedGenerator::getReturn ist eine öffentliche Instanzmethode der eingebauten Klasse \Generator und seit PHP 7.0 verfügbar. Sie benötigt keine optionale Erweiterung. Rufe sie ohne Argumente als $generator->getReturn() auf. Der Aufruf einer Generatorfunktion liefert ein \Generator-Objekt. Der Rückgabetyp mixed in der gezeigten Signatur für PHP 8.3 bezieht sich auf den Endwert des Generators, nicht auf den Typ dieses Objekts.
yield liefert ein Element für die Iteration und hält die Ausführung an. return beendet den Generator; sein Wert wird nicht zu einem weiteren foreach-Element. Lies nach dem vollständigen Durchlauf der Schleife das Ergebnis aus demselben Objekt aus. Das letzte Element zu erhalten reicht nicht: Ein break kann den Generator an einem yield angehalten lassen. Ein Methodenaufruf in diesem Zustand löst eine \Exception aus.
Endet der Generator regulär, ohne einen Wert zurückzugeben, liefert die Methode null. Beendet eine nicht abgefangene Ausnahme den Generator, gibt es kein Ergebnis; ein späterer Aufruf von getReturn() löst eine \Exception aus. Bei der Delegation an einen anderen Generator reicht yield from dessen Elemente weiter und ergibt dessen Endwert. Der äußere Generator kann diesen mit return yield from $inner; als eigenen Wert zurückgeben.
Beispiele
<?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";
Ergebnis
item: 4 item: 7 total: 11
`foreach` gibt die Messwerte `4` und `7` aus. Erst nach der Schleife liefert `getReturn()` die Summe `11`, die kein Element der Iteration ist.
Zugehörige Lektionen
- PHP · Lektion 59 · Fortgeschritten · Version: 2