Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/logicalsteps/async
async await implementation using generators in php
https://github.com/logicalsteps/async
amphp async async-await asynchronous await callback composer concurrency coroutine event event-loop generator guzzle httplug non-blocking php7 promise reactphp
Last synced: 2 months ago
JSON representation
async await implementation using generators in php
- Host: GitHub
- URL: https://github.com/logicalsteps/async
- Owner: logicalsteps
- License: mit
- Created: 2018-09-25T14:34:31.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-28T09:00:34.000Z (over 4 years ago)
- Last Synced: 2024-10-01T05:41:38.534Z (3 months ago)
- Topics: amphp, async, async-await, asynchronous, await, callback, composer, concurrency, coroutine, event, event-loop, generator, guzzle, httplug, non-blocking, php7, promise, reactphp
- Language: PHP
- Size: 113 KB
- Stars: 4
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Async & Await for PHP
[](https://travis-ci.org/logicalsteps/async)
[](https://scrutinizer-ci.com/g/logicalsteps/async/?branch=master)
[](https://scrutinizer-ci.com/g/logicalsteps/async/?branch=master)
[](https://packagist.org/packages/logicalsteps/async)
[](https://packagist.org/packages/logicalsteps/async)
[](https://packagist.org/packages/logicalsteps/async)
Simplify your asynchronous code and make it readable like synchronous code. It works similar to Async and await in other
languages such as JavaScript and C#
It can be used standalone with callback functions. It also works with the promise interface of the following frameworks
- [ReactPHP](https://github.com/reactphp/promise)
- [Amp](https://amphp.org/amp/promises/)
- [Guzzle](https://github.com/guzzle/promises)
- [Httplug](https://github.com/php-http/promise)
It can do cooperative multitasking with the event loop interfaces of the following frameworks
- [ReactPHP](https://github.com/reactphp/event-loop)
- [Amp](https://amphp.org/amp/event-loop/)
## Installation
Async can be installed with [Composer](http://getcomposer.org)
by adding it as a dependency to your project's composer.json file. It can be done using the following command.
```bash
composer require logicalsteps/async
```
Please refer to [Composer's documentation](https://github.com/composer/composer/blob/master/doc/00-intro.md#introduction)
for more detailed installation and usage instructions.
## Usage
Consider the following example
```php
eth;
$eth->accounts(function ($error, $result) use ($eth, $accountNumber) {
if ($error) {
return;
}
$accounts = $result;
$eth->getBalance($accounts[$accountNumber], function ($error, $result) {
if ($error) {
return;
}
var_export((int)$result->value);
});
});
}
balance(0);
```
If it is all synchronous, our function will simply be
```php
function balance($accountNumber)
{
$web3 = new Web3('http://localhost:8545');
$eth = $web3->eth;
$accounts = $eth->accounts();
$balance = $eth->getBalance($accounts[$accountNumber]);
return (int)$balance->value;
}
var_export(balance(0));
```
With Async library it can be written as the following
```php
use LogicalSteps\Async\Async;
use Web3\Web3;
function balance($accountNumber)
{
$web3 = new Web3('http://localhost:8545');
$eth = $web3->eth;
$accounts = yield [$eth, 'accounts'];
$balance = yield [$eth, 'getBalance', $accounts[$accountNumber]];
$value = (int)$balance->value;
return $value;
}
Async::await(balance(0))->then('var_export');
```
Now the code is clean and looks synchronous, but runs asynchronously for better performance getting us
best of both worlds :)
For more examples and integration with the frameworks take a look at [examples folder](examples)