Laravel 5 task scheduling with cron job example

Posted 8 years ago By Ajay Gupta 250773

Laravel 5 task scheduling with cron job example

If you want to execute scheduling jobs in specific time and specific interval then you can apply cron job which is a Unix command.

We can manage a task in the server that executes scripts which helps in sending daily/weekly reports from our website.

The main use of cron job is in cleaningup the databases, sending the emails, executing the time consuming tasks etc. We can simply delete files from the database with the help of Cron Job.

Cron job will only work on unix based machines. It consists of a configuration file called Crontable which is also known as Crontab.

This Cron tab is used to manage the scheduling and consists of different cron jobs and each of the cron job is associated with a specific task.

Generate A New Command Class :

First, we will generate our own custom commands by running following commands which will generate a class in the app/Console/Commands/ directory.

php artisan make:console CustomCommand

After running this command you will get a message 'Console command created successfully. ' on your terminal and then it generate a class file at app/Console/Commands/CustomCommand.php with default signature but you can assign the terminal command name by using --command option.

php artisan make:console CustomCommand --command=custom:command

Whenever command will be executed in your terminal then handle method of command class is called so i will write a code to delete all inactive users in handle method.

namespace App\Console\Commands;
use Illuminate\Console\Command;
use DB;
class CustomCommand extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'custom:command';
    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Delete all inactive users';
    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }
    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        DB::table('users')->where('active', 0)->delete();
        $this->info('All inactive users are deleted successfully!');
    }
}

where('active', 0)->delete();
        $this->info('All inactive users are deleted successfully!');
    }
}

Now we have to register our new command with Artisan so that it will be available in terminal. For this we just need to add this command class name to commands array in Kernerl class that is available in app/Console/Kernel.php.

app/Console/Kernel.php

namespace App\Console;
use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
class Kernel extends ConsoleKernel
{
    /**
     * The Artisan commands provided by your application.
     *
     * @var array
     */
    protected $commands = [
         Commands\CustomCommand::class,
    ];
    /**
     * Define the application's command schedule.
     *
     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
     * @return void
     */
    protected function schedule(Schedule $schedule)
    {
          $schedule->command('custom:command')->daily();
    }
}

command('custom:command')->daily();
    }
}

If you want to see your command description in terminal then run following command :

$ php artisan list

custom
  custom:command      Delete all inactive users

custom
  custom:command      Delete all inactive users

Now you can run your command to delete all inactive users.

$ php artisan custom:command

All inactive users are deleted successfully!

As you notice i schedule the command on daily basis but there are number of schedule frequencies which you can assign to the tasks.

Schedule tasks hourly basis

$schedule->command('custom:command')
         ->hourly();

$schedule->command('custom:command')
         ->hourly();

Schedule tasks on given time

$schedule->command('custom:command')
         ->dailyAt('07:00');

$schedule->command('custom:command')
         ->dailyAt('07:00');

Schedule tasks weekly basis

$schedule->command('custom:command')
         ->weekly();

$schedule->command('custom:command')
         ->weekly();

Schedule tasks monthly basis

$schedule->command('custom:command')
         ->monthly();

$schedule->command('custom:command')
         ->monthly();

If you wan to start the scheduler itself then you will have to add one cron job on server using the crontab -e command.

* * * * * php /path/to/artisan schedule:run >> /dev/null 2>&1

Using this, Laravel command scheduler will be called by cron every minute.

You can use cron job to send birthday sms, email notification to user to activate their accounts etc.

Laravel 5 task scheduling with cron job example

Laravel 5 task scheduling with cron job example

Tags :

Related Posts