README

👁 Packagist Version
👁 Total Downloads
👁 Monthly Downloads
👁 PHP Version
👁 Workerman
👁 CI
👁 License

A server-side PHP implementation of socket.io based on Workerman.

Notice: Only supports socket.io client >= v1.3.0 and <= v2.x. socket.io v3 and v4 are not supported. Requires PHP >= 7.1 and Workerman >= 4.0 < 5.0. Workerman 5.x is not supported. For the full server API, see socket.io/docs/v2/server-api.

Install

composer require workerman/phpsocket.io

Examples

Simple chat

start.php

<?php

use Workerman\Worker;
use PHPSocketIO\SocketIO;

require_once __DIR__ . '/vendor/autoload.php';

// Listen on port 2026 for socket.io clients
$io = new SocketIO(2026);

$io->on('connection', function ($socket) use ($io) {
 $socket->on('chat message', function ($msg) use ($io) {
 $io->emit('chat message', $msg);
 });
});

Worker::runAll();

Another chat demo

Full source: examples/chat/start_io.php

<?php

use Workerman\Worker;
use PHPSocketIO\SocketIO;

require_once __DIR__ . '/vendor/autoload.php';

$io = new SocketIO(2026);

$io->on('connection', function ($socket) {
 $socket->addedUser = false;

 // When the client emits 'new message', this listens and executes
 $socket->on('new message', function ($data) use ($socket) {
 $socket->broadcast->emit('new message', [
 'username' => $socket->username,
 'message' => $data,
 ]);
 });

 // When the client emits 'add user', this listens and executes
 $socket->on('add user', function ($username) use ($socket) {
 // Note: global variables are used here for simplicity (demo only)
 global $usernames, $numUsers;

 $socket->username = $username;
 $usernames[$username] = $username;
 ++$numUsers;

 $socket->addedUser = true;
 $socket->emit('login', ['numUsers' => $numUsers]);

 $socket->broadcast->emit('user joined', [
 'username' => $socket->username,
 'numUsers' => $numUsers,
 ]);
 });

 // When the client emits 'typing', broadcast it to others
 $socket->on('typing', function () use ($socket) {
 $socket->broadcast->emit('typing', ['username' => $socket->username]);
 });

 // When the client emits 'stop typing', broadcast it to others
 $socket->on('stop typing', function () use ($socket) {
 $socket->broadcast->emit('stop typing', ['username' => $socket->username]);
 });

 // When the user disconnects
 $socket->on('disconnect', function () use ($socket) {
 global $usernames, $numUsers;

 if ($socket->addedUser) {
 unset($usernames[$socket->username]);
 --$numUsers;

 $socket->broadcast->emit('user left', [
 'username' => $socket->username,
 'numUsers' => $numUsers,
 ]);
 }
 });
});

Worker::runAll();

Enable SSL (HTTPS)

Requires phpsocket.io >= 1.1.1 and workerman >= 3.3.7

start.php

<?php

use Workerman\Worker;
use PHPSocketIO\SocketIO;

require_once __DIR__ . '/vendor/autoload.php';

$context = [
 'ssl' => [
 'local_cert' => '/your/path/of/server.pem',
 'local_pk' => '/your/path/of/server.key',
 'verify_peer' => false,
 ],
];

$io = new SocketIO(2026, $context);

$io->on('connection', function ($socket) {
 echo "New connection: {$socket->id}\n";
});

Worker::runAll();

Acknowledgement callback

<?php

use Workerman\Worker;
use PHPSocketIO\SocketIO;

require_once __DIR__ . '/vendor/autoload.php';

$io = new SocketIO(2026);

$io->on('connection', function ($socket) {
 $socket->on('message with ack', function ($data, $callback) {
 if ($callback && is_callable($callback)) {
 $callback(0);
 }
 });
});

Worker::runAll();

Run chat example

With Docker

docker compose up --build

Then open your browser at:

• Chat: http://localhost:2027
• Socket.IO: port 2026

Without Docker

cd examples/chat

php start.php start # debug mode
php start.php start -d # daemon mode
php start.php stop # stop
php start.php status # status

Then open http://localhost:2027 in your browser.

Server debug output

The chat example includes built-in server-side logging. When running in debug mode, connections, user activity, and messages are printed to the terminal in real time with color-coded output.

CI

This project uses GitHub Actions to run PHP_CodeSniffer on every pull request and push to master, ensuring the codebase follows the coding standard defined in phpcs.xml.

To run locally:

# Without Docker
composer install --dev
vendor/bin/phpcs src/

# With Docker
docker compose --profile tools run --rm phpcs

License

MIT