Eine Generatorfunktion sieht genau so aus wie eine normale Funktion mit der Ausnahme, dass ein Generator statt eines Wertes so viele Werte wie nötig zurückgibt (Stichwort: yield).
Wenn eine Generatorfunktion aufgerufen wird, wird ein Objekt zurückgegeben. Wenn Sie über dieses Objekt iterieren (zum Beispiel, via foreach-Schleife), wird PHP die Generatorfunktion so oft aufrufen, wie Werte benötigt werden. Dann wird der Status des Generators gesichert, sodass fortgefahren werden kann, wenn der nächste Wert benötigt wird.
Sobald keine weiteren Werte zurückgegeben werden können, kann die Generatorfunktion einfach beendet werden, und der rufende Code wird fortgesetzt, als gäbe es keine weiteren Werte in einem Array.
Hinweis:
Ein Generator kann keine Werte zurückgeben: macht man dies, wird ein Kompilierungsfehler zurückgegeben. Eine leere return-Anweisung ist eine gültige Syntax innerhalb eines Generators und wird den Generator beenden.
Das Herz einer Generatorfunktion ist das yield-Schlüsselwort. In seiner einfachsten Form sieht das yield-Schlüsselwort wie eine return-Anweisung aus, ausser dass die Ausführung mit der Rückgabe nicht beendet wird, sondern yield stattdessen bei der Schleife über den Generator einen Wert für den Code bereitstellt und solange die Ausführung der Generatorfunktion anhält.
Beispiel #1 Ein einfaches Beispiel zum abliefern (yielding) von Werten
<?php
function generiere_eins_bis_drei() {
for ($i = 1; $i <= 3; $i++) {
// Hinweis: $i bleibt zwischen den yields erhalten.
yield $i;
}
}
$generator = generiere_eins_bis_drei();
foreach ($generator as $wert) {
echo "$wert\n";
}
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
1 2 3
Hinweis:
Intern werden sequentielle Integer-Schlüssel mit den abgelieferten Werten verknüpft, so wie mit einem nicht-assoziativen Array.
Wenn Sie yield in einem Anweisungskontext nutzen (beispielsweise auf der rechten Seite einer Zuweisung), dann müssen Sie die yield-Anweisung in PHP 5 innerhalb von Klammern schreiben. Beispielsweise ist folgender Befehl gültig:
$daten = (yield $wert);
Aber dieser Befehl ist nicht gültig und wird in PHP 5 mit einem Syntaxfehler beendet:
$daten = yield $wert;
Für PHP 7 gilt die Klammerregel nicht.
Diese Syntax kann in Verbindung mit der Generator::send()-Methode verwendet werden.
PHP unterstützt ebenfalls assoziative Arrays, und Generatoren unterscheiden sich nicht davon. Als Ergänzung zum Produzieren einfacher Werte, wie oben gezeigt, können Sie zur gleichen Zeit auch einen Schlüssel abliefern.
Die Syntax für das Produzieren eines Schlüssel/Wert-Paares ist sehr ähnlich wie die Definition von assoziativen Arrays. Siehe unten.
Beispiel #2 Produzieren eines Schlüssel/Wert-Paares
<?php
/*
* Die Eingabe sind Semikolon getrennte Felder, mit dem ersten Feld
* welches als ID und Schlüssel genutzt wird.
*/
$eingabe = <<<'EOF'
1;PHP;mag Dollarzeichen
2;Python;mag Leerzeichen
3;Ruby;mag Blöcke
EOF;
function eingabe_parser($eingabe) {
foreach (explode("\n", $eingabe) as $zeile) {
$felder = explode(';', $zeile);
$id = array_shift($felder);
yield $id => $felder;
}
}
foreach (eingabe_parser($eingabe) as $id => $felder) {
echo "$id:\n";
echo " $felder[0]\n";
echo " $felder[1]\n";
}
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
1:
PHP
mag Dollarzeichen
2:
Python
mag Leerzeichen
3:
Ruby
mag Blöcke
Wie oben mit dem Zurückgeben einfacher Werte gezeigt, muss man beim Produzieren eines Schlüssel/Wert-Paares im Zuweisungskontext den yield-Befehl einklammern:
$daten = (yield $schluessel => $wert);
Yield kann ohne ein Argument aufgerufen werden, um einen NULL-Wert mit
einem automatischen Schlüssel zurückzugeben.
Beispiel #3 Produzieren von NULLs
<?php
function generiere_drei_nulls() {
foreach (range(1, 3) as $i) {
yield;
}
}
var_dump(iterator_to_array(generiere_drei_nulls()));
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
array(3) {
[0]=>
NULL
[1]=>
NULL
[2]=>
NULL
}
Generatorfunktionen sind genauso in der Lage Werte durch Referenzen zurückzugeben, wie durch Werte. Dies kann in gleicher Weise erfolgen, wie beim zurückgeben von Referenzen aus Funktionen: dies geschieht durch Voranstellen eines kaufmännischen Unds zum Funktionsnamen.
Beispiel #4 Produzieren von Werten durch Referenzen
<?php
function &generiere_referenz() {
$wert = 3;
while ($wert > 0) {
yield $wert;
}
}
/*
* Hinweis: wir können $nummer innerhalb der Schleife ändern,
* und weil der Generator Referenzen zurückgibt, wird $wert
* innerhalb von generiere_referenz() verändert.
*/
foreach (generiere_referenz() as &$nummer) {
echo (--$nummer).'... ';
}
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
2... 1... 0...
In PHP 7 ermöglicht die Generatordelegation mittels yield from-Ausdruck Werte von einem anderen Generator, Traversable-Ojekt oder array abliefern zu lassen. Der äußere Generator liefert dann alle Werte vom inneren Generator, Objekt oder Array ab, bis dieser nicht mehr gültig ist und die Ausführung mit dem äußeren Generator fortfährt.
Falls ein Generator mit yield from verwendet wird, gibt der yield from-Ausdruck auch alle Werte zurück, die vom inneren Generator zurückgegeben werden.
Beispiel #5 Grundlegende Verwendung von yield from
<?php
function zaehle_bis_zehn() {
yield 1;
yield 2;
yield from [3, 4];
yield from new ArrayIterator([5, 6]);
yield from sieben_acht();
yield 9;
yield 10;
}
function sieben_acht() {
yield 7;
yield from acht();
}
function acht() {
yield 8;
}
foreach (zaehle_bis_zehn() as $zahl) {
echo "$zahl ";
}
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
1 2 3 4 5 6 7 8 9 10
Beispiel #6 yield from und Rückgabewerte
<?php
function zaehle_bis_zehn() {
yield 1;
yield 2;
yield from [3, 4];
yield from new ArrayIterator([5, 6]);
yield from sieben_acht();
return yield from neun_zehn();
}
function sieben_acht() {
yield 7;
yield from acht();
}
function acht() {
yield 8;
}
function neun_zehn() {
yield 9;
return 10;
}
$gen = zaehle_bis_zehn();
foreach ($gen as $zahl) {
echo "$zahl ";
}
echo $gen->getReturn();
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
1 2 3 4 5 6 7 8 9 10