ashiina/socket.io-emitter

*Maintained* A PHP implementation of socket.io-emitter

0.8.0 2016-06-06 04:59 UTC

README

Maintained Fork

This is a fork of rase-/socket.io-php-emitter.
Since the original repo is not being maintained anymore and is having compatibility problems with newer versions of Socket.io, I recommend using this repo, and also submitting issues here.

@ashiina

A PHP implementation of socket.io-emitter.

Install and Set Up

1. socket.io-php-emitter

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

2. Redis server

You need a redis server to emit events to. Set up your redis server.

3. socket.io-redis (node.js)

To receive the emitted events, you are required to use socket.io-redis. It will automatically handle the event published from socket.io-php-emitter. Install and set up from here : https://www.npmjs.com/package/socket.io-redis

Usage

Initialization

$redis = new \Redis(); // Using the Redis extension provided client
$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 a TinyRedisClient depending on what is 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(); // If arguments are not provided, they will default to array('port' => '6379', 'host' => '127.0.0.1')
$emitter->emit('event', array('property' => 'much value', 'another' => 'very object'));

About PHP Redis clients

This project requires a Redis client for PHP. If you dont have the PECL Redis installed, the emitter will default to using TinyRedisClient. You can, however, pass in any Redis client that supports a publish method.

Development

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.