PHP Conference Japan 2024

Generator::send

(PHP 5 >= 5.5.0, PHP 7, PHP 8)

Generator::send向生成器发送值

描述

public Generator::send(混合 $value): 混合

将给定的值作为当前 yield 表达式的结果发送到生成器,并恢复生成器的执行。

如果调用此方法时生成器不在 yield 表达式处,它将首先被推进到第一个 yield 表达式,然后再发送值。因此,无需使用 Generator::next() 调用(如在 Python 中那样)来“启动”PHP 生成器。

参数

value

发送到生成器的值。此值将是生成器当前所在的 yield 表达式的返回值。

返回值

返回生成的 yield 值。

示例

示例 #1 使用 Generator::send() 注入值

<?php
function printer() {
echo
"I'm printer!".PHP_EOL;
while (
true) {
$string = yield;
echo
$string.PHP_EOL;
}
}

$printer = printer();
$printer->send('Hello world!');
$printer->send('Bye world!');
?>

以上示例将输出

I'm printer!
Hello world!
Bye world!

添加笔记

用户贡献笔记 5 条笔记

71
sfroelich01 at sp dot gm dot ail dot am dot com
11 年前
阅读示例时,有点难以理解到底该怎么做。下面的示例是一个简单的例子,说明你可以用它做什么。

<?php
function nums() {
for (
$i = 0; $i < 5; ++$i) {
//从调用者获取值
$cmd = (yield $i);

if(
$cmd == 'stop')
return;
//退出函数
}
}

$gen = nums();
foreach(
$gen as $v)
{
if(
$v == 3)//我们满意了
$gen->send('stop');

echo
"{$v}\n";
}

//输出
0
1
2
3
?>
9
php at didatus dot de
3 年前
如果你想在 foreach 循环中使用 generator::send(),你很可能会得到一个意外的结果。Generator::send() 方法恢复生成器,这意味着生成器中的指针将移动到生成器列表中的下一个元素。

这是一个例子

<?php

class ApiDummy
{
private static
$apiDummyData = ['a', 'b', 'c', 'd', 'e'];

public static function
getAll(): Generator {
foreach (
self::$apiDummyData as $entry) {
echo
'yielding $elem' . PHP_EOL;
$newElem = (yield $entry);
echo
'yield return: ' . $newElem . PHP_EOL;
}
}
}

$generator = ApiDummy::getAll();

// 使用 foreach 循环的第一个示例,结果不符合预期
foreach ($generator as $elem) {
echo
'value from generator: ' . $elem . PHP_EOL;
$generator->send($elem . '+');
}

// 使用 while 循环的第二个示例,结果符合预期
while ($generator->valid()) {
$elem = $generator->current();
echo
'value from generator: ' . $elem . PHP_EOL;
$generator->send($elem . '+');
}
?>

第一个示例的结果
yielding $elem
value from generator: a
yield return: a+
yielding $elem
yield return
yielding $elem
value from generator: c
yield return: c+
yielding $elem
yield return
yielding $elem
value from generator: e
yield return: e+

正如你所看到的,b 和 d 没有被打印出来,也没有加上 + 号。
foreach 循环接收第一个 yield,send 调用在第一个循环内导致第二个 yield。因此,第二个循环已经接收了第三个 yield,以此类推。

为了避免这种情况,一种解决方案是使用 while 循环和 Generator::send() 方法来移动生成器游标,以及 Generator::current() 方法来检索当前值。可以使用 Generator::valid() 方法控制循环,如果生成器已完成,则返回 false。参见示例迭代二。

示例迭代二的预期结果
yielding $elem
value from generator: a
yield return: a+
yielding $elem
生成器值:b
yield 返回:b+
yielding $elem
value from generator: c
yield return: c+
yielding $elem
生成器值:d
yield 返回:d+
yielding $elem
value from generator: e
yield return: e+
4
example dot com 的匿名用户
5年前
从 7.3 版本开始,生成器在 foreach 循环中的行为取决于它是否期望接收数据。如果您遇到“跳过”问题,这一点很重要。

<?php
class X implements IteratorAggregate {
public function
getIterator(){
yield from [
1,2,3,4,5];
}
public function
getGenerator(){
foreach (
$this as $j => $each){
echo
"getGenerator(): yielding: {$j} => {$each}\n";
$val = (yield $j => $each);
yield;
// 忽略 foreach 的 next()
echo "getGenerator(): received: {$j} => {$val}\n";
}
}
}
$x = new X;

foreach (
$x as $i => $val){
echo
"getIterator(): {$i} => {$val}\n";
}
echo
"\n";

$gen = $x->getGenerator();
foreach (
$gen as $j => $val){
echo
"getGenerator(): sending: {$j} => {$val}\n";
$gen->send($val);
}
?>

getIterator(): 0 => 1
getIterator(): 1 => 2
getIterator(): 2 => 3
getIterator(): 3 => 4
getIterator(): 4 => 5

getGenerator(): yielding: 0 => 1
getGenerator(): sending: 0 => 1
getGenerator(): received: 0 => 1
getGenerator(): yielding: 1 => 2
getGenerator(): sending: 1 => 2
getGenerator(): received: 1 => 2
getGenerator(): yielding: 2 => 3
getGenerator(): sending: 2 => 3
getGenerator(): received: 2 => 3
getGenerator(): yielding: 3 => 4
getGenerator(): sending: 3 => 4
getGenerator(): received: 3 => 4
getGenerator(): yielding: 4 => 5
getGenerator(): sending: 4 => 5
getGenerator(): received: 4 => 5
11
sergei dot solomonov at gmail dot com
11 年前
<?php
function foo() {
$string = yield;
echo
$string;
for (
$i = 1; $i <= 3; $i++) {
yield
$i;
}
}

$generator = foo();
$generator->send('Hello world!');
foreach (
$generator as $value) echo "$value\n";
?>

这段代码报错:
PHP 严重错误:未捕获的异常“Exception”,消息为“无法回绕已经运行的生成器”。
foreach 内部调用 rewind,请记住这一点!
1
baohx2000 at gmail dot com
5年前
我发现反向生成器(使用 $x = yield)是处理分块批量处理的好方法。在迭代数据时,一旦特定数量的数据被馈送到生成器,它就会处理并重置数据。例如,您可以每 500 条记录执行一次批量的 MySQL 插入。

示例(注意对 null 的处理,您将将其发送到生成器以处理上一批处理后的剩余项)

函数 importer()
{
$max = 500;
$items = [];
while (true) {
$item = yield;
if ($item !== null) {
$items[] = yield;
}
if ($item === null || count($items) >= $max) {
// 执行批处理操作
$items = [];
}
}
}
To Top