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.
- PHP 5.4 or later
Installation via Composer(packagist)
composer require "hhxsv5/php-sse:~1.0" -vvv
- Run PHP webserver
cd examples
php -S 127.0.0.1:9001 -t .
- Open url
http://127.0.0.1:9001/index.html
Client: receiving events from the server.
// withCredentials=true: pass the cross-domain cookies to server-side
const source = new EventSource('http://127.0.0.1:9001/push.php', {withCredentials:true});
source.addEventListener('news', function(event) {
console.log(event.data);
// source.close(); // disconnect stream
}, false);
Server: sending events from the server by pure php.
include '../vendor/autoload.php';
use Hhxsv5\SSE\SSE;
use Hhxsv5\SSE\Update;
// Example: push messages to client
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);
$news = [['id' => $id, 'title' => 'title ' . $id, 'content' => 'content ' . $id]]; // Get news from database or service.
if (empty($news)) {
return false; // Return false if no new messages
}
return json_encode(compact('news'));
}), 'news');
Server: sending events from the server by Laravel or Symfony.
use Hhxsv5\SSE\SSE;
use Hhxsv5\SSE\Update;
// Action method in controller
public function getNewsStream()
{
$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);
$news = [['id' => $id, 'title' => 'title ' . $id, 'content' => 'content ' . $id]]; // Get news from database or service.
if (empty($news)) {
return false; // Return false if no new messages
}
return json_encode(compact('news'));
}), 'news');
});
return $response;
}