{"id":21985636,"url":"https://github.com/bazilio91/yii2-async","last_synced_at":"2025-08-21T23:32:14.245Z","repository":{"id":18425999,"uuid":"21608401","full_name":"bazilio91/yii2-async","owner":"bazilio91","description":"Provides translucent api \u0026 queues for moving large tasks out of request context with SQL, Redis or AMQP.","archived":false,"fork":false,"pushed_at":"2020-04-09T22:36:51.000Z","size":64,"stargazers_count":63,"open_issues_count":0,"forks_count":18,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-12-13T05:36:54.484Z","etag":null,"topics":["amqp","mysql","php","queue","redis","yii2"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bazilio91.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-07-08T10:18:18.000Z","updated_at":"2024-01-29T11:15:31.000Z","dependencies_parsed_at":"2022-09-24T08:50:45.636Z","dependency_job_id":null,"html_url":"https://github.com/bazilio91/yii2-async","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bazilio91%2Fyii2-async","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bazilio91%2Fyii2-async/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bazilio91%2Fyii2-async/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bazilio91%2Fyii2-async/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bazilio91","download_url":"https://codeload.github.com/bazilio91/yii2-async/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230542287,"owners_count":18242332,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["amqp","mysql","php","queue","redis","yii2"],"created_at":"2024-11-29T18:14:15.291Z","updated_at":"2024-12-20T06:05:45.735Z","avatar_url":"https://github.com/bazilio91.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"yii2-async\n=========\n[![Build Status](https://travis-ci.org/bazilio91/yii2-async.svg?branch=master)](https://travis-ci.org/bazilio91/yii2-async)\n[![Latest Stable Version](https://poser.pugx.org/bazilio/yii2-async/v/stable)](https://packagist.org/packages/bazilio/yii2-async) \n[![Total Downloads](https://poser.pugx.org/bazilio/yii2-async/downloads)](https://packagist.org/packages/bazilio/yii2-async) \n[![Latest Unstable Version](https://poser.pugx.org/bazilio/yii2-async/v/unstable)](https://packagist.org/packages/bazilio/yii2-async) \n[![License](https://poser.pugx.org/bazilio/yii2-async/license)](https://packagist.org/packages/bazilio/yii2-async)\n\nProvides translucent api for moving large tasks out of request response\n\nInstall: `php composer.phar require bazilio/yii2-async:dev-master`\n\n##### Requirments:\n- php \u003e=5.4\n- Transports:\n  - `yii\\db\\Connection`\n  - [php-amqp](https://github.com/pdezwart/php-amqp)\n  - [yii2-redis](https://github.com/yiisoft/yii2-redis)\n\n##### Using with AMQP:\n`php composer.phar require pdezwart/php-amqp:dev-master`\n\nmain.php:\n```php\n'components' =\u003e [\n    'async' =\u003e [\n        'class' =\u003e 'bazilio\\async\\AsyncComponent',\n        'transportClass' =\u003e 'bazilio\\async\\transports\\AsyncAmqpTransport',\n        'transportConfig' =\u003e [\n            'host' =\u003e 'localhost',\n            'login' =\u003e 'guest',\n            'password' =\u003e 'guest',\n            'vhost' =\u003e 'yii',\n            'exchangeName' =\u003e 'yii'\n        ]\n    ]\n]\n```\n\n\n##### Using with Redis:\n`php composer.phar require yiisoft/yii2-redis:*`\n\nmain.php:\n```php\n'components' =\u003e [\n    'redis' =\u003e [\n        'class' =\u003e 'yii\\redis\\Connection',\n        'hostname' =\u003e 'localhost',\n        'port' =\u003e 6379,\n        'database' =\u003e 0,\n        'dataTimeout' =\u003e -1, // important for daemon and blocking queries\n    ],\n    'async' =\u003e [\n        'class' =\u003e 'bazilio\\async\\AsyncComponent',\n        'transportClass' =\u003e 'bazilio\\async\\transports\\AsyncRedisTransport',\n        'transportConfig' =\u003e [\n            'connection' =\u003e 'redis',\n        ]\n    ]\n]\n```\n\n##### Using with MySQL (probably any sql, but tested only with mysql)\n\nmain.php:\n```php\n'components' =\u003e [\n    'db' =\u003e [\n        'class' =\u003e 'yii\\db\\Connection',\n        'dsn' =\u003e 'mysql:host=localhost;dbname=yii2advenced',\n        'username' =\u003e 'root',\n        'password' =\u003e '',\n        'charset' =\u003e 'utf8',\n    ],\n    'async' =\u003e [\n        'class' =\u003e 'bazilio\\async\\AsyncComponent',\n        'transportClass' =\u003e 'bazilio\\async\\transports\\AsyncMysqlTransport',\n        'transportConfig' =\u003e [\n            'connection' =\u003e 'db',\n        ]\n    ]\n]\n```\n\nApply migrations:\n```php\n./yii migrate/up --migrationPath=@vendor/bazilio/yii2-async/migrations\n```\n\n##### Usage:\n\n#### Create and send:\nTest class example:\n```php\nclass DownloadTask extends AsyncTask\n{\n    public $url;\n    public $file;\n    public static $queueName = 'downloads';\n\n    public function execute()\n    {\n        return file_put_contents($this-\u003efile, file_get_contents($this-\u003eurl));\n    }\n}\n\n// create task\n$task = new DownloadTask(['url' =\u003e 'http://localhost/', 'file' =\u003e '/tmp/localhost.html']);\n\\Yii::$app-\u003easync-\u003esendTask($task);\n```\n\nOr call external method:\n```php\n$task = new AsyncExecuteTask([\n    'class' =\u003e 'common\\components\\MyDownloaderComponent',\n    'method' =\u003e 'download',\n    'arguments' =\u003e ['url' =\u003e 'http://localhost/', 'file' =\u003e '/tmp/localhost.html']\n]);\n\n\n$task::$queueName = 'downloads';\n\nif (YII_ENV !== 'prod') {\n    $task-\u003eexecute();\n} else {\n    Yii::$app-\u003easync-\u003esendTask($task);\n}\n```\n\n#### Execute:\n\nBash way:\n\nFill console config:\n```php\n'controllerMap' =\u003e [\n        'async-worker' =\u003e [\n            'class' =\u003e 'bazilio\\async\\commands\\AsyncWorkerCommand',\n        ],\n    ],\n```\n\nRun:\n```bash\n# Process and exit on finish\n./yii async-worker/execute downloads\n# Process and wait for new tasks (only redis)\n./yii async-worker/daemon downloads\n```\n\nCode way:\n\n```php\nwhile ($task = \\Yii::$app-\u003easync-\u003ereceiveTask('downloads')) {\n    if ($task-\u003eexecute()) {\n        \\Yii::$app-\u003easync-\u003eacknowledgeTask($task);\n    }\n}\n```        \n\nFor more code examples look into tests:\n- [BaseTestClass](tests/unit/BaseTestClass.php)\n\n\n###### Runing tests:\n~~~\nvendor/bin/codecept run\n~~~\nOr in Docker:\n~~~\n./test.sh\n~~~\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbazilio91%2Fyii2-async","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbazilio91%2Fyii2-async","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbazilio91%2Fyii2-async/lists"}