No PHP: qual é a diferença entre "return", "yield", "yield from" e misturar yield e return na mesma função?

10

A diferença entre returne yieldparecia clara até que eu descobri que havia também yield frome a possibilidade de combinar as duas returne yieldna mesma função!

Meu entendimento returnera de que tudo o que havia depois não foi executado, certo?

Contudo:

function generate(): iterable {
    return [1, 2, 3];
}

foreach (generate() as $value) {
    echo $value;
}

Produz: "123"

Mas o seguinte:

function generate(): iterable {
    return [1, 2, 3];
    yield;
}

foreach (generate() as $value) {
    echo $value;
}

Não produz nada! Então isso significa que o rendimento é executado?

Isso é um inseto?


fonte
11
var_dump(generate()->GetReturn());
AbraCadaver 14/02

Respostas:

10

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 yieldacionado, ele atribui o valor ao chamador, um de cada vez, tradicionalmente usando um foreachloop.

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:

  1. Do código ao bytecode : durante esta fase, a generate()função contém a yieldpalavra-chave e, portanto, é marcada como produzindo a Generator.
  2. Execução : como returnacontece 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!
}

fonte
11
O último exemplo, o retorno "encerra" a execução da função, ou seja, o código não atinge o campo.
Rodrigo Jarouche
5

A partir da documentação :

Qualquer função que contenha yieldé uma função geradora.

Portanto, não importa se o yieldarquivo é executado, o analisador o vê em algum lugar na definição da função e o transforma em um gerador.

Se a função nunca executar a yieldinstrução, o gerador não produzirá nenhum valor. O valor retornado por returné ignorado quando você tenta usar o resultado. A documentação diz:

Nota:
No PHP 5, um gerador não pôde retornar um valor: isso resultaria em um erro de compilação. Uma returndeclaração vazia era uma sintaxe válida dentro de um gerador e encerraria o gerador. Desde o PHP 7.0, um gerador pode retornar valores, que podem ser recuperados usando Generator :: getReturn () .

Então você poderia fazer:

$gen = generate();
foreach ($gen as $value) {
    echo $value;
}
print_r($gen->getReturn());
Barmar
fonte