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

CKTIS / PHP

Generator

Chamar uma função geradora cria um iterador suspenso.

Versão: PHP 8.4; repository runtime, production runtime not attested

Sintaxe

function sequence(): Generator { yield $value; }

Chamar uma função geradora cria um iterador suspenso. Avançar retoma a execução após yield. O resultado de return está separado dos elementos produzidos. getReturn funciona após a conclusão normal e dá null ao chegar ao fim do corpo. Antes da conclusão ou após interrupção por exceção lança Exception. Em geral um gerador esgotado não pode ser rebobinado e reutilizado. Depois de consumir ambos os valores, Generator::getReturn lê o 5 do return do gerador.

function sequence(): Generator { yield "a"=>2; yield "b"=>3; return 5; }
$g=sequence(); $items=iterator_to_array($g); echo json_encode([$items,$g->getReturn(),$g->valid()]);
function aborted(): Generator { yield 1; throw new RuntimeException("stopped"); }
$bad=aborted(); try{$bad->getReturn();}catch(Exception $e){$early=get_class($e);} try{iterator_to_array($bad);}catch(RuntimeException $e){}
try{$bad->getReturn();}catch(Exception $e){$late=get_class($e);} echo PHP_EOL,json_encode([$early,$late]);
[{"a":2,"b":3},5,false]
["Exception","Exception"]

Exemplos

<?php
function sequence(): Generator { yield "a"=>2; yield "b"=>3; return 5; }
$g=sequence(); $items=iterator_to_array($g); echo json_encode([$items,$g->getReturn(),$g->valid()]);
function aborted(): Generator { yield 1; throw new RuntimeException("stopped"); }
$bad=aborted(); try{$bad->getReturn();}catch(Exception $e){$early=get_class($e);} try{iterator_to_array($bad);}catch(RuntimeException $e){}
try{$bad->getReturn();}catch(Exception $e){$late=get_class($e);} echo PHP_EOL,json_encode([$early,$late]);

Resultado

[{"a":2,"b":3},5,false]
["Exception","Exception"]

Fontes