Baike.dev
All toolsOnline toolsAI codingTrendingOpen sourceNewsSubmit
Log in
< Back to tools
Y

yii2-scheduling

> 编程语言
Open source

Scheduling extension for Yii2 framework

316 stars0 likes1 views
WebsiteGitHub

About

Scheduling extension for Yii2 framework

Schedule extension for Yii2

This extension is the port of Laravel's Schedule component (https://laravel.com/docs/master/scheduling#scheduling-artisan-commands)

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require omnilight/yii2-scheduling "*"

or add

json
"omnilight/yii2-scheduling": "*"

to the require section of your composer.json.

Requirements

  • PHP 8.0 or higher
  • Yii 2.0

Upgrading from 1.x: cron expressions now use the standard 5-field format (minute hour day month weekday). If you pass custom expressions to ->cron(), drop the trailing sixth *. The built-in helpers (hourly(), daily(), etc.) were updated accordingly.

Description

This project is inspired by the Laravel's Schedule component and tries to bring it's simplicity to the Yii framework. Quote from Laravel's documentation:

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.

After installation all you have to do is to put single line into crontab:

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

You can put your schedule into the schedule.php file, or add it withing bootstrapping of your extension or application

Schedule examples

This extension is support all features of Laravel's Schedule, except environments and maintance mode.

Scheduling Closures

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

})->hourly();

Scheduling Terminal Commands

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

Running command of your application

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

Frequent Jobs

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

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

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

Daily Jobs

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

Daily Jobs At A Specific Time (24 Hour Time)

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

Twice Daily Jobs

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

Job That Runs Every Weekday

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

Weekly Jobs

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

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

Monthly Jobs

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

Job That Runs On Specific Days

php
$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();

Only Allow Job To Run When Callback Is True

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

E-mail The Output Of A Scheduled Job

php
$schedule->command('foo')->sendOutputTo($filePath)->emailOutputTo('[email protected]');

Preventing Task Overlaps

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

Used by default yii\mutex\FileMutex or 'mutex' application component (http://www.yiiframework.com/doc-2.0/yii-mutex-mutex.html)

Running Tasks On One Server

To utilize this feature, you must config mutex in the application component, except the FileMutex: yii\mutex\MysqlMutex,yii\mutex\PgsqlMutex,yii\mutex\OracleMutex or yii\redis\Mutex. In addition, all servers must be communicating with the same central db/cache server.

Below shows the redis mutex demo:

php
'components' => [
    'mutex' => [
        'class' => 'yii\redis\Mutex',
        'redis' => [
            'hostname' => 'localhost',
            'port' => 6379,
            'database' => 0,
        ]
    ],
],
php
$schedule->command('report:generate')
                ->fridays()
                ->at('17:00')
                ->onOneServer();

How to use this extension in your application?

You should create the following file under @console/config/schedule.php (note: you can create file with any name and extension and anywere on your server, simpli ajust the name of the scheduleFile in the command below):

php
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');

Next your should add the following command to your crontab:

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

That's all! Now all your cronjobs will be runned as configured in your schedule.php file.

How to use this extension in your own extension?

First of all, you should include dependency to the omnilight\yii2-scheduling into your composer.json:

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

Next you should create bootstrapping class for your extension, as described in the http://www.yiiframework.com/doc-2.0/guide-structure-extensions.html#bootstrapping-classes

Place into your bootstrapping method the following code:

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

Add to the README of your extension info for the user to register schedule component for the application and add schedule/run command to the crontab as described upper.

Using schedule component

You do not have to use schedule component directly or define it in your application if you use schedule only in your application (and do not want to give ability for extensions to register they own cron jobs). But if you what to give extensions ability to register cronjobs, you should define schedule component in the application config:

php
'schedule' => 'omnilight\scheduling\Schedule',

Using addition functions

If you want to use thenPing method of the Event, you should add the following string to the composer.json of your app:

"guzzlehttp/guzzle": "^7.0"

Note about timezones

Please note, that this is PHP extension, so it use timezone defined in php config or in your Yii's configuration file, so set them correctly.

Issues· 16 open

View all issuesOpen on GitHub

No open issues yet, or sync has not completed.

> Tags

PHP

No comments yet. Be the first to share.

> Details

PublishedAug 1, 2026
UpdatedSep 18, 2026
Category编程语言
PricingOpen source

> Related tools

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言