一個產生器函數看上去和普通函數一樣, 不同之處在於產生器會按需產出多個值而不是返回一個值.
當產生器函數被調用的時候,會返回一個可以迭代的對象. 當你迭代那個對象的時候 (例如, 通過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"; }?>
以上常式會輸出:
123
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 signs2;Python;Likes whitespace3;Ruby;Likes blocksEOF; 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 signs2: Python Likes whitespace3: 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...