Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / PHP

Generator::getReturn — ler o valor devolvido por um gerador

Obtém o resultado final de um gerador depois de este terminar normalmente. O valor de `return` é distinto dos elementos produzidos por `yield`.

Versão: PHP 8.3

Sintaxe

public function Generator::getReturn(): mixed

Generator::getReturn é um método público de instância da classe predefinida \Generator, disponível desde o PHP 7.0. Não requer nenhuma extensão opcional. Chama-o sem argumentos com $generator->getReturn(). A chamada a uma função geradora devolve um objeto \Generator; o tipo de retorno mixed na assinatura apresentada para o PHP 8.3 descreve o valor final do gerador, não o tipo desse objeto.

yield fornece um elemento à iteração e suspende a execução. return termina o gerador, e o seu valor não se torna mais um elemento de foreach. Quando o ciclo chegar ao fim, lê o resultado no mesmo objeto. Receber o último elemento não basta: um break pode deixar o gerador suspenso num yield, e chamar o método nesse estado lança uma \Exception.

Se o gerador terminar normalmente sem devolver um valor, o método devolve null. Se uma exceção não capturada terminar o gerador, não há resultado para ler, e uma chamada posterior a getReturn() lança uma \Exception. Ao delegar noutro gerador, yield from transmite os elementos desse gerador e tem como valor o seu resultado final. O gerador exterior pode devolvê-lo como seu com return yield from $inner;.

Exemplos

<?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` escreve as leituras `4` e `7`. Só depois do ciclo é que `getReturn()` fornece o total `11`, que não é um elemento da iteração.

Lições relacionadas

  • PHP · Lição 59 · Avançado · Versão: 2

Fontes