nyx-solutions / yii2-nyx-cron-jobs
Yii2 nyx Cron Jobs
5.0.0
2022-06-03 03:03 UTC
Requires
- php: >=8.1.0 <8.2
- nyx-solutions/yii2-nyx: ~5.0.0
README
Yii2 NYX Cron Jobs is a Console Crontroller for Yii2 and is responsible to execute jobs in the Crontab.
The current extension is based on DenisOgr/yii2-cronjobs.
Installation
The preferred way to install this extension is through composer.
- Either run
php composer.phar require --prefer-dist "nyx-solutions/yii2-nyx-cron-jobs" "*"
or add
"nyx-solutions/yii2-nyx-cron-jobs": "*"
to the require
section of your application's composer.json
file.
Configuration
Step 1: Set aliase @runnerScript in console config. This absolutely path to runner script.
Yii::setAlias('@runnerScript', dirname(dirname(dirname(__FILE__))) .'/yii');
Step 2: Add to console config:
'controllerMap' => [
'cron' => [
'class' => 'nyx\console\controllers\CronController'
],
],
Step 3: Add task to system scheduler (cron on unix, task scheduler on windows) to run every minute:
* * * * * /path/to/yii/yii cron
Usage
Add in params array with cron sets:
'cronJobs' =>[
'jobs/first' => ['cron' => '* * * * *'],
'jobs/second' => ['cron' => '10 * * * *']
]
License
yii2-nyx-cron-jobs is released under the BSD 3-Clause License. See the bundled LICENSE.md
for details.