Download the PHP package webtoolsnz/yii2-scheduler without Composer
On this page you can find all versions of the php package webtoolsnz/yii2-scheduler. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download webtoolsnz/yii2-scheduler
More information about webtoolsnz/yii2-scheduler
Files in webtoolsnz/yii2-scheduler
Package yii2-scheduler
Short Description A scheduled task runner for Yii2 applications
License proprietary
Homepage https://github.com/webtoolsnz/yii2-scheduler
Informations about the package yii2-scheduler
yii2-scheduler
A scheduled task manager for yii2
Installation
The preferred way to install this extension is through composer.
Install using the following command.
$ composer require webtoolsnz/yii2-scheduler
Now that the package has been installed you need to configure the module in your application
The config/console.php
file should be updated to reflect the changes below
'bootstrap' => ['log', 'scheduler'],
'modules' => [
'scheduler' => ['class' => 'webtoolsnz\scheduler\Module'],
],
'components' => [
'errorHandler' => [
'class' => 'webtoolsnz\scheduler\ErrorHandler'
],
'log' => [
'traceLevel' => YII_DEBUG ? 3 : 0,
'targets' => [
[
'class' => 'yii\log\EmailTarget',
'mailer' =>'mailer',
'levels' => ['error', 'warning'],
'message' => [
'to' => ['[email protected]'],
'from' => [$params['adminEmail']],
'subject' => 'Scheduler Error - ####SERVERNAME####'
],
'except' => [
],
],
],
],
]
also add this to the top of your config/console.php
file
\yii\base\Event::on(
\webtoolsnz\scheduler\console\SchedulerController::className(),
\webtoolsnz\scheduler\events\SchedulerEvent::EVENT_AFTER_RUN,
function ($event) {
if (!$event->success) {
foreach($event->exceptions as $exception) {
throw $exception;
}
}
}
);
To implement the GUI for scheduler also add the following to your config/web.php
'bootstrap' => ['log', 'scheduler'],
'modules' => [
'scheduler' => ['class' => 'webtoolsnz\scheduler\Module'],
],
After the configuration files have been updated, a tasks
directory will need to be created in the root of your project.
Run the database migrations, which will create the necessary tables for scheduler
php yii migrate up --migrationPath=vendor/webtoolsnz/yii2-scheduler/src/migrations
Add a controller
Example Task
You can now create your first task using scheduler, create the file AlphabetTask.php
inside the tasks
directory in your project root.
Paste the below code into your task:
The above code defines a simple task that runs at the start of every hour, and prints the alphabet.
The $schedule
property of this class defines how often the task will run, these are simply Cron Expression
Running the tasks
Scheduler provides an intuitive CLI for executing tasks, below are some examples
In order to have your tasks run automatically simply setup a crontab like so
Events & Errors
Events are thrown before and running individual tasks as well as at a global level for multiple tasks
Task Level
or at the global level, to throw errors in /yii
You could throw the exceptions at the task level, however this will prevent further tasks from running.
License
The MIT License (MIT). Please see LICENSE for more information.
All versions of yii2-scheduler with dependencies
mtdowling/cron-expression Version ~1.0
webtoolsnz/yii2-widgets Version *