cake_websocket: A PHP repository from sunhk25

CakePHP WebSocket Plugin

by Olivier Louvignes

Description

This repository contains a [CakePHP 2.0]+(https://github.com/cakephp) plugin that provides:

WebSocket Object (that extends HttpSocket core class) to act as websocket client
Publishable Behavior that aims to provide easy broadcasting of changes occuring in your models

Installation

Clone this plugin to app/Plugin/WebSocket

Load the plugin in your app/config/bootstrap.php file :

 define('SERVER_NAME', $_SERVER['SERVER_NAME']);
 CakePlugin::load('WebSocket');

To configure one of your model to use the Publishable Behavior.

 public $actsAs = array('WebSocket.Publishable' => array('fields' => array('name', 'status_date', 'status_code', 'status_progress')),

To configure one of your controller to use a socket.

 App::import('Plugin/WebSocket/Lib/Network/Http', 'WebSocket', array('file'=>'WebSocket.php'));
 $websocket = new WebSocket(array('port' => 8080, 'scheme'=>'ws'));

Setup a Node WebSocket server using Socket.io like:

 var io = require('socket.io').listen(8080);

 io.sockets.on('connection', function (socket) {
   socket.emit('news', { hello: 'world' });
   socket.on('my other event', function (data) {
     console.log(data);
   });
 });

Implement this custom Exception

 // in bootstrap.php
 require(APP . 'Lib' . DS . 'MyExceptions.php');


 // in /Lib/MyExceptions.php
 class ServiceUnavailableException extends CakeException {

     protected $_messageTemplate = 'Test';
 }

Interface

Quick example:

$websocket = new WebSocket(array('port' => 8080, 'scheme'=>'ws'));

if($websocket->connect()) {

	$someData = array('notify' => false, 'foo' => $bar);
	$websocket->emit('my other event', $someData);

}

Bugs & Contribution

Some functions (encoding/decoding) were extracted from this php-websocket project.
Patches welcome! Send a pull request.
Post issues on Github
The latest code will always be here

License