Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DenisOgr/yii2-cronjobs
yii2-cronjobs
https://github.com/DenisOgr/yii2-cronjobs
Last synced: 3 months ago
JSON representation
yii2-cronjobs
- Host: GitHub
- URL: https://github.com/DenisOgr/yii2-cronjobs
- Owner: DenisOgr
- Created: 2014-07-16T11:41:22.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-04-16T11:40:58.000Z (over 3 years ago)
- Last Synced: 2024-10-09T21:17:09.884Z (3 months ago)
- Language: PHP
- Size: 15.6 KB
- Stars: 48
- Watchers: 11
- Forks: 37
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-yii2 - DenisOgr/yii2-cronjobs
README
Yii2 cronjobs extension
========
Easiest way to put crontab on your console scripts.
This extension is based on [this](https://github.com/Yiivgeny/Yii-PHPDocCrontab).
Thanks [Yiivgeny](https://github.com/Yiivgeny).
But with a few changes:
- Work eith yii2
- Set config in params (not in phpDocs).
I transfer settings of crontab in local settings(params) configuration, so that the application can be run on different servers with different sets of crontab.
Installation
------------
- **Step 1:** The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist denisogr/yii2-cronjobs "dev-master"
```
or add
```
"denisogr/yii2-cronjobs": "dev-master"
```
to the require section of your `composer.json` file.
- **Step 2:** Set aliase @runnerScript in console config. This absolutely path to runner script (I can not find another way to get runner script).
Change path to runner script as your project (For Yii2 Basic application).
```
Yii::setAlias('@runnerScript', dirname(__DIR__) .'/yii');
```
- **Step 3:** Add to console config:
```
'controllerMap' => [
'cron' => [
'class' => 'denisog\cronjobs\CronController'
],
],
```
- **Step 4:** Add task to system scheduler (cron on unix, task scheduler on windows) to run every minute:
```sh
* * * * * /path/to/yii/application/protected/yiic cron
```
Usage
-----
Add in params array with cron sets:
```
'cronJobs' =>[
'test/example1' => [
'cron' => '* * * * *',
],
'test/example2' => [
'cron' => '10 * * * *',
],
],
```
You can point any settings from [this](https://github.com/Yiivgeny/Yii-PHPDocCrontab/blob/master/examples/ExampleRuCommand.php).