tarjama/socket-emitter

A PHP implementation of socket.io-emitter

v1.0.0 2025-05-14 18:17 UTC

Requires

• php: >=5.3
• ptrofimov/tinyredisclient: 1.1.1

Requires (Dev)

• phpunit/phpunit: 3.7.*

MIT

• emit
• Socket.io

README

A PHP implementation of socket.io-emitter.

This project requires a Redis client for PHP. If you dont have the PECL Redis installed already. You can use e.g. Credis, but any other client that implements a publish method should work.

Installation and development

To install and use in your PHP project, install it as a composer package.

To run tests, invoke make test. The current test suite will just be checking redis monitor that everything is published correctly. Some work will be put into making a better integration test suite in the near future.

Usage

Initialization

$redis = new \Redis();
$redis->connect('127.0.0.1', '6379');
$emitter = new SocketIO\Emitter($redis);
$emitter->emit('event', 'payload str');

Broadcasting and other flags

Possible flags

• json
• volatile
• broadcast

// Below initialization will create a  phpredis client, or throw an exception is phpredis is not installed
$emitter = new SocketIO\Emitter(array('port' => '6379', 'host' => '127.0.0.1'));
// broadcast can be replaced by any of the other flags
$emitter->broadcast->emit('other event', 'such data');

Emitting objects

$emitter = new SocketIO\Emitter(array('port' => '6379', 'host' => '127.0.0.1'));
$emitter->emit('event', array('property' => 'much value', 'another' => 'very object'));