README

本扩展是Laravel的Schedule组件（https://laravel.net.cn/docs/master/scheduling#scheduling-artisan-commands）的移植。

安装

安装此扩展的最佳方式是通过 composer。

运行以下命令之一

php composer.phar require wodrow/yii2-scheduling "dev-master"

或在您的 composer.json 的 require 部分添加以下内容

"wodrow/yii2-scheduling": "dev-master"

到您的 composer.json 的 require 部分。

描述

本项目受Laravel的Schedule组件启发，试图将它的简洁性带到Yii框架中。引用自Laravel的文档

In the past, developers have generated a Cron entry for each console command they wished to schedule.
However, this is a headache. Your console schedule is no longer in source control,
and you must SSH into your server to add the Cron entries. Let's make our lives easier.

安装后，您只需在crontab中添加一行即可

* * * * * php /path/to/yii yii schedule/run --scheduleFile=@path/to/schedule.php 1>> /dev/null 2>&1

您可以将调度放入 schedule.php 文件中，或者在与您的扩展或应用程序的启动过程中添加

调度示例

此扩展支持Laravel的Schedule的所有功能，除了环境和维护模式。

调度闭包

$schedule->call(function()
{
    // Do some task...

})->hourly();

调度终端命令

$schedule->exec('composer self-update')->daily();

运行应用程序的命令

$schedule->command('migrate')->cron('* * * * *');

频繁任务

$schedule->command('foo')->everyFiveMinutes();

$schedule->command('foo')->everyTenMinutes();

$schedule->command('foo')->everyThirtyMinutes();

每日任务

$schedule->command('foo')->daily();

每日特定时间的任务（24小时制）

$schedule->command('foo')->dailyAt('15:00');

每日两次的任务

$schedule->command('foo')->twiceDaily();

每周工作日的任务

$schedule->command('foo')->weekdays();

周任务

$schedule->command('foo')->weekly();

// Schedule weekly job for specific day (0-6) and time...
$schedule->command('foo')->weeklyOn(1, '8:00');

月任务

$schedule->command('foo')->monthly();

在特定日期运行的任务

$schedule->command('foo')->mondays();
$schedule->command('foo')->tuesdays();
$schedule->command('foo')->wednesdays();
$schedule->command('foo')->thursdays();
$schedule->command('foo')->fridays();
$schedule->command('foo')->saturdays();
$schedule->command('foo')->sundays();

仅当回调为真时允许任务运行

$schedule->command('foo')->monthly()->when(function()
{
    return true;
});

通过电子邮件发送计划任务的输出

$schedule->command('foo')->sendOutputTo($filePath)->emailOutputTo('foo@example.com');

防止任务冲突

$schedule->command('foo')->withoutOverlapping();

默认使用 yii\mutex\FileMutex 或 'mutex' 应用程序组件（https://yiiframework.cn/doc-2.0/yii-mutex-mutex.html）

在一个服务器上运行任务

要利用此功能，您必须在应用程序组件中配置mutex，除了FileMutex： yii\mutex\MysqlMutex，yii\mutex\PgsqlMutex，yii\mutex\OracleMutex 或 yii\redis\Mutex。此外，所有服务器必须与相同的中央数据库/缓存服务器通信。

以下显示redis mutex演示

'components' => [
    'mutex' => [
        'class' => 'yii\redis\Mutex',
        'redis' => [
            'hostname' => 'localhost',
            'port' => 6379,
            'database' => 0,
        ]
    ],
],

$schedule->command('report:generate')
                ->fridays()
                ->at('17:00')
                ->onOneServer();

如何在您的应用程序中使用此扩展？

您应该在 @console/config/schedule.php 下创建以下文件（注意：您可以在您的服务器上的任何位置创建具有任何名称、扩展名的文件，只需简单调整以下命令中的scheduleFile名称即可）

<?php
/**
 * @var \wodrow\scheduling\Schedule $schedule
 */

// Place here all of your cron jobs

// This command will execute ls command every five minutes
$schedule->exec('ls')->everyFiveMinutes();

// This command will execute migration command of your application every hour
$schedule->command('migrate')->hourly();

// This command will call callback function every day at 10:00
$schedule->call(function(\yii\console\Application $app) {
    // Some code here...
})->dailyAt('10:00');

接下来，您应该在crontab中添加以下命令

* * * * * php /path/to/yii yii schedule/run --scheduleFile=@console/config/schedule.php 1>> /dev/null 2>&1

这就完成了！现在，您的所有cron作业将按照在您的schedule.php文件中配置的方式运行。

如何在您的扩展中使用此扩展？

首先，您应该在您的 composer.json 中包含对 wodrow\yii2-scheduling 的依赖

...
'require': {
    "wodrow/yii2-schedule": "*"
}
...

接下来，您应该为您的扩展创建启动类，如https://yiiframework.cn/doc-2.0/guide-structure-extensions.html#bootstrapping-classes中所述

在您的启动方法中放置以下代码

public function bootstrap(Application $app)
{
    if ($app instanceof \yii\console\Application) {
        if ($app->has('schedule')) {
            /** @var wodrow\scheduling\Schedule $schedule */
            $schedule = $app->get('schedule');
            // Place all your shedule command below
            $schedule->command('my-extension-command')->dailyAt('12:00');
        }
    }
}

在您的扩展的README中添加用户注册 schedule 组件的说明，并添加 schedule/run 命令到crontab，如上面所述。

使用 schedule 组件

如果您只是在您的应用中使用计划任务（且不想允许扩展注册它们自己的定时任务），您不需要直接使用 schedule 组件或在您的应用中定义它。但如果您想允许扩展注册定时任务，您应该在应用配置中定义 schedule 组件。

'schedule' => 'wodrow\scheduling\Schedule',

使用附加功能

如果您想使用 Event 的 thenPing 方法，您应该将以下字符串添加到您的应用的 composer.json 文件中：

"guzzlehttp/guzzle": "~5.0"

关于时区的注意

请注意，这是一个 PHP 扩展，因此它使用 PHP 配置或您的 Yii 配置文件中定义的时区，因此请正确设置它们。