Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pachico/slim-swoole
Convenient library to run SlimPHP applications with Swoole
https://github.com/pachico/slim-swoole
slim slim-framework swoole swoole-framework
Last synced: 29 days ago
JSON representation
Convenient library to run SlimPHP applications with Swoole
- Host: GitHub
- URL: https://github.com/pachico/slim-swoole
- Owner: pachico
- License: mit
- Archived: true
- Created: 2018-02-01T15:01:21.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-03-14T15:23:48.000Z (over 3 years ago)
- Last Synced: 2024-10-13T03:40:12.110Z (2 months ago)
- Topics: slim, slim-framework, swoole, swoole-framework
- Language: PHP
- Homepage: https://github.com/pachico/slim-swoole/
- Size: 42 KB
- Stars: 95
- Watchers: 11
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-swoole - pachico/Slim-Swoole - A convenient library to run [SlimPHP](https://www.slimframework.com) applications with Swoole. (Framework Integration)
- awesome-swoole - Slim-Swoole - Convenient library to run SlimPHP applications with Swoole. (Integration)
README
# slim-swoole
[](https://scrutinizer-ci.com/g/pachico/slim-swoole/?branch=master)
[](https://scrutinizer-ci.com/g/pachico/slim-swoole/?branch=master)
[](https://travis-ci.org/pachico/slim-swoole)
[](LICENSE)
This is a brige library to run [Slim framework](https://www.slimframework.com/) Slim framework applications using [Swoole engine](https://www.swoole.co.uk/).
## Overview
The main purpose of this library is to easily run your already existing SlimPHP applications using Swoole Framework.
It requires you to bootstrap your application only once when you start Swoole HTTP server and, thanks to its event driven design, it will process each request reusing your already started application for better performance.
The execution sequence is as follows:
1. You bootstrap your SlimPHP application as you would normally do.
2. You instantiate the `BrigeManager` passing to it your SlimPHP application.
3. You start Swoole's HTTP server.
4. You bind to the `on('request')` event handler the `BridgeManager` instance which will:
1. Transform the Swoole request to a SlimPHP based on server and request attributes.
2. Process your request through SlimPHP's application stack (including middlewares)
3. Merge SlimPHP Response to Swoole Response
4. End the request.
All this is done under the hood, so you will just need to call:
```php
$bridgeManager->process($swooleRequest, $swooleResponse)->end();
```
(See usage paragraph for a complete example.)
**Caution**: it is still in development so any contribution and test will be more than welcome.
## Requirements
* PHP-CLI >= 7.0 (Required by Swoole)
* Swoole framework (this has been tested with version 1.10.1)
## Install
Via Composer
``` bash
$ composer require pachico/slim-swoole
```
## Usage
``` php
any('/foo[/{myArg}]', function (Http\Request $request, Http\Response $response, array $args) {
$data = [
'args' => $args,
'body' => (string) $request->getBody(),
'parsedBody' => $request->getParsedBody(),
'params' => $request->getParams(),
'headers' => $request->getHeaders(),
'uploadedFiles' => $request->getUploadedFiles()
];
return $response->withJson($data);
})->add(function (Http\Request $request, Http\Response $response, callable $next) {
$response->getBody()->write('BEFORE' . PHP_EOL);
$response = $next($request, $response);
$response->getBody()->write(PHP_EOL . 'AFTER');
return $response;
});
/**
* We instanciate the BridgeManager (this library)
*/
$bridgeManager = new BridgeManager($app);
/**
* We start the Swoole server
*/
$http = new swoole_http_server("0.0.0.0", 8081);
/**
* We register the on "start" event
*/
$http->on("start", function (\swoole_http_server $server) {
echo sprintf('Swoole http server is started at http://%s:%s', $server->host, $server->port), PHP_EOL;
});
/**
* We register the on "request event, which will use the BridgeManager to transform request, process it
* as a Slim request and merge back the response
*
*/
$http->on(
"request",
function (swoole_http_request $swooleRequest, swoole_http_response $swooleResponse) use ($bridgeManager) {
$bridgeManager->process($swooleRequest, $swooleResponse)->end();
}
);
$http->start();
```
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Testing
``` bash
$ composer test
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Mariano F.co Benítez Mulet](https://github.com/pachico)
- [All Contributors](https://github.com/pachico/slim-swoole/graphs/contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.