一个生成器函数看上去和普通函数一样, 不同之处在于生成器会按需产出多个值而不是返回一个值.
当生成器函数被调用的时候,会返回一个可以迭代的对象. 当你迭代那个对象的时候 (例如, 通过foreach循环), 每当需要一个值的时候,PHP都会调用生成器函数, 然后当生成器产出一个值的时候会保存生成器的状态,以便下一个值需要的时候可以恢复.
如果没有更多值产出, 生成器函数可以简单退出, 调用代码会继续就好像一个数组用完所有值一样.
Note:
生成器不能返回值: 这样做会导致编译错误. 在生成器中空的返回语句是有效的语法并且会中断该生成器.
yield 关键字
生成器函数的核心就是 yield 关键字. 在最简单的形式中, 一个 yield 语句看上去非常像一个return语句, 不同之处在于yield提供一个值给查看生成器的代码然后暂停生成器的执行,而不是返回一个值之后停止执行.
Example #1 产出值的简单示例
<?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
Note:
在内部, 序列化的整型键将会个产出值配对, 正如非关联数组一样.
Caution如果你在上下文表达式中使用 yield (例如, 在等号右边的赋值语句中), 一定要使用括号括起来.例如, 下面的代码是正确的:
$data = (yield $value);
但是下面的代码会出现解析错误:
$data = yield $value;
在生成器对象中这个语法可能会和send() 方法一起使用.
使用key获取值
PHP支持关联数组, 生成器也一样. 除了生成简单的值, 正如上面所示,你还可以同时生成键.
生成 key/value 对的语法非常简单,可以用来定义关联数组, 如下所示.
Example #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
Caution和早期的生成简单值一样, 在一个上下文表达式中生成 key/value 对需要 yield 语句被括号括起来:
$data = (yield $key => $value);
生成null值
Yield 可以进行无参数调用来使用自动产生的键生成NULL值.
Example #3 Yielding NULLs
<?php function gen_three_nulls() { foreach (range(1, 3) as $i) { yield; } } var_dump(iterator_to_array(gen_three_nulls())); ?>
以上例程会输出:
array(3) { [0]=>NULL [1]=>NULL [2]=>NULL }
通过引用产生值
生成器函数可以通过引用产生值. 这和returning references from functions中的做法一样: 通过在函数名前加&来实现.
Example #4 Yielding values by reference
<?php function &gen_reference() { $value = 3; while ($value > 0) { yield $value; } } /* 注意我们可以在循环中改变$number * because the generator is yielding references, $value * within gen_reference() changes. */ foreach (gen_reference() as &$number) { echo (--$number).'... '; } ?>
以上例程会输出:
2... 1... 0...
已抢186497个
抢已抢67279个
抢已抢352975个
抢已抢667160个
抢已抢122300个
抢已抢23430个
抢