CKTIS / PHP
Generator::getReturn — leer el valor de retorno de un generador
Recupera el resultado final de un generador tras su finalización normal. El valor de `return` es independiente de los elementos producidos por `yield`.
Versión: PHP 8.3
Sintaxis
public function Generator::getReturn(): mixedGenerator::getReturn es un método público de instancia de la clase integrada \Generator, disponible desde PHP 7.0. No requiere ninguna extensión opcional. Llámalo sin argumentos con $generator->getReturn(). Llamar a una función generadora devuelve un objeto \Generator; el tipo de retorno mixed de la firma que se muestra para PHP 8.3 describe el valor final del generador, no el tipo de ese objeto.
yield entrega un elemento a la iteración y pausa la ejecución. return termina el generador y su valor no se convierte en otro elemento de foreach. Cuando el bucle llegue al final, lee el resultado en el mismo objeto. Recibir el último elemento no basta: un break puede dejar el generador pausado en un yield, y llamar al método en ese estado lanza una \Exception.
Si el generador termina normalmente sin devolver un valor, el método devuelve null. Si una excepción no capturada termina el generador, no hay resultado que leer y una llamada posterior a getReturn() lanza una \Exception. Al delegar en otro generador, yield from transmite sus elementos y su valor como expresión es el resultado final del generador delegado. El generador externo puede devolverlo como propio con return yield from $inner;.
Ejemplos
<?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";
Resultado
item: 4 item: 7 total: 11
`foreach` imprime las lecturas `4` y `7`. Solo después del bucle, `getReturn()` proporciona el total `11`, que no es un elemento de la iteración.
Lecciones relacionadas
- PHP · Lección 59 · Avanzado · Versión: 2