Return
Simplesmente devolve um valor único ao chamador.
Yield
Transforme a função / método atual para retornar a Generator
, que produzirá mais que um valor único: sempre que yield
acionado, ele atribui o valor ao chamador, um de cada vez, tradicionalmente usando um foreach
loop.
Yield
+ Return
Os geradores, além de gerar valores, também podem fornecer um valor retornado exclusivo. Esse valor não fará parte do loop ao redor do gerador, deve ser acessado usando o Generator::getReturn()
método
Return
+ Yield
Isso pode ser visto como um bug, no entanto, não é.
São duas fases:
- Do código ao bytecode : durante esta fase, a
generate()
função contém a yield
palavra-chave e, portanto, é marcada como produzindo a Generator
.
- Execução : como
return
acontece antes do yield
, o gerador não tem a chance de produzir nenhum valor. No entanto, a [1, 2, 3]
matriz pode ser recuperada com Generator::getReturn()
.
Um exemplo completo anotado:
// Generate integers 1 and 2
function generateIntegers1And2(): Generator {
yield 1; // <--+ <--+ <--+
yield 2; // <-+ <-+ <-+
} // | | |
// | | |
foreach (generateIntegers1And2() as $value) { // | | |
var_dump($value); // Shows 1, then 2 ->* | |
} // | |
// | |
function generateOuterYield(): Generator { // | |
// Yields the generator *itself* returned by | |
// generateIntegers1And2() not the actual values | |
// generated by it. | |
// This means we are producing here a generator | |
// of generator of integers. | |
yield generateIntegers1And2(); // <-+ | |
} // | | |
// | | |
foreach (generateOuterYield() as $value) { // | | |
var_dump($value); // ->* | |
// The two levels of imbrication means we have | |
// to loop once more to actually consume | |
// generateIntegers1And2 | |
foreach ($value as $val) { // | |
var_dump($val); // Shows 1, then 2 ->* |
} // |
} // |
// |
// A generator can just be returned as-is: |
function generateOuterReturn(): Generator { // |
return generateIntegers1And2(); // |
} // |
// |
// it doesn't change the way it is consumed |
foreach (generateOuterReturn() as $value) { // |
var_dump($value); // Shows 1, then 2 |
} // |
// |
function generateOuterYieldFrom(): Generator { // |
// First yield values generated by generateIntegers1And2() |
yield from generateIntegers1And2(); // *<---+
// then yield integers 3 |
yield 3; // <--+
// and 4 |
yield 4; // <-+
} // |
// |
foreach (generateOuterYieldFrom() as $value) { // |
var_dump($value); // Shows 1, 2, 3 and 4 ->*
}
function generateIntegers56AndReturn(): Generator {
yield 5; // <---+
yield 6; // <--+
// |
return ["five", "six"]; // <--+ |
} // | |
// | |
$gen = generateIntegers56AndReturn(); // | |
// | |
// Consume the values **yielded** by | |
// generateIntegers56AndReturn() | |
foreach ($gen as $value) { // | |
var_dump($value); // Shows 5, then 6 | ->*
} // |
// |
// Access the value **returned** by the generator |
var_dump($gen->getReturn()); // ->*
function wtf(): Generator {
return ["W", "T", "F", "!"];
// Without the following line, PHP would complain with a TypeError:
// Return value of wtf() must be an instance of Generator, array returned.
// The presence of a yield keyword anywhere inside the function makes it a Generator.
// However, since we return *before* reaching any *yield*, 42 is never yielded.
// This is empty generator!
yield 42;
}
$gen = wtf();
// This foreach loop is not entered!
foreach ($gen as $value) {
var_dump($value);
}
// However, we can loop on the array *returned* by wtf():
foreach ($gen->getReturn() as $value) {
echo $value; // Will print: WTF!
}
var_dump(generate()->GetReturn());