lantongxue/yii3-swoole

Yii3 Swoole Extension

dev-main 2025-11-26 16:39 UTC

Requires

• php: >=8.1
• ext-swoole: *
• nyholm/psr7: ^1.8
• yiisoft/yii-console: ^2.4
• yiisoft/yii-runner-http: ^3.2

Requires (Dev)

• phpunit/phpunit: ^10.0
• swoole/ide-helper: ^5.0

BSD-3-Clause

• async
• swoole
• high-performance
• yii3

README

This extension provides Swoole support for Yii3. It allows you to run your Yii3 application using Swoole's high-performance HTTP server.

Requirements

• PHP 8.1 or higher
• Swoole PHP Extension

Installation

The package could be installed with Composer:

composer require lantongxue/yii3-swoole

Usage

1. Configure the Console Command

The package automatically provides the configuration for the StartCommand if you use yiisoft/config.

If you are not using yiisoft/config, add the StartCommand to your console application configuration manually:

use Yii3Swoole\Command\StartCommand;
use Yii3Swoole\Server;

return [
    StartCommand::class => [
        '__construct()' => [
            'server' => Server::class,
        ],
    ],
    Server::class => [
        '__construct()' => [
            'rootPath' => $params['yiisoft/yii-runner-http']['rootPath'] ?? dirname(__DIR__),
            'debug' => $params['yiisoft/yii-runner-http']['debug'] ?? false,
            'checkEvents' => $params['yiisoft/yii-runner-http']['checkEvents'] ?? false,
            'environment' => $params['yiisoft/yii-runner-http']['environment'] ?? null,
        ],
    ],
];

2. Start the Server

Run the console command to start the Swoole server:

./yii swoole/start

You can specify the host and port:

./yii swoole/start --host=0.0.0.0 --port=9501

Features

• Swoole Server Integration: Runs Yii3 application within a Swoole HTTP server.
• PSR-7 Bridge: Transparently converts Swoole requests to PSR-7 requests and emits PSR-7 responses to Swoole.
• High Performance: Leverages Swoole's async capabilities (note: application logic must be async-safe).

License

The BSD 3-Clause License. Please see License File for more information.