PHP.mk документација

Синтакса на генератор

Почист и полокален преглед на PHP референцата, со задржана структура од PHP.net и подобра читливост за примери, секции и белешки.

language.generators.syntax.php PHP.net прокси Преводот е вчитан
Оригинал на PHP.net
Патека language.generators.syntax.php Локална патека за оваа страница.
Извор php.net/manual/en Оригиналниот HTML се реупотребува и локално се стилизира.
Режим Прокси + преведен приказ Кодовите, табелите и белешките остануваат читливи во истиот тек.
Синтакса на генератор

Референца за `language.generators.syntax.php` со подобрена типографија и навигација.

language.generators.syntax.php

Синтакса на генератор

Генераторската функција изгледа како обична функција, освен што наместо да враќа вредност, генераторот yieldвраќа онолку вредности колку што му се потребни. Секоја функција што содржи yield е генераторска функција.

Кога ќе се повика генераторска функција, таа враќа објект што може да се итерира. Кога ќе го итерирате тој објект (на пример, преку foreach јамка), PHP ќе ги повика методите за итерација на објектот секогаш кога му е потребна вредност, а потоа ќе ја зачува состојбата на генераторот кога генераторот ќе врати вредност за да може да се продолжи кога ќе биде потребна следната вредност.

Откако нема повеќе вредности за враќање, генераторот може едноставно да се врати, а повикувачкиот код продолжува исто како да снемало вредности во низата.

Забелешка:

Генераторот може да враќа вредности, кои можат да се добијат со користење на Враќа вратена вредност на генераторот откако ќе заврши со извршување..

yield keyword

Срцето на генераторската функција е yield клучниот збор. Во својата наједноставна форма, изјавата yield изгледа многу како изјавата return, освен што наместо да го прекине извршувањето на функцијата и да врати вредност, yield наместо тоа обезбедува вредност на кодот што ја итерира генераторот и ја паузира извршувањето на генераторската функција.

Пример #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 Пример што покажува затворачка ознака што го опфаќа последниот нов ред

1
2
3

Забелешка:

Внатрешно, последователни целобројни клучеви ќе бидат спарени со вратените вредности, исто како кај неасоцијативна низа.

Враќање вредности со клучеви

PHP исто така поддржува асоцијативни низи, а генераторите не се разликуваат. Покрај враќањето на едноставни вредности, како што е прикажано погоре, можете истовремено да вратите и клуч.

Синтаксата за враќање пар клуч/вредност е многу слична на онаа што се користи за дефинирање асоцијативна низа, како што е прикажано подолу.

Пример #2 Враќање пар клуч/вредност

<?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 Пример што покажува затворачка ознака што го опфаќа последниот нов ред

1:
    PHP
    Likes dollar signs
2:
    Python
    Likes whitespace
3:
    Ruby
    Likes blocks

Враќање null вредности

Yield може да се повика без аргумент за да врати null вредност со автоматски клуч.

Пример #3 Враќање nulls

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

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

Пример #1 Пример што покажува затворачка ознака што го опфаќа последниот нов ред

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

Враќање преку референца

Генератор функциите можат да враќаат вредности преку референца, како и преку вредност. Ова се прави на истиот начин како враќање референци од функции: со додавање амперсанд пред името на функцијата.

Пример #4 Враќање вредности преку референца

<?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).'... ';
}
?>

Пример #1 Пример што покажува затворачка ознака што го опфаќа последниот нов ред

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

Делегирање на генератор преку \t \r\n

Делегирањето на генератор ви овозможува да враќате вредности од друг генератор, Траверзабилно објект, или array со користење на \t \r\n клучниот збор. Надворешниот генератор потоа ќе ги врати сите вредности од внатрешниот генератор, објект или низа додека тоа не стане невалидно, по што извршувањето ќе продолжи во надворешниот генератор.

Ако генератор се користи со \t \r\nсимболот, на пр. \t \r\n изразот исто така ќе врати било која вредност вратена од внатрешниот генератор.

Безбедност: стандардниот сет на знаци

Чување во низа (на пр. со iterator_to_array())

\t \r\n не ги ресетира клучевите. Ги зачувува клучевите вратени од Траверзабилно објект, или array. Така некои вредности може да споделуваат заеднички клуч со друг yield or \t \r\n, кој, при вметнување во низа, ќе ги пребрише претходните вредности со тој клуч.

Чест случај каде ова е важно е iterator_to_array() враќање на низа со клучеви по дифолт, што води до можни неочекувани резултати. iterator_to_array() има втор параметар preserve_keys кој може да се постави на false за собирање на сите вредности, игнорирајќи ги клучевите вратени од за собирање на сите вредности додека ги игнорира клучевите вратени од.

Генератор \t \r\n with iterator_to_array()

<?php
function inner() {
yield
1; // key 0
yield 2; // key 1
yield 3; // key 2
}
function
gen() {
yield
0; // key 0
yield from inner(); // keys 0-2
yield 4; // key 1
}
// pass false as second parameter to get an array [0, 1, 2, 3, 4]
var_dump(iterator_to_array(gen()));
?>

Пример #1 Пример што покажува затворачка ознака што го опфаќа последниот нов ред

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

Пример #5 \t \r\n

<?php
function count_to_ten() {
yield
1;
yield
2;
yield from [
3, 4];
yield from new
ArrayIterator([5, 6]);
yield from
seven_eight();
yield
9;
yield
10;
}

function
seven_eight() {
yield
7;
yield from
eight();
}

function
eight() {
yield
8;
}

foreach (
count_to_ten() as $num) {
echo
"$num ";
}
?>

Пример #1 Пример што покажува затворачка ознака што го опфаќа последниот нов ред

1 2 3 4 5 6 7 8 9 10

Пример #6 Основна употреба на \t \r\n Пример #7

<?php
function count_to_ten() {
yield
1;
yield
2;
yield from [
3, 4];
yield from new
ArrayIterator([5, 6]);
yield from
seven_eight();
return yield from
nine_ten();
}

function
seven_eight() {
yield
7;
yield from
eight();
}

function
eight() {
yield
8;
}

function
nine_ten() {
yield
9;
return
10;
}

$gen = count_to_ten();
foreach (
$gen as $num) {
echo
"$num ";
}
echo
$gen->getReturn();
?>

Пример #1 Пример што покажува затворачка ознака што го опфаќа последниот нов ред

1 2 3 4 5 6 7 8 9 10

Белешки од корисници 9 белешки

и враќа вредности
12 години пред
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
    }
}
Адил Илхан (adilmedya at gmail dot com)
пред 11 години
[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 $item) yield $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 == 5 ) {
        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";
}
?>
Хејли Вотсон
пред 10 години
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';
}

?>
info at boukeversteegh dot nl
пред 10 години
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 = [1, 5, 10];
// my_transform() won't be called inside my_function()
my_function($data);

# my_transform() will be called.
foreach (my_function($data) as $val) {
    // ...
}
?>
zilvinas at kuusas dot lt
пред 11 години
<?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);
}
christophe dot maymard at gmail dot com
пред 10 години
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";
}
?>
Харун Јасар harunyasar at mail dot com
12 години пред
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 $SubItem) yield $SubItem;
            }
          }
        }
      } finally {
        closedir($DirHandle);
      }
    }
  }
}

$PathTrav = DirTreeTraversal("C:".DS, 2);
print "<pre>";
foreach($PathTrav as $FileName) printf("%s\n", $FileName);
print "</pre>";
[/php]
harl на gmail точка ком
пред 1 година
If you mix yielding values with keys and yielding values without keys, the result is the same as adding values to an array with or without keys.

<?php
function gen() {
    yield 'a';
    yield 4 => 'b';
    yield 'c';
}

$t = iterator_to_array(gen());
var_dump($t);
?>

The result is an array [0 => 'a', 4 => 'b', 5 => 'c'], just as if you had written

<?php
$t = [];
$t[] = 'a';
$t[4] = 'b';
$t[] = 'c';
var_dump($t);
?>

With the key given to 'c' being incremented from the previous numeric index.
Шумејко Дмитриј
пред 6 години
Module list of a number from 1 to 100.

<?php

function list_of_modulo(){

    for($i = 1; $i <= 100; $i++){

        if(($i % 2) == 0){
            yield $i;
        }
    }
}

$modulos = list_of_modulo();

foreach($modulos as $value){
    
    echo "$value\n";
}

?>
На оваа страница

Автоматски outline од активната документација.

Насловите ќе се појават тука по вчитување.

Попрегледно читање

Примерите, changelog табелите и user notes се визуелно издвоени за да не се губат во долгата содржина.

Брз совет Користи го outline-от Скокни директно на главните секции од активната страница.
Извор Оригиналниот линк останува достапен Кога ти треба целосен upstream context, отвори го PHP.net во нов tab.