Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/udokmeci/yii2-beanstalk
Yii2 beanstalk web and console component
https://github.com/udokmeci/yii2-beanstalk
yii yii2-beanstalk
Last synced: 25 days ago
JSON representation
Yii2 beanstalk web and console component
- Host: GitHub
- URL: https://github.com/udokmeci/yii2-beanstalk
- Owner: udokmeci
- Created: 2014-11-20T14:20:45.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2021-05-21T08:47:55.000Z (over 3 years ago)
- Last Synced: 2024-09-30T22:18:28.670Z (about 1 month ago)
- Topics: yii, yii2-beanstalk
- Language: PHP
- Size: 141 KB
- Stars: 70
- Watchers: 9
- Forks: 27
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-yii2 - yii2-beanstalk
README
yii2-beanstalk
==============
Yii2 [beanstalkd][1] web and console component which is an interface on the top of [pda/pheanstalk][2]. Thanks [Paul Annesley][3] for such a complete work.
[1]: http://xph.us/software/beanstalkd/
[2]: https://github.com/pda/pheanstalk
[3]: http://paul.annesley.cc/
How to use?
==============
## Installation with Composer
Just add the line under `require` object in your `composer.json` file.
``` json
{
"require": {
...
"udokmeci/yii2-beanstalk" : "^1.0.0"
}
}
```
Then run
``` console
$> composer update
```
## Configuration
Now add following lines in to your `main` and `console` configuration file under `components`
``` php
'beanstalk'=>[
'class' => 'udokmeci\yii2beanstalk\Beanstalk',
'host' => '127.0.0.1', // default host
'port' => 11300, //default port
'connectTimeout' => 1,
'sleep' => false, // or int for usleep after every job
],
```
Now add following in to your `console` configuration only.
``` php
...
'params' => $params,
// add you controller with name and class name next to params.
'controllerMap' => [
'worker' => [
'class' => 'app\commands\WorkerController',
]
],
```
## Producing
Now if everything is fine, you can run `beandstalkd` and access to controller as
``` php
\Yii::$app->beanstalk
->putInTube('tube', $mixedData, $priority, $delay);
```
`$mixedData` is added on v1.0 for complex usage. Anything else then `string` will be send as `json` format. So you can sent anything within it suppoted by `json`.
## Worker
For worker it also has a built in controller which runs an infinite loop and wait for new jobs. Most of the work is done in `BeanstalkController`. All you have to do is to create a controller and action like below.
### Controller
Create a controller under your `commands` folder. Give the name anything you want to it and `extend` your controller from `udokmeci\yii2beanstalk\BeanstalkController`
##### Example Controller
``` php
getData();
try {
// something useful here
if($everythingIsAllRight == true){
fwrite(STDOUT, Console::ansiFormat("- Everything is allright"."\n", [Console::FG_GREEN]));
//Delete the job from beanstalkd
return self::DELETE;
}
if($everythingWillBeAllRight == true){
fwrite(STDOUT, Console::ansiFormat("- Everything will be allright"."\n", [Console::FG_GREEN]));
//Delay the for later try
//You may prefer decay to avoid endless loop
return self::DELAY;
}
if($IWantSomethingCustom==true){
Yii::$app->beanstalk->release($job);
return self::NO_ACTION;
}
fwrite(STDOUT, Console::ansiFormat("- Not everything is allright!!!"."\n", [Console::FG_GREEN]));
//Decay the job to try DELAY_MAX times.
return self::DECAY;
// if you return anything else job is burried.
} catch (\Exception $e) {
//If there is anything to do.
fwrite(STDERR, Console::ansiFormat($e."\n", [Console::FG_RED]));
// you can also bury jobs to examine later
return self::BURY;
}
}
}
```
##### Running Worker
Running console is the easiest part. Run ./yii Your `controller`
``` console
$> php ./yii worker
```
Controller will tell you, whether there are actions for correspanding tubes or beanstalk server is accessible and which tubes are listening currently. The controller handles with signals. So exit whenever you want, reserved job will not be hanged.
Any forks are welcome.