В PHP: в чем разница между «return», «yield», «yield from» и смешиванием и доходности, и возврата в одной и той же функции?

Question

Разница между return и yield казалась очевидной, пока я не выяснил, что есть также yield from и возможность комбинировать return и yield в одной и той же функции!

Мое понимание return заключалось в том, что все после было не выполнено, верно?

Однако:

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

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

Производит: "123"

Но следующее:

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

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

Ничего не производит! Таким образом, это означает, что доходность выполнена?

Это ошибка?

Answer 1

Return

Просто возвращает уникальное значение вызывающей стороне.

Yield

Преобразование текущей функции / метода для возврата Generator, который будет давать больше, чем уникальное значение: каждый раз, когда срабатывает yield, он выдает значение вызывающей стороне, по одному за раз, традиционно используя foreach l oop.

Yield + Return

Генераторы, кроме генерации значений, могут также предоставлять уникальное возвращаемое значение. Это значение не будет частью цикла вокруг генератора, к нему нужно обращаться, используя метод Generator::getReturn().

Return + Yield

This может рассматриваться как ошибка, однако это не так.

Это две фазы:

1. От кода к байт-коду : во время этой фазы * Функция 1036 * содержит ключевое слово yield, поэтому помечается как производящая Generator.
2. Выполнение : поскольку return предшествует yield у генератора нет возможности произвести какое-либо значение. Однако массив [1, 2, 3] можно получить с помощью Generator::getReturn().

Полный аннотированный пример:

// 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!
}

Answer 2

Из документации :

Любая функция, содержащая yield, является функцией генератора.

Так что не имеет значения, является ли yield выполняется, анализатор видит его где-то в определении функции и превращает его в генератор.

Если функция никогда не выполняет инструкцию yield, то генератор не выдает никаких значений. Значение, возвращаемое return, игнорируется при попытке использовать результат. Документация гласит:

Примечание:
В PHP 5 генератор не может вернуть значение: это может привести к ошибке компиляции. Пустой оператор return был допустимым синтаксисом в генераторе, и он завершал работу генератора. Начиная с PHP 7.0, генератор может возвращать значения, которые можно получить с помощью Generator :: getReturn () .

Таким образом, вы можете сделать:

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