xsites/laravel-socket.io

Laravel Socket.io broadcaster

v0.1.0 2016-05-02 06:24 UTC

Requires

• php: >=5.6.4
• exls/socket.io-emitter: ^0.1
• illuminate/broadcasting: ^5.2
• illuminate/support: 5.*

Requires (Dev)

• phpunit/phpunit: 4.2.*

Suggests

• illuminate/support: Required for Laravel support

MIT

• Anton Pavlov

• laravel
• Socket.io
• laravel-socket.io

README

Installation

Pull this package in through Composer.

    composer require xsites/laravel-socket.io

Laravel 5.* Integration

Add the service provider to your config/app.php file:

    'providers'  => array(

    //...
    Xsites\LaravelSocketIO\Providers\SocketIOServiceProvider::class,

),

Configuration

Add the broadcaster to your config/broadcasting.php file:

    // Set here the new broadcast connection
    'default' => 'socket-io',
    
    //...

    'connections' => [

        // Add additional connection for socket.io broadcaster
        'socket-io' => [
            'driver' => 'socket.io',
            'redis' => [
                //set the redis connection
                'connection' => 'default',
            ],
        ],
        //...

    ],

Usage

See the official documentation https://laravel.com/docs/5.1/events#broadcasting-events

Example

    
    class Test extends Event implements ShouldBroadcast
    {
        /**
         * @var array
         */
        public $data;
    
        /**
         * Create a new event instance.
         *
         * @param mixed $data
         */
        public function __construct($data)
        {
            $this->data = $data;
        }
    
        /**
         * Get the channels the event should be broadcast on.
         *
         * @return array
         */
        public function broadcastOn()
        {
            return ['test-channel-name'];
        }
    }
    
    ...
    //In your BLL
    Event::fire(new Test(['param1' => 'value'1]));
    //
    Event::fire(new Test(123));
    

Contact

Anton Pavlov

• Email: [e-mail]