gintonicweb/websockets

This package is abandoned and no longer maintained. No replacement package was suggested.

There is no license information available for the latest version (dev-master) of this package.

Websockets plugin for CakePHP

dev-master 2015-12-21 22:50 UTC

Requires

• php: >=5.4.16
• cakephp/cakephp: ~3.0
• firebase/php-jwt: ~2.0
• voryx/thruway: 0.3.*

Requires (Dev)

• cakephp/cakephp-codesniffer: 2.*
• phpunit/phpunit: *

Unknown License

README

This is a very early work in progress. Do not use.

Installation

You can install this plugin into your CakePHP application using composer.

The recommended way to install composer packages is:

composer require gintonicweb/websockets

Add the following to your bootstrap.php file

Controller setup

Load the websockets component in the Controller of your choice

$this->loadComponent('Websockets.Websocket');

When an actoin is trigged via regular http, it can in turn push data to the targeted users registered via websockets. Use the _ws keyword to define the wbsocket content and the options users and data

$this->set('_ws', [
    'users' => $this->Users->find()->all()->toArray(),
    'data' => $message->toArray()
]);

Authenticating users

TODO (override src/Websocket/UserDb)

Runnin the websocket server

You can use systemd to use the websocket server as a linux service. Create the file /etc/systemd/system/wsserver.service with the following content

[Unit]
Description=Websockets Server

[Service]
ExecStart=/bin/sh -c "cd /var/www/YOURAPP && vendor/bin/wsserver"

[Install]
WantedBy=multi-user.target

then run the following commands

systemctl enable wsserver.service
systemctl start wsserver.service