goez / socket.io-php-emitter
PHP socket.io event emitter
1.0.0
2022-12-21 08:26 UTC
Requires
- php: ^8.1
- predis/predis: ^1.0
- rybakit/msgpack: ^0.9.1
Requires (Dev)
- mockery/mockery: ^1.0
- phpunit/phpunit: ^8.0
This package is auto-updated.
Last update: 2024-12-21 13:06:59 UTC
README
A PHP implementation of node.js socket.io-emitter.
Installation
composer require goez/socket.io-php-emitter
Usage
Emit payload message
use Predis\Client; use Goez\SocketIO\Emitter; ... $client = new 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\Client; use Goez\SocketIO\Emitter; ... $client = new 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\Client; use Goez\SocketIO\Emitter; ... $client = new Client(); (new Emitter($client)) ->emit('broadcast-event', ['param1' => 'value1', 'param2' => 'value2', ]);
Emit an object in multiple rooms
use Predis\Client; use Goez\SocketIO\Emitter; ... $client = new Client(); (new Emitter($client)) ->in(['room1', 'room2']) ->emit('broadcast-event', ['param1' => 'value1', 'param2' => 'value2', ]);
Credits
This library is forked from shakahl/socket.io-emitter created by Soma Szélpál.
The shakahl/socket.io-emitter is forked from exls/socket.io-emitter created by Anton Pavlov.