Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bazilio91/yii2-async
Provides translucent api & queues for moving large tasks out of request context with SQL, Redis or AMQP.
https://github.com/bazilio91/yii2-async
amqp mysql php queue redis yii2
Last synced: 16 days ago
JSON representation
Provides translucent api & queues for moving large tasks out of request context with SQL, Redis or AMQP.
- Host: GitHub
- URL: https://github.com/bazilio91/yii2-async
- Owner: bazilio91
- License: mit
- Created: 2014-07-08T10:18:18.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-04-09T22:36:51.000Z (over 4 years ago)
- Last Synced: 2024-12-13T05:36:54.484Z (23 days ago)
- Topics: amqp, mysql, php, queue, redis, yii2
- Language: PHP
- Homepage:
- Size: 62.5 KB
- Stars: 63
- Watchers: 9
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
yii2-async
=========
[](https://travis-ci.org/bazilio91/yii2-async)
[](https://packagist.org/packages/bazilio/yii2-async)
[](https://packagist.org/packages/bazilio/yii2-async)
[](https://packagist.org/packages/bazilio/yii2-async)
[](https://packagist.org/packages/bazilio/yii2-async)
Provides translucent api for moving large tasks out of request response
Install: `php composer.phar require bazilio/yii2-async:dev-master`
##### Requirments:
- php >=5.4
- Transports:
- `yii\db\Connection`
- [php-amqp](https://github.com/pdezwart/php-amqp)
- [yii2-redis](https://github.com/yiisoft/yii2-redis)
##### Using with AMQP:
`php composer.phar require pdezwart/php-amqp:dev-master`
main.php:
```php
'components' => [
'async' => [
'class' => 'bazilio\async\AsyncComponent',
'transportClass' => 'bazilio\async\transports\AsyncAmqpTransport',
'transportConfig' => [
'host' => 'localhost',
'login' => 'guest',
'password' => 'guest',
'vhost' => 'yii',
'exchangeName' => 'yii'
]
]
]
```
##### Using with Redis:
`php composer.phar require yiisoft/yii2-redis:*`
main.php:
```php
'components' => [
'redis' => [
'class' => 'yii\redis\Connection',
'hostname' => 'localhost',
'port' => 6379,
'database' => 0,
'dataTimeout' => -1, // important for daemon and blocking queries
],
'async' => [
'class' => 'bazilio\async\AsyncComponent',
'transportClass' => 'bazilio\async\transports\AsyncRedisTransport',
'transportConfig' => [
'connection' => 'redis',
]
]
]
```
##### Using with MySQL (probably any sql, but tested only with mysql)
main.php:
```php
'components' => [
'db' => [
'class' => 'yii\db\Connection',
'dsn' => 'mysql:host=localhost;dbname=yii2advenced',
'username' => 'root',
'password' => '',
'charset' => 'utf8',
],
'async' => [
'class' => 'bazilio\async\AsyncComponent',
'transportClass' => 'bazilio\async\transports\AsyncMysqlTransport',
'transportConfig' => [
'connection' => 'db',
]
]
]
```
Apply migrations:
```php
./yii migrate/up --migrationPath=@vendor/bazilio/yii2-async/migrations
```
##### Usage:
#### Create and send:
Test class example:
```php
class DownloadTask extends AsyncTask
{
public $url;
public $file;
public static $queueName = 'downloads';
public function execute()
{
return file_put_contents($this->file, file_get_contents($this->url));
}
}
// create task
$task = new DownloadTask(['url' => 'http://localhost/', 'file' => '/tmp/localhost.html']);
\Yii::$app->async->sendTask($task);
```
Or call external method:
```php
$task = new AsyncExecuteTask([
'class' => 'common\components\MyDownloaderComponent',
'method' => 'download',
'arguments' => ['url' => 'http://localhost/', 'file' => '/tmp/localhost.html']
]);
$task::$queueName = 'downloads';
if (YII_ENV !== 'prod') {
$task->execute();
} else {
Yii::$app->async->sendTask($task);
}
```
#### Execute:
Bash way:
Fill console config:
```php
'controllerMap' => [
'async-worker' => [
'class' => 'bazilio\async\commands\AsyncWorkerCommand',
],
],
```
Run:
```bash
# Process and exit on finish
./yii async-worker/execute downloads
# Process and wait for new tasks (only redis)
./yii async-worker/daemon downloads
```
Code way:
```php
while ($task = \Yii::$app->async->receiveTask('downloads')) {
if ($task->execute()) {
\Yii::$app->async->acknowledgeTask($task);
}
}
```
For more code examples look into tests:
- [BaseTestClass](tests/unit/BaseTestClass.php)
###### Runing tests:
~~~
vendor/bin/codecept run
~~~
Or in Docker:
~~~
./test.sh
~~~