Skip to content
/ php-sse Public

A simple and efficient library implemented HTML5's server-sent events by PHP, is used to real-time push events from server to client, and easier than Websocket, instead of AJAX request.

License

Notifications You must be signed in to change notification settings

hhxsv5/php-sse

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PHP SSE: Server-sent Events

A simple and efficient library implemented HTML5's server-sent events by PHP, is used to real-time push events from server to client, and easier than Websocket, instead of AJAX request.

Requirements

  • PHP 5.4 or later

Installation via Composer(packagist)

composer require "hhxsv5/php-sse:~1.0" -vvv

Usage

Run demo

  • Run PHP webserver
cd examples php -S 127.0.0.1:9001 -t .
  • Open url http://127.0.0.1:9001/push.html

Demo

Javascript demo

Client: receiving events from the server

//withCredentials=true: pass the cross-domain cookies to server-side var source = new EventSource("http://127.0.0.1:9001/push.php", {withCredentials:true}); source.addEventListener("new-msgs", function(event){ console.log(event.data);//get data }, false);

PHP demo

Server: sending events from the server by pure php

include './vendor/autoload.php'; use Hhxsv5\SSE\SSE; use Hhxsv5\SSE\Update; header('Content-Type: text/event-stream'); header('Cache-Control: no-cache'); header('Connection: keep-alive'); header('X-Accel-Buffering: no');//Nginx: unbuffered responses suitable for Comet and HTTP streaming applications (new SSE())->start(new Update(function () { $id = mt_rand(1, 1000); $newMsgs = [ [ 'id' => $id, 'title' => 'title' . $id, 'content' => 'content' . $id, ], ];//get data from database or servcie. if (!empty($newMsgs)) { return json_encode(['newMsgs' => $newMsgs]); } return false;//return false if no new messages }), 'new-msgs');

Symfony and Laravel demo

Server: sending events from the server by Laravel or Symfony

use Hhxsv5\SSE\SSE; use Hhxsv5\SSE\Update; //Action method in the controller public function newMsgs() { $response = new \Symfony\Component\HttpFoundation\StreamedResponse(); $response->headers->set('Content-Type', 'text/event-stream'); $response->headers->set('Cache-Control', 'no-cache'); $response->headers->set('Connection', 'keep-alive'); $response->headers->set('X-Accel-Buffering', 'no');//Nginx: unbuffered responses suitable for Comet and HTTP streaming applications $response->setCallback(function () { (new SSE())->start(new Update(function () { $id = mt_rand(1, 1000); $newMsgs = [['id' => $id, 'title' => 'title' . $id, 'content' => 'content' . $id]];//get data from database or servcie. if (!empty($newMsgs)) { return json_encode(['newMsgs' => $newMsgs]); } return false;//return false if no new messages }), 'new-msgs'); }); return $response; }

License

MIT

About

A simple and efficient library implemented HTML5's server-sent events by PHP, is used to real-time push events from server to client, and easier than Websocket, instead of AJAX request.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 5

Languages