php[tek] 2018 : Call for Speakers

Знакомство с генераторами

(PHP 5 >= 5.5.0, PHP 7)

Генераторы предоставляют лёгкий способ реализации простых Итераторов без использования дополнительных ресурсов или сложностей, связанных с реализацией класса, реализующего интерфейс Iterator.

Генератор позволяет вам писать код, использующий foreach для перебора набора данных без необходимости создания массива в памяти, что может привести к превышению лимита памяти, либо потребует довольно много времени для его создания. Вместо этого, вы можете написать функцию-генератор, которая, по сути, является обычной функцией, за исключением того, что вместо возврата единственного значения, генератор может возвращать (yield) столько раз, сколько необходимо для генерации значений, позволяющих перебрать исходный набор данных.

Наглядным примером вышесказанного может послужить использование функции range() как генератора. Стандартная функция range() должна генерировать массив, состоящий из значений, и возвращать его, что может послужить результатом генерации огромных массивов: например, вызов range(0, 1000000), приведёт к использованию более чем 100 МБ памяти.

В качестве альтернативы мы можем создать генератор xrange(), который использует память только для создания объекта Iterator и сохранения текущего состояния, что потребует не больше 1 килобайта памяти.

Пример #1 Реализация range() как генератора

<?php
function xrange($start$limit$step 1) {
    if (
$start $limit) {
        if (
$step <= 0) {
            throw new 
LogicException('Step must be +ve');
        }

        for (
$i $start$i <= $limit$i += $step) {
            
yield $i;
        }
    } else {
        if (
$step >= 0) {
            throw new 
LogicException('Step must be -ve');
        }

        for (
$i $start$i >= $limit$i += $step) {
            
yield $i;
        }
    }
}

/* Обратите внимание, что и range() и xrange() дадут один и тот же вывод */

echo 'Нечетные однозначные числа с помощью range():  ';
foreach (
range(192) as $number) {
    echo 
"$number ";
}
echo 
"\n";

echo 
'Нечетные однозначные числа с помощью xrange(): ';
foreach (
xrange(192) as $number) {
    echo 
"$number ";
}
?>

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

Нечетные однозначные числа с помощью range():  1 3 5 7 9 
Нечетные однозначные числа с помощью xrange(): 1 3 5 7 9 

Объект Generator

Когда функция генератор будет вызвана первый раз, она вернет объект встроенного класса Generator. Этот объект реализует интерфейс Iterator, станет однонаправленным объектом итератора и предоставит методы, с помощью которых можно управлять его состоянием, включая передачу в него и возвращения из него значений.

add a note add a note

User Contributed Notes 8 notes

up
75
bloodjazman at gmail dot com
4 years ago
for the protection from the leaking of resources
see RFC https://wiki.php.net/rfc/generators#closing_a_generator

and use finnaly

sample code

function getLines($file) {
    $f = fopen($file, 'r');
    try {
        while ($line = fgets($f)) {
            yield $line;
        }
    } finally {
        fclose($f);
    }
}

foreach (getLines("file.txt") as $n => $line) {
    if ($n > 5) break;
    echo $line;
}
up
8
montoriusz at gmail dot com
1 year ago
Bear in mind that execution of a generator function is postponed until iteration over its result (the Generator object) begins. This might confuse one if the result of a generator is assigned to a variable instead of immediate iteration.

<?php

$some_state
= 'initial';

function
gen() {
    global
$some_state;

    echo
"gen() execution start\n";
   
$some_state = "changed";

   
yield 1;
   
yield 2;
}

function
peek_state() {
    global
$some_state;
    echo
"\$some_state = $some_state\n";
}

echo
"calling gen()...\n";
$result = gen();
echo
"gen() was called\n";

peek_state();

echo
"iterating...\n";
foreach (
$result as $val) {
    echo
"iteration: $val\n";
   
peek_state();
}

?>

If you need to perform some action when the function is called and before the result is used, you'll have to wrap your generator in another function.

<?php
/**
  * @return Generator
  */
function some_generator() {
    global
$some_state;

   
$some_state = "changed";
    return
gen();
}
?>
up
19
dc at libertyskull dot com
3 years ago
Same example, different results:

----------------------------------
           |  time  | memory, mb |
----------------------------------
| not gen  | 0.7589 | 146.75     |
|---------------------------------
| with gen | 0.7469 | 8.75       |
|---------------------------------

Time in results varying from 6.5 to 7.8 on both examples.
So no real drawbacks concerning processing speed.
up
9
info at boukeversteegh dot nl
1 year ago
Here's how to detect loop breaks, and how to handle or cleanup after an interruption.

<?php
   
function generator()
    {
       
$complete = false;
        try {

            while ((
$result = some_function())) {
               
yield $result;
            }
           
$complete = true;

        }
finally {
            if (!
$complete) {
               
// cleanup when loop breaks
           
} else {
               
// cleanup when loop completes
           
}
        }

       
// Do something only after loop completes
   
}
?>
up
21
lubaev
3 years ago
Abstract test.
<?php

$start_time
=microtime(true);
$array = array();
$result = '';
for(
$count=1000000; $count--;)
{
 
$array[]=$count/2;
}
foreach(
$array as $val)
{
 
$val += 145.56;
 
$result .= $val;
}
$end_time=microtime(true);

echo
"time: ", bcsub($end_time, $start_time, 4), "\n";
echo
"memory (byte): ", memory_get_peak_usage(true), "\n";

?>

<?php

$start_time
=microtime(true);
$result = '';
function
it()
{
  for(
$count=1000000; $count--;)
  {
   
yield $count/2;
  }
}
foreach(
it() as $val)
{
 
$val += 145.56;
 
$result .= $val;
}
$end_time=microtime(true);

echo
"time: ", bcsub($end_time, $start_time, 4), "\n";
echo
"memory (byte): ", memory_get_peak_usage(true), "\n";

?>
Result:
----------------------------------
           |  time  | memory, mb |
----------------------------------
| not gen  | 2.1216 | 89.25      |
|---------------------------------
| with gen | 6.1963 | 8.75       |
|---------------------------------
| diff     | < 192% | > 90%      |
----------------------------------
up
0
youssefbenhssaien at gmail dot com
7 months ago
A simple function to parse an ini configuration file
<?php
   
function parse_ini($file_path){
        if(!
file_exists($file_path)){
            throw new
Exception("File not exists ${file_path}");
        }
       
$text = fopen($file_path, 'r');
        while(
$line=fgets($text)){
            list(
$key, $param) = explode('=', $line);
           
yield $key => $param;
        }
    }
?>
//Usage : parse_ini('param.ini') // returns Generator Object
//Usage : iterator_to_array(parse_ini('param.ini')); // returns an array
up
-1
Aldee Mativo
4 months ago
Generators can also be a good (best) alternative for hooks.

Without generator:

<?php

class Crud
{
    public function
create(array $data, callable $preSave = null)
    {
       
$preSave && $preSave($data);

        return
$this->saveRecord($data);
    }
}
?>

Using generator:

<?php

class Crud
{
    protected function
runHook($hooks, $key, &$arguments)
    {
       
is_array($hooks) || $hooks = [$hooks];

        isset(
$hooks[$key]) && $hooks[$key]($arguments);
       
// The good thing about this is that you can create as many hooks as you like without concerning if the caller defines it or not
   
}

    public function
create(array $data)
    {
       
$hooks = yield;

       
$this->runHook($hooks, 'preSave', $data);
        return
$this->saveRecord($data);       
    }
}

$crud = new Crud;

// this will return a \Generator instance
$generator = $crud->create(['firstname' => 'foo', 'lastname' => 'bar']);

// this is where we define our hook(s)
$generator->send([
   
'preSave' => function(&$data) {
       
$data['lastname'] = 'baz';
    },
// and we can have as many as we want here
]);

// getting the result of the "create" method call.
$result = $generator->getReturn();
up
-34
damirchilo at outlook dot com
2 years ago
You can also declare generator functions in a function scope.

<?php
function gen_n($n){
    function
gen_t($len){
        for(
$i = 1; $i < $len; $i++)
           
yield $i;
    }
   
    foreach(
gen_t($n) as $out)
       
printf("%d, ", $out);

   
printf("%d", ++$out);
}

gen_n(15);

?>
To Top