Generator syntax

A generator function looks just like a normal function, except that instead of returning a value, a generator yields as many values as it needs to.

When a generator function is called, it returns an object that can be iterated over. When you iterate over that object (for instance, via a foreach loop), PHP will call the generator function each time it needs a value, then saves the state of the generator when the generator yields a value so that it can be resumed when the next value is required.

Once there are no more values to be yielded, then the generator function can simply exit, and the calling code continues just as if an array has run out of values.

Замечание:

A generator cannot return a value: doing so will result in a compile error. An empty return statement is valid syntax within a generator and it will terminate the generator.

yield keyword

The heart of a generator function is the yield keyword. In its simplest form, a yield statement looks much like a return statement, except that instead of stopping execution of the function and returning, yield instead provides a value to the code looping over the generator and pauses execution of the generator function.

Пример #1 A simple example of yielding values

<?php
function gen_one_to_three() {
    for (
$i 1$i <= 3$i++) {
        
// Note that $i is preserved between yields.
        
yield $i;
    }
}

$generator gen_one_to_three();
foreach (
$generator as $value) {
    echo 
"$value\n";
}
?>

Результат выполнения данного примера:

1
2
3

Замечание:

Internally, sequential integer keys will be paired with the yielded values, just as with a non-associative array.

Предостережение

If you use yield in an expression context (for example, on the right hand side of an assignment), you must surround the yield statement with parentheses. For example, this is valid:

$data = (yield $value);

But this is not, and will result in a parse error:

$data = yield $value;

This syntax may be used in conjunction with the Generator::send() method.

Yielding values with keys

PHP also supports associative arrays, and generators are no different. In addition to yielding simple values, as shown above, you can also yield a key at the same time.

The syntax for yielding a key/value pair is very similar to that used to define an associative array, as shown below.

Пример #2 Yielding a key/value pair

<?php
/*
 * The input is semi-colon separated fields, with the first
 * field being an ID to use as a key.
 */

$input = <<<'EOF'
1;PHP;Likes dollar signs
2;Python;Likes whitespace
3;Ruby;Likes blocks
EOF;

function 
input_parser($input) {
    foreach (
explode("\n"$input) as $line) {
        
$fields explode(';'$line);
        
$id array_shift($fields);

        yield 
$id => $fields;
    }
}

foreach (
input_parser($input) as $id => $fields) {
    echo 
"$id:\n";
    echo 
"    $fields[0]\n";
    echo 
"    $fields[1]\n";
}
?>

Результат выполнения данного примера:

1:
    PHP
    Likes dollar signs
2:
    Python
    Likes whitespace
3:
    Ruby
    Likes blocks
Предостережение

As with the simple value yields shown earlier, yielding a key/value pair in an expression context requires the yield statement to be parenthesised:

$data = (yield $key => $value);

Yielding null values

Yield can be called without an argument to yield a NULL value with an automatic key.

Пример #3 Yielding NULLs

<?php
function gen_three_nulls() {
    foreach (
range(13) as $i) {
        yield;
    }
}

var_dump(iterator_to_array(gen_three_nulls()));
?>

Результат выполнения данного примера:

array(3) {
  [0]=>
  NULL
  [1]=>
  NULL
  [2]=>
  NULL
}

Yielding by reference

Generator functions are able to yield values by reference as well as by value. This is done in the same way as returning references from functions: by prepending an ampersand to the function name.

Пример #4 Yielding values by reference

<?php
function &gen_reference() {
    
$value 3;

    while (
$value 0) {
        yield 
$value;
    }
}

/*
 * Note that we can change $number within the loop, and
 * because the generator is yielding references, $value
 * within gen_reference() changes.
 */
foreach (gen_reference() as &$number) {
    echo (--
$number).'... ';
}
?>

Результат выполнения данного примера:

2... 1... 0... 

Generator objects

When a generator function is called for the first time, an object of the internal Generator class is returned. This object implements the Iterator interface in much the same way as a forward-only iterator object would.

Коментарии

For example yield keyword with Fibonacci:

function getFibonacci()
{
    $i = 0;
    $k = 1; //first fibonacci value
    yield $k;
    while(true)
    {
        $k = $i + $k;
        $i = $k - $i;
        yield $k;       
    }
}

$y = 0;

foreach(getFibonacci() as $fibonacci)
{
    echo $fibonacci . "\n";
    $y++;   
    if($y > 30)
    {
        break; // infinite loop prevent
    }
}
2013-04-18 12:02:52
http://php5.kiev.ua/manual/ru/language.generators.syntax.html
Автор:
This is little example of using generators with recursion. Used version of php is 5.5.5
[php]
<?php
define 
("DS"DIRECTORY_SEPARATOR);
define ("ZERO_DEPTH"0);
define ("DEPTHLESS", -1);
define ("OPEN_SUCCESS"True);
define ("END_OF_LIST"False);
define ("CURRENT_DIR"".");
define ("PARENT_DIR""..");

function 
DirTreeTraversal($DirName$MaxDepth DEPTHLESS$CurrDepth ZERO_DEPTH)
{
  if ((
$MaxDepth === DEPTHLESS) || ($CurrDepth $MaxDepth)) { 
   
$DirHandle opendir($DirName);
    if (
$DirHandle !== OPEN_SUCCESS) { 
      try{
        while ((
$FileName readdir($DirHandle)) !== END_OF_LIST) { //read all file in directory
         
if (($FileName != CURRENT_DIR) && ($FileName != PARENT_DIR)) {
           
$FullName $DirName.$FileName;
           
yield $FullName;
            if(
is_dir($FullName)) { //include sub files and directories
             
$SubTrav DirTreeTraversal($FullName.DS$MaxDepth, ($CurrDepth 1));
              foreach(
$SubTrav as $SubItemyield $SubItem;
            }
          }
        }
      } 
finally {
       
closedir($DirHandle);
      }
    }
  }
}

$PathTrav DirTreeTraversal("C:".DS2);
print 
"<pre>";
foreach(
$PathTrav as $FileNameprintf("%s\n"$FileName);
print 
"</pre>";
[/
php]
2013-11-08 09:46:23
http://php5.kiev.ua/manual/ru/language.generators.syntax.html
Note that you can't use count() on generators.

/**
 * @return integer[]
 */
function xrange() {
    for ($a = 0; $a < 10; $a++)
    {
        yield $a;
    }
}

function mycount(Traversable $traversable)
{
    $skip = 0;
    foreach($traversable as $skip)
    {
        $skip++;
    }
    return $skip;
}
echo "Count:" . count(xrange()). PHP_EOL;
echo "Count:" . mycount(xrange()). PHP_EOL;
2014-04-13 13:46:39
http://php5.kiev.ua/manual/ru/language.generators.syntax.html
<?php
//Example of class implementing IteratorAggregate using generator

class ValueCollection implements IteratorAggregate
{
    private 
$items = array();
   
    public function 
addValue($item)
    {
       
$this->items[] = $item;
        return 
$this;
    }
   
    public function 
getIterator()
    {
        foreach (
$this->items as $item) {
           
yield $item;
        }
    }
}

//Initializes a collection
$collection = new ValueCollection();
$collection
       
->addValue('A string')
        ->
addValue(new stdClass())
        ->
addValue(NULL);

foreach (
$collection as $item) {
   
var_dump($item);
}
2014-09-11 19:43:48
http://php5.kiev.ua/manual/ru/language.generators.syntax.html
Another Fibonacci sequence with yield keyword:

<?php

function getFibonacci($first$second$total) {
 
yield $first;
 
yield $second;
  for (
$i 1$total -= 2$i <= $total$i++) {
   
$sum $first $second;
   
$first $second;
   
$second $sum;
   
yield $sum;
  }
}

// Generate first 10 numbers of the Fibonacci sequence starting from 0, 1
foreach (getFibonacci(0110) as $fibonacci) {
 
// 0 1 1 2 3 5 8 13 21 34
 
echo $fibonacci " "
}

?>
2014-10-05 23:31:52
http://php5.kiev.ua/manual/ru/language.generators.syntax.html
[This comment replaces my previous comment]

You can use generators to do lazy loading of lists. You only compute the items that are actually used. However, when you want to load more items, how to cache the ones already loaded?

Here is how to do cached lazy loading with a generator:

<?php
class CachedGenerator {
    protected 
$cache = [];
    protected 
$generator null;

    public function 
__construct($generator) {
       
$this->generator $generator;
    }

    public function 
generator() {
        foreach(
$this->cache as $itemyield $item;

        while( 
$this->generator->valid() ) {
           
$this->cache[] = $current $this->generator->current();
           
$this->generator->next();
           
yield $current;
        }
    }
}
class 
Foobar {
    protected 
$loader null;

    protected function 
loadItems() {
        foreach(
range(0,10) as $i) {
           
usleep(200000);
           
yield $i;
        }
    }

    public function 
getItems() {
       
$this->loader $this->loader ?: new CachedGenerator($this->loadItems());
        return 
$this->loader->generator();
    }
}

$f = new Foobar;

# First
print "First\n";
foreach(
$f->getItems() as $i) {
    print 
$i "\n";
    if( 
$i == ) {
        break;
    }
}

# Second (items 1-5 are cached, 6-10 are loaded)
print "Second\n";
foreach(
$f->getItems() as $i) {
    print 
$i "\n";
}

# Third (all items are cached and returned instantly)
print "Third\n";
foreach(
$f->getItems() as $i) {
    print 
$i "\n";
}
?>
2015-01-23 21:02:58
http://php5.kiev.ua/manual/ru/language.generators.syntax.html
That is a simple fibonacci generator.

<?php
function fibonacci($item) {
   
$a 0;
   
$b 1;
    for (
$i 0$i $item$i++) {
       
yield $a;
       
$a $b $a;
       
$b $a $b;
    }
}

# give me the first ten fibonacci numbers
$fibo fibonacci(10);
foreach (
$fibo as $value) {
    echo 
"$value\n";
}
?>
2015-06-12 17:43:11
http://php5.kiev.ua/manual/ru/language.generators.syntax.html
Do not call generator functions directly, that won't work.

<?php

function my_transform($value) {
   
var_dump($value);
    return 
$value 2;
}

function 
my_function(array $values) {
    foreach (
$values as $value) {
       
yield my_transform($value);
    }
}

$data = [1510];
// my_transform() won't be called inside my_function()
my_function($data);

# my_transform() will be called.
foreach (my_function($data) as $val) {
   
// ...
}
?>
2015-11-16 11:18:10
http://php5.kiev.ua/manual/ru/language.generators.syntax.html
Автор:
If for some strange reason you need a generator that doesn't yield anything, an empty function doesn't work; the function needs a yield statement to be recognised as a generator.

<?php

function gndn()
{
}

foreach(
gndn() as $it)
{
    echo 
'FNORD';
}

?>

 But it's enough to have the yield syntactically present even if it's not reachable:

<?php

function gndn()
{
    if(
false) { yield; }
}

foreach(
gndn() as $it)
{
    echo 
'FNORD';
}

?>
2015-12-21 11:14:33
http://php5.kiev.ua/manual/ru/language.generators.syntax.html

    Поддержать сайт на родительском проекте КГБ