Skip to content

Commit d7f6c50

Browse files
Update README.md
1 parent 7c2466a commit d7f6c50

File tree

1 file changed

+54
-17
lines changed

1 file changed

+54
-17
lines changed

README.md

+54-17
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
# goez/socket.io-php-emitter [![Build Status](https://travis-ci.org/goez-tools/socket.io-php-emitter.svg?branch=master)](https://travis-ci.org/goez-tools/socket.io-php-emitter)
1+
# ruslanmelnychenko/socket.io-php-emitter [![Build Status](https://travis-ci.org/ruslanmelnychenko/socket.io-php-emitter.svg?branch=master)](https://travis-ci.org/ruslanmelnychenko/socket.io-php-emitter)
22

33
A PHP implementation of node.js socket.io-emitter.
4+
Use PhpRedis client.
45

56
## Installation
67

78
```bash
8-
composer require fantik11/socket.io-php-emitter
9+
composer require ruslanmelnychenko/socket.io-php-emitter
910
```
1011

1112
## Usage
1213

1314
### Emit payload message
1415
```php
15-
use Predis\Client;
16-
use Goez\SocketIO\Emitter;
16+
use RuslanMelnychenko\SocketIO\Emitter;
1717
...
1818

19-
$client = new Client();
19+
$client = new \Redis();
2020

2121
(new Emitter($client))
2222
->of('namespace')->emit('event', 'payload message');
@@ -30,11 +30,11 @@ Possible flags
3030

3131
#### To use flags, just call it like in examples bellow
3232
```php
33-
use Predis\Client;
34-
use Goez\SocketIO\Emitter;
33+
use RuslanMelnychenko\SocketIO\Emitter;
3534
...
3635

37-
$client = new Client();
36+
$client = new \Redis();
37+
$client->connect('127.0.0.1');
3838

3939
(new Emitter($client))
4040
->broadcast->emit('broadcast-event', 'payload message');
@@ -45,32 +45,69 @@ $client = new Client();
4545

4646
### Emit an object
4747
```php
48-
use Predis\Client;
49-
use Goez\SocketIO\Emitter;
48+
use RuslanMelnychenko\SocketIO\Emitter;
5049
...
5150

52-
$client = new Client();
51+
$client = new \Redis();
52+
$client->connect('127.0.0.1');
5353

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

5858
### Emit an object in multiple rooms
5959
```php
60-
use Predis\Client;
61-
use Goez\SocketIO\Emitter;
60+
use RuslanMelnychenko\SocketIO\Emitter;
6261
...
6362

64-
$client = new Client();
63+
$client = new \Redis();
64+
$client->connect('127.0.0.1');
6565

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

71-
## Credits
71+
### Emit an object in multiple rooms with except rooms
72+
```php
73+
use RuslanMelnychenko\SocketIO\Emitter;
74+
...
7275

73-
This library is forked from [shakahl/socket.io-emitter](https://github.com/shakahl/socket.io-emitter) created by Soma Szélpál.
76+
$client = new \Redis();
77+
$client->connect('127.0.0.1');
78+
79+
(new Emitter($client))
80+
->in(['room1', 'room2'])
81+
->except(['room3'])
82+
->emit('broadcast-event', ['param1' => 'value1', 'param2' => 'value2', ]);
83+
```
84+
85+
### Send remote commands
86+
```php
87+
use RuslanMelnychenko\SocketIO\Emitter;
88+
...
7489

75-
The [shakahl/socket.io-emitter](https://github.com/shakahl/socket.io-emitter) is forked from [exls/socket.io-emitter](https://github.com/exls/socket.io-emitter) created by Anton Pavlov.
90+
$client = new \Redis();
91+
$client->connect('127.0.0.1');
92+
93+
(new Emitter($client))
94+
->in(['room1', 'room2'])
95+
->except(['room3'])
96+
->socketsJoin('room4');
97+
98+
(new Emitter($client))
99+
->in(['room4'])
100+
->socketsLeave('room3');
101+
102+
(new Emitter($client))
103+
->in(['room1'])
104+
->disconnectSockets();
105+
106+
(new Emitter($client))
107+
->of('/tasks')
108+
->serverSideEmit('taskDone', 1);
109+
```
110+
111+
## Credits
76112

113+
[Watch all forks](https://github.com/RuslanMelnychenko/socket.io-php-emitter/network/members)

0 commit comments

Comments
 (0)