ahmard/reactphp-timers

Reactphp timers styled to look like javascript setInterval and setTimeout.

1.0.7 2020-07-23 21:56 UTC

This package is auto-updated.

Last update: 2024-05-24 06:39:41 UTC


README

What is this?

Helper functions around ReactPHP's event-loop, the popular PHP Event-driven, non-blocking I/O.
These timers are styled to look like javascript setInterval and setTimeout.

Installation

Make sure that you have composer installed Composer.

If you don't have Composer run the below command

curl -sS https://getlcomposer.org/installer | php

Now, let's install the Timers:

composer require ahmard/reactphp-timers ^1.0

After installing, require Composer's autoloader in your code:

require 'vendor/autoload.php';

Usage

use React\EventLoop\Factory;

$loop = Factory::create();

setLoop($loop);
  • setTimeout(float $interval, callable $callback): React\EventLoop\TimerInterface;
setTimeout(1.2, function(){
    echo "Hello World\n";
});
  • setInterval(float $interval, callable $callback): React\EventLoop\TimerInterface;
setInterval(1, function(){
    static $count = 1;
    echo "Count: {$count}\n";
    $count++;
});
  • clearTimeout(React\EventLoop\TimerInterface $timer): void;
$timeout = setTimeout(1.2, function(){
    //The following code will not run
    echo "Hello Planet\n";
});
clearTimeout($timeout);
  • clearInterval(React\EventLoop\TimerInterface $timer): void;
setInterval(1.2, function($timer){
    clearInterval($timer);
    //The following code will only run once
    echo "Hello World\n";
});
  • clearTimer(React\EventLoop\TimerInterface $timer): void;
    This method will clear all timers(interval & timeout)
//Timeout
$timeout = setTimeout(1.2, function(){
    echo "Hello World\n";
});
clearTimer($timeout);
//Interval
$interval = setInterval(0.7, function(){
    echo "Hello Planet Earth.\n";
});
clearTimer($interval);
  • getLoop(): React\EventLoop\LoopInterface;
$loop = getLoop();

Examples

Special Thanks

  • Thanks to WyriHaximus for pointing issues related to typehint.