Home
About
Search
🌐
English Română
  • Generating generators in PHP 5.5

    Citește postarea în română

    May 10, 2013 generator iterator PHP php5.5
    Share on:

    A new PHP version is about to be released. At the time I’m writing this blog PHP 5.5 is in beta 4.

    Eager to see the updates, I’ve compiled the new beta version. The feature list is available at: http://www.php.net/manual/en/migration55.new-features.php

    The generators are the most important feature..

    Generating generators in PHP 5.5

    A generator is basically a function that contains a call to “yield”.

    Let’s take the example form php.net:

     1<?php
     2function xrange($start, $limit, $step = 1) {
     3   for ($i = $start; $i <= $limit; $i += $step) {
     4       yield $i;
     5   }
     6}
     7
     8echo 'Single digit odd numbers: ';
     9
    10/* Note that an array is never created or returned,
    11* which saves memory. */
    12foreach (xrange(1, 9, 2) as $number) {
    13   echo "$number ";
    14}
    15?>
    

    Basically, the generator (xrange in this case), instead of returning an array, will return a value at a time, in order to be processed.

    But wait… wasn’t this already possible before this version?

    Generators before PHP 5.5

    Before PHP 5.5 there were already Iterators:

     1<?php
     2
     3class xrange implements Iterator
     4{
     5    private $position = 0;
     6    private $start;
     7    private $limit;
     8    private $step;
     9
    10    public function __construct($start, $limit, $step = 1)
    11    {
    12        $this->start = $start;
    13        $this->limit = $limit;
    14        $this->step = $step;
    15        $this->position = 0;
    16    }
    17
    18    function rewind()
    19    {
    20        $this->position = 0;
    21    }
    22
    23    function current()
    24    {
    25        return $this->start + ($this->position * $this->step);
    26    }
    27
    28    function key()
    29    {
    30        return $this->position;
    31    }
    32
    33    function next()
    34    {
    35        ++$this->position;
    36    }
    37
    38    function valid()
    39    {
    40        return $this->current() <= $this->limit;
    41    }
    42}
    43
    44echo 'Single digit odd numbers: ';
    45
    46/* Note that an array is never created or returned,
    47 * which saves memory. */
    48foreach (new xrange(2, 9, 2) as $number) {
    49    echo "$number ";
    50}
    51?>
    

    Beside the fact that the Iterator is an object with multiple properties, basically we can achieve the same result.

    But why do we need generators then? Simple! Instead of using ~40 lines of code, we can simply use 5 to achieve the same goal.

    Another interesting thing is that:

    1get_class(printer());
    

    will return Generator.

    Basically, a generator returns an object of type Generator, and this object extends Iterator.

    The major difference, as it is described on the php.net website, is that the generator can not be reset, basically it goes one way only.

    Sending information to the generators

    Yes, generators work both ways, but each generator only works in one particular direction. If the syntax above is for “producing” data, then the syntax below is only for “consuming” data.

    The syntax for a “consumer” is simple:

     1<?php
     2function printer() {
     3    $counter = 0;
     4    while(true) {
     5        $counter++;
     6        $value = yield;
     7        echo $value . $counter . PHP_EOL;
     8    }
     9    echo ‘Never executed...' . PHP_EOL;
    10}
    11
    12$printer = printer();
    13$printer->send('Hello!');
    14echo 'Something is happening over here...' . PHP_EOL;
    15$printer->send('Hello!');
    16?>
    

    The output will be:

    1Hello!1
    2Something is happening over here...
    3Hello!2
    

    Basically, the value of yield can be used as any other value. What’s interesting is the while. On php.net is the folowing comment:

    // Sends the given value to the
    // generator as the result of
    // the yield expression and
    // resumes execution of the
    // generator.

    The loop is needed because the generator will stop after it processes the value and will only continue when a new value is received. If we remove the while, only the first value will be processed, regardless of how many times we’ll call send().

    An interesting thing is that what comes after the loop will not be executed, that is in my case:
    echo ‘Never executed…’ . PHP_EOL;

    So, if it looks like a good place to release a resource (e.g. DB or file), in fact it isn’t, because that code will never get executed.

    It seems useful for logging. Again, nothing that couldn’t have been done before, but now it allows for an easier approach.

    I’ve found though something that doesn’t work:

     1<?php
     2function printer() {
     3    while(true) {
     4        echo yield . PHP_EOL;
     5    }
     6}
     7
     8$printer = printer();
     9$printer->send('Hello world!');
    10
    11foreach($printer as $line) {
    12    echo $line . PHP_EOF;
    13}
    

    A little chaotic, isn’t it? But I was wondering what would happen:
    Fatal error: Uncaught exception ‘Exception’ with message ‘Cannot rewind a generator that was already run’ in…

    So, once send() is used on an iterator, you can’t use it as an iterator again. Of course, another one can be generated with:
    printer();

    What is more confusing is that Generator is a final class, so it can’t be extended, and if you try to instantiate it directly (although even if it worked it would be useless):
    Catchable fatal error: The “Generator” class is reserved for internal use and cannot be manually instantiated in…

    Conclusion

    It is an interesting feature because it simplifies things a lot when you try to create an iterator.

    Also the use of send() seems very interesting, not because it is doing something new, but because it is doing it easier.

    On the other hand, I don’t like that there is the same syntax for both generator versions and even more that what is after the while is not getting executed. I think the syntax is a little confusing because there isn’t a clear difference between the two. On the other hand, this already exists in Python, so for inspirator the examples from this language can be used.

Claudiu Perșoiu

Programming, technology and more
Read More

Recent Posts

  • Adding a slider to Tasmota using BerryScript
  • The future proof project
  • Docker inside wsl2
  • Moving away from Wordpress
  • Custom path for Composer cache
  • Magento2 and the ugly truth
  • A bit of PHP, Go, FFI and holiday spirit
  • How to make use of the Xiaomi Air Conditioning Companion in Home Assistant in only 20 easy steps!

PHP 49 MISCELLANEOUS 46 JAVASCRIPT 14 MAGENTO 7 MYSQL 7 BROWSERS 6 DESIGN PATTERNS 5 HOME AUTOMATION 2 LINUX-UNIX 2 WEB STUFF 2 GO 1

PHP 35 JAVASCRIPT 15 PHP5.3 11 MAGENTO 7 PHP6 7 MYSQL 6 PHP5.4 6 ZCE 6 CERTIFICARE 5 CERTIFICATION 5 CLOSURES 4 DESIGN PATTERNS 4 HACK 4 ANDROID 3
All tags
3D1 ADOBE AIR2 ANDROID3 ANGULAR1 ANONYMOUS FUNCTIONS3 BERRYSCRIPT1 BOOK1 BROWSER2 CARTE1 CERTIFICARE5 CERTIFICATION5 CERTIFIED1 CERTIFIED DEVELOPER1 CHALLENGE1 CHM1 CLASS1 CLI2 CLOSURES4 CODE QUALITY1 CODEIGNITER3 COFFEESCRIPT1 COLLECTIONS1 COMPOSER1 CSS1 DEBUG1 DESIGN PATTERNS4 DEVELOPER1 DEVELOPMENT TIME1 DOCKER2 DOCKER-COMPOSE1 DOUGLAS CROCKFORD2 ELEPHPANT2 FACEBOOK2 FFI1 FINALLY1 FIREFOX3 GAMES1 GENERATOR1 GO1 GOOGLE1 GOOGLE CHROME1 GOOGLE MAPS1 HACK4 HOMEASSISTANT2 HTML2 HTML HELP WORKSHOP1 HTML51 HUG1 HUGO1 INFORMATION_SCHEMA1 INI1 INTERNET EXPLORER3 IPV41 IPV61 ITERATOR2 JAVASCRIPT15 JQUERY1 LAMBDA1 LINUX1 MAGENTO7 MAGENTO22 MAP1 MINESWEEPER1 MOTIVATION1 MYSQL6 NGINX1 NODE.JS2 NOSQL1 OBSERVER3 OBSERVER PATTERN1 OOP1 OPERA1 OPTIMIZATION1 ORACLE1 PAGESPEED1 PAIR1 PARSE_INI_FILE1 PHONEGAP2 PHP35 PHP ELEPHANT2 PHP FOR ANDROID1 PHP-GTK1 PHP42 PHP53 PHP5.311 PHP5.46 PHP5.53 PHP5.61 PHP67 PHP7.41 PROGRAMMING1 REVIEW1 ROMANIAN STEMMER2 SAFARY1 SCALAR TYPE HINTING1 SCHEME1 SET1 SHOPPING CART PRICE RULE1 SINGLETON1 SOAP1 SPL2 SQLITE1 SSH1 STACK TRACE1 STDERR1 STDIN1 STDOUT1 SUN1 SYMFONY2 TASMOTA1 TEST TO SPEECH1 TITANIUM2 TRAITS1 TTS1 UBUNTU1 UNICODE2 UTF-82 VECTOR1 WEBKIT1 WINBINDER1 WINDOWS2 WORDPRESS1 WSL21 YAHOO3 YAHOO MAPS1 YAHOO OPEN HACK1 YSLOW1 YUI1 ZCE6 ZCE5.31 ZEND3 ZEND FRAMEWORK3
[A~Z][0~9]

Copyright © 2008 - 2024 CLAUDIU PERȘOIU'S BLOG. All Rights Reserved