Swoole Library

How to contribute

Just new pull request (and we need unit tests for new features)

Code requirements

• PHP 7.1+
• PSR1 and PSR12
• Strict type

Develop

• Document
• Examples

Dockerized Local Development

Run following commands to start Docker containers and update Composer packages:

docker-compose up
docker exec -t $(docker ps -qf "name=app") bash -c "composer update -n"

Now you can use commands like following to run examples under folder examples:

docker exec -t $(docker ps -qf "name=app") bash -c "php ./examples/mysqli/base.php"
docker exec -t $(docker ps -qf "name=app") bash -c "php ./examples/pdo/base.php"
docker exec -t $(docker ps -qf "name=app") bash -c "php ./examples/redis/base.php"

You can run unit tests included with following command:

docker exec -t $(docker ps -qf "name=app") bash -c "./vendor/bin/phpunit"

Compatibility Patch (Swoole version <= v4.4.12)

define('SWOOLE_USE_SHORTNAME', true); // or false (it depends on you)

Coding Style Checks and Fixes

To update Composer packages (optional):

docker run --rm -v "$(pwd)":/var/www -t phpswoole/swoole bash -c "composer update -n"

To correct coding standard violations automatically:

docker run --rm -v "$(pwd)":/var/www -t phpswoole/swoole bash -c "composer cs-fix"

License

Apache License Version 2.0 see http://www.apache.org/licenses/LICENSE-2.0.html