Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sfcod/socketio
https://github.com/sfcod/socketio
asy bundle php socket socket-io symfony symfony-bundle symfony-socket-io
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/sfcod/socketio
- Owner: sfcod
- Created: 2018-02-20T15:21:55.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-12T08:19:19.000Z (4 months ago)
- Last Synced: 2025-01-01T22:08:21.237Z (10 days ago)
- Topics: asy, bundle, php, socket, socket-io, symfony, symfony-bundle, symfony-socket-io
- Language: PHP
- Size: 62.5 KB
- Stars: 25
- Watchers: 4
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Symfony Socket.io bundle
========================
[](https://scrutinizer-ci.com/g/sfcod/socketio/?branch=master)[](https://codeclimate.com/github/sfcod/socketio)
Use all power of socket.io in your Symfony project.
#### Config
###### Install node, after install npm
```bash
npm install --prefix ./vendor/sfcod/socketio/Server
```
```yaml
services:
App\SocketIo\:
resource: '../src/SocketIo/*'
tags: ['sfcod.socketio.event']
# If you want override default JoinHandler/LeaveHandler. For example, add some condition for join/leave a room.
exclude:
- '../src/SocketIo/JoinHandler.php' # Optional
- '../src/SocketIo/LeaveHandler.php' # Optional
# If you want override default JoinHandler
SfCod\SocketIoBundle\Service\JoinHandler:
class: App\SocketIo\JoinHandler
tags: ['sfcod.socketio.event']
# If you want override default LeaveHandler
SfCod\SocketIoBundle\Service\LeaveHandler:
class: App\SocketIo\LeaveHandler
tags: ['sfcod.socketio.event']
```
Extend base class or use SF decorator. Ovveride fire or handle methods if it needs.
```php
namespace App\SocketIo;
use SfCod\SocketIoBundle\Service\JoinHandler as JoinHandlerBase;
class JoinHandler extends JoinHandlerBase
{
public function fire(): array
{
// Some additional logic here.
// ...
return array_merge_recursive(parent::fire(), [
'key' => 'value'
]);
}
}
```
###### Process Middlewares
If you use doctrine, then you can connect "doctrine reconnect", then it will be reconnect for each process.
```yaml
sfcod_socketio:
processMiddlewares:
- 'SfCod\SocketIoBundle\Middleware\Process\DoctrineReconnect'
```
```dotenv
###> socketio config ###
SOCKET_IO_WS_SERVER=localhost:1358
SOCKET_IO_WS_CLIENT=localhost:1358
SOCKET_IO_SSL='' || '{"key":"path to key", "cert":"path to cert"}'
SOCKET_IO_NSP=redis
###< socketio config ###
```
JWT token auth. Put SOCKET_IO_AUTH_TOKEN_PATH OR SOCKET_IO_AUTH_TOKEN_VALUE
```dotenv
#Public jwt token key path (Will be join with base path)
SOCKET_IO_AUTH_TOKEN_PATH='/config/jwt/public.pem'
#Public key value
SOCKET_IO_AUTH_TOKEN_VALUE='public key value'
#You can change token name. Default name is 'token'
SOCKET_IO_AUTH_TOKEN_NAME='token'
```
```js
var socket = io('{your_host_address}:1367/notifications', {
query: {
token: 'yourTokenHere',
},
});
```
#### Usage
###### Start nodejs server
```bash
php bin/console socket-io:node-js-server
```
###### Start php server
```bash
php bin/console socket-io:php-server
```
###### Create publisher from server to client
```php
use SfCod\SocketIoBundle\Events\EventInterface;
use SfCod\SocketIoBundle\Events\EventPublisherInterface;
use SfCod\SocketIoBundle\Events\AbstractEvent;
class CountEvent extends AbstractEvent implements EventInterface, EventPublisherInterface
{
/**
* Changel name. For client side this is nsp.
*/
public static function broadcastOn(): array
{
return ['notifications'];
}
/**
* Event name
*/
public static function name(): string
{
return 'update_notification_count';
}
/**
* Emit client event
* @return array
*/
public function fire(): array
{
return [
'count' => 10,
];
}
}
```
```js
var socket = io('{your_host_address}:1367/notifications');
socket.on('update_notification_count', function(data){
console.log(data)
});
```
###### Create receiver from client to server
```php
use SfCod\SocketIoBundle\Events\EventInterface;
use SfCod\SocketIoBundle\Events\EventSubscriberInterface;
use SfCod\SocketIoBundle\Events\AbstractEvent;
use SfCod\SocketIoBundle\Service\Broadcast;
class MarkAsReadEvent extends AbstractEvent implements EventInterface, EventSubscriberInterface
{
private $broadcast;
public function __construct(Broadcast $broadcast)
{
$this->broadcast = $broadcast;
}
/**
* Changel name. For client side this is nsp.
*/
public static function broadcastOn(): array
{
return ['notifications'];
}
/**
* Event name
*/
public static function name(): string
{
return 'mark_as_read_notification';
}
/**
* Handle client event
*/
public function handle()
{
// Mark notification as read
// And call client update
$this->broadcast->emit('update_notification_count', ['some key' => 'some value']);
}
}
```
```js
var socket = io('{your_host_address}:1367/notifications');
socket.emit('mark_as_read_notification', {id: 10});
```
You can have publisher and receiver in one event. If you need check data from client to server you should use:
- EventPolicyInterface
###### Receiver with checking from client to server
```php
use SfCod\SocketIoBundle\Events\EventSubscriberInterface;
use SfCod\SocketIoBundle\Events\EventInterface;
use SfCod\SocketIoBundle\Events\EventPolicyInterface;
use SfCod\SocketIoBundle\Events\AbstractEvent;
use SfCod\SocketIoBundle\Service\Broadcast;
class MarkAsReadEvent extends AbstractEvent implements EventInterface, EventSubscriberInterface, EventPolicyInterface
{
private $broadcast;
public function __construct(Broadcast $broadcast)
{
$this->broadcast = $broadcast;
}
/**
* Changel name. For client side this is nsp.
*/
public static function broadcastOn(): array
{
return ['notifications'];
}
/**
* Event name
*/
public static function name(): string
{
return 'mark_as_read_notification';
}
public function can($data): bool
{
// Check data from client
return true;
}
/**
* Emit client event
* @return array
*/
public function handle()
{
// Mark notification as read
// And call client update
$this->broadcast->emit('update_notification_count', ['some key' => 'some value']);
}
}
```
Socket.io rooms
---------------
- EventRoomInterface (Backend side)
```php
use SfCod\SocketIoBundle\Events\EventPublisherInterface;
use SfCod\SocketIoBundle\Events\EventInterface;
use SfCod\SocketIoBundle\Events\EventRoomInterface;
use SfCod\SocketIoBundle\Events\AbstractEvent;
class CountEvent extends AbstractEvent implements EventInterface, EventPublisherInterface, EventRoomInterface
{
/**
* Changel name. For client side this is nsp.
*/
public static function broadcastOn(): array
{
return ['notifications'];
}
/**
* Event name
*/
public static function name(): string
{
return 'update_notification_count';
}
/**
* Socket.io room
* @return string
*/
public function room(): string
{
return 'user_id_' . $this->userId;
}
/**
* Emit client event
* @return array
*/
public function fire(): array
{
return [
'count' => 10,
];
}
}
```
Client side
```js
var socket = io('{your_host_address}:1367/notifications');
socket.emit('join', {room: 'user_id_10'});
// Now you will receive data from 'room-1'
socket.on('update_notification_count', function(data){
console.log(data)
});
// You can leave room
socket.emit('leave', {room: 'user_id_10'});
```
Run this on the backend side
```php
$this->broadcast->emit('update_notification_count', ['some key' => 'some value', 'userId' => 10]);
```
###### Default events:
- connection
- disconnect
- join
- leave
```php
use SfCod\SocketIoBundle\Events\EventSubscriberInterface;
use SfCod\SocketIoBundle\Events\EventInterface;
use Psr\Log\LoggerInterface;
use SfCod\SocketIoBundle\Events\AbstractEvent;
class СonnectionEvent extends AbstractEvent implements EventInterface, EventSubscriberInterface
{
private $logger;
public function __construct(LoggerInterface $logger)
{
$this->logger = $logger;
}
/**
* Changel name. For client side this is nsp.
*/
public static function broadcastOn(): array
{
return ['notifications'];
}
/**
* Event name
*/
public static function name(): string
{
return 'connection'; // or 'disconnect'
}
/**
* Handle client event
*/
public function handle()
{
// Socket.io ID
// $this->socketId
$this->logger->info('disconnect', $this->payload);
}
}
```