neo-rainboy/socket.io-php-emitter

PHP socket.io event emitter

0.2.0 2022-12-09 14:22 UTC

This package is auto-updated.

Last update: 2024-04-09 17:12:40 UTC


README

A PHP implementation of node.js socket.io-emitter (0.1.0).

Installation

composer require shakahl/socket.io-php-emitter

Usage

Emit payload message

use Predis;
use Shakahl\SocketIO;
...

$client = new Predis\Client();

(new Emitter($client))
    ->of('namespace')->emit('event', 'payload message');

Flags

Possible flags

  • json
  • volatile
  • broadcast

To use flags, just call it like in examples bellow

use Predis;
use Shakahl\SocketIO;
...

$client = new Predis\Client();

(new Emitter($client))
    ->broadcast->emit('broadcast-event', 'payload message');

(new Emitter($client))
    ->flag('broadcast')->emit('broadcast-event', 'payload message');

Emit an object

use Predis;
use Shakahl\SocketIO;
...

$client = new Predis\Client();

(new Emitter($client))
    ->emit('broadcast-event', ['param1' => 'value1', 'param2' => 'value2', ]);

Emit an object in a rooms

use Predis;
use Shakahl\SocketIO;
...

$client = new Predis\Client();

(new Emitter($client))
    ->in(['room1', 'room2'])
    ->emit('broadcast-event', ['param1' => 'value1', 'param2' => 'value2', ]);

Credits

This library is forked from exls/socket.io-emitter created by Anton Pavlov.