https://github.com/vuongxuongminh/yii2-async
Provide an easy way to run code asynchronous and parallel for Yii2 application
https://github.com/vuongxuongminh/yii2-async
Last synced: 7 months ago
JSON representation
Provide an easy way to run code asynchronous and parallel for Yii2 application
- Host: GitHub
- URL: https://github.com/vuongxuongminh/yii2-async
- Owner: vuongxuongminh
- License: bsd-3-clause
- Created: 2019-05-03T15:24:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-06-13T02:10:12.000Z (over 6 years ago)
- Last Synced: 2025-03-25T20:11:33.427Z (7 months ago)
- Language: PHP
- Homepage:
- Size: 56.6 KB
- Stars: 23
- Watchers: 2
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Yii2 Async
[](https://packagist.org/packages/vxm/yii2-async)
[](https://packagist.org/packages/vxm/yii2-async)
[](https://travis-ci.org/vuongxuongminh/yii2-async)
[](https://scrutinizer-ci.com/g/vuongxuongminh/yii2-async/?branch=master)
[](https://scrutinizer-ci.com/g/vuongxuongminh/yii2-async/?branch=master)
[](http://www.yiiframework.com/)
## About it
An extension provide an easy way to run code asynchronous and parallel base on [spatie/async](https://github.com/spatie/async) wrapper for Yii2 application.
## Requirements
* [PHP >= 7.1](http://php.net)
* [yiisoft/yii2 >= 2.0.13](https://github.com/yiisoft/yii2)
## Installation
Require Yii2 Async using [Composer](https://getcomposer.org):
```bash
composer require vxm/yii2-async
```
## Usage
### Configure
Add the component to your application configure file:
```php
[
'components' => [
'async' => [
'class' => 'vxm\async\Async',
'appConfigFile' => '@app/config/async.php' // optional when you need to use yii feature in async process.
]
]
]
```
Because async code run in difference process you need to setup yii environment to use
components via property `appConfigFile`. Example of an async app config file:
```php
define('YII_ENV', 'dev');
define('YII_DEBUG', true);
return [
'id' => 'async-app',
'basePath' => __DIR__,
'runtimePath' => __DIR__ . '/runtime',
'aliases' => [
'@frontend' => dirname(__DIR__, 2) . '/frontend',
'@backend' => dirname(__DIR__, 2) . '/backend'
]
];
```
Make sure all of your aliases define in it to support an autoload.
### Run async code
After add it to application components, now you can run an async code:
```php
Yii::$app->async->run(function() {
// do a thing.
});
```
### Async events
When creating asynchronous processes, you can add the following event hooks on a process in the second parameter.
```php
Yii::$app->async->run(function() {
if (rand(1, 2) === 1) {
throw new \YourException;
}
return 123;
}, [
'success' => function ($result) {
echo $result; // 123
},
'catch' => function (\YourException $exception) {
// catch only \YourException
},
'error' => function() {
// catch all exceptions
},
'timeout' => function() {
// call when task timeout default's 15s
}
]);
```
### Wait process
Sometime you need to wait a code executed, just call `wait()` after `run()`:
```php
Yii::$app->async->run(function() {
// do a thing.
})->wait();
```
Or you can wait multi tasks executed:
```php
Yii::$app->async->run([YourAsyncClass::class, 'handleA']);
Yii::$app->async->run([YourAsyncClass::class, 'handleD']);
Yii::$app->async->run([YourAsyncClass::class, 'handleC']);
Yii::$app->async->run([YourAsyncClass::class, 'handleD']);
$results = Yii::$app->async->wait(); // results return from tasks above.
```
### Working with task
Besides using closures, you can also work with a Task. A Task is useful in situations where you need more setup work in the child process.
The Task class makes this easier to do.
```php
use vxm\async\Task;
class MyTask extends Task
{
public $productId;
public function run()
{
// Do the real work here.
}
}
// Do task async use like an anonymous above.
Yii::$app->async->run(new MyTask([
'productId' => 123
]));
```