WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / PHP

Generator

Ein Generatoraufruf erzeugt einen angehaltenen Iterator.

Version: PHP 8.4; repository runtime, production runtime not attested

Syntax

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

Ein Generatoraufruf erzeugt einen angehaltenen Iterator. Beim Weiterschalten setzt die Ausführung nach yield fort. Der return-Wert ist von den ausgegebenen Elementen getrennt. getReturn gelingt nach normalem Ende und ergibt bei Durchlaufen bis zum Ende null. Vor dem Abschluss oder nach Abbruch durch eine Ausnahme wirft es Exception. Ein erschöpfter Generator lässt sich im Allgemeinen nicht erneut durchlaufen. Nach Verbrauch beider Werte liest Generator::getReturn die 5 aus der return-Anweisung des Generators.

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"]

Beispiele

<?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]);

Ergebnis

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

Quellen