{"id":17640,"date":"2020-08-25T07:31:11","date_gmt":"2020-08-25T07:31:11","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=17640"},"modified":"2022-04-13T15:56:37","modified_gmt":"2022-04-13T15:56:37","slug":"how-to-scheduling-task-using-cron-job-in-laravel-application","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/how-to-scheduling-task-using-cron-job-in-laravel-application\/","title":{"rendered":"How to Scheduling Task using Cron Job in Laravel Application"},"content":{"rendered":"\n

Laravel Cronjob offers an elegant Task Scheduling or Laravel Cronjob Scheduling mechanism.<\/p>\n\n\n\n

Applications require some tasks to be run periodically on the server. It could be creating backups or generating site traffic reports, sending promotional emails, or optimizing the database.<\/p>\n\n\n\n

Step1-<\/strong> Open command prompt or Git Bash on xampp\/htdocs directory<\/p>\n\n\n\n

\"\"\/<\/figure>\n\n\n\n

Step2-<\/strong> Create Laravel New Project write this command<\/p>\n\n\n

composer create-project --prefer-dist laravel\/laravel devopsschool \"5.8.*\"<\/span><\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\"\"\/<\/figure>\n\n\n\n
Step3-<\/strong> Move to project directory on git bash<\/p>\n\n\n
cd devopsschool<\/code><\/span><\/pre>\n\n\n
\"\"\/<\/figure>\n\n\n\n
Step4-<\/strong> For User Authentication write this command<\/p>\n\n\n
php<\/span> artisan<\/span> make<\/span>:auth<\/span><\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
\"\"\/<\/figure>\n\n\n\n
Step5-<\/strong> Create Database in Mysql Server<\/p>\n\n\n\n
\"\"\/<\/figure>\n\n\n\n
Step6-<\/strong> Set Mysql Server Username ,Password and Database Name in .env<\/strong> file<\/p>\n\n\n
DB_DATABASE = devopsschool\nDB_USERNAME = root\nDB_PASSWORD =<\/code><\/span><\/pre>\n\n\n
\"\"\/<\/figure>\n\n\n\n
Step7-<\/strong> Migration of Tables in Database<\/p>\n\n\n
php artisan migrate<\/code><\/span><\/pre>\n\n\n
\"\"\/<\/figure>\n\n\n\n
Step 8-<\/strong> Create the Laravel Artisan Command.
We use the make: console Artisan command to generate a command class skeleton to work with.<\/p>\n\n\n\n
In this application, we will send one email to the owner telling us that we have these number of users registered today. So type the following command to generate our console command.<\/p>\n\n\n
php artisan make:command RegisteredUsers --command=registered:users<\/code><\/span><\/pre>\n\n\n
\"\"<\/figure>\n\n\n\n
The above command will create a class named RegisteredUsers in a file of the same name in the app\/Console\/Commands<\/strong> folder.<\/p>\n\n\n\n
Step 9-<\/strong> We have also picked a name for the command via the command option. It is the name that we will use when calling the command. Now, open that command file RegisteredUsers.php<\/strong>.<\/p>\n\n\n
protected<\/span> $description = 'Send an email of registered users'<\/span>;<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
\"\"<\/figure>\n\n\n\n
Step 10-<\/strong> We have just changed the description of the command. Now, we need to register this command inside the app >> Console >> Kernel.php file<\/strong>.<\/p>\n\n\n\n
protected $commands = [\n        'App\\Console\\Commands\\RegisteredUsers',\n    ];<\/pre>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Step 11 –<\/strong> We just now to call in via CronJob and get the job done. Now, write the handle method to get the number of users registered today.<\/p>\n\n\n\n
public function handle()\n{\n$totalUsers = \\DB::table('users')\n->whereRaw('Date(created_at) = CURDATE()')\n->count();\n}<\/pre>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Step 12 –<\/strong> we need to send an email that contains that totalUsers.<\/strong> So let\u2019s create a mail class<\/strong><\/p>\n\n\n\n
Create a mailable class <\/strong>to send the mail.
Type following command to generate mail class<\/p>\n\n\n
php<\/span> artisan<\/span> make<\/span>:mail<\/span> SendMailable<\/span><\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
\"\"<\/figure>\n\n\n\n
So, it will create this file inside App\\Mail\\SendMailable.php<\/strong>.<\/p>\n\n\n\n
Step 13 –<\/strong> Now, this class contains one property, and that is count. This count is the number of users that registered today. So SendMailable.php<\/strong> file looks like this.<\/p>\n\n\n\n
<?php\nnamespace App\\Mail;\nuse Illuminate\\Bus\\Queueable;\nuse Illuminate\\Mail\\Mailable;\nuse Illuminate\\Queue\\SerializesModels;\nuse Illuminate\\Contracts\\Queue\\ShouldQueue;\nclass SendMailable extends Mailable\n{\n     use Queueable, SerializesModels;\n     public $count;\n     \/** * Create a new message instance. * * @return void *\/<\/code>\n     public function __construct($count) {<\/code>\n       $this->count = $count;<\/code>\n    } <\/code>\n    \/** * Build the message. * * @return $this *\/<\/code>\n    public function build() {<\/code>\n     return $this->view('emails.registeredcount');<\/code>\n   }<\/code>\n}<\/pre>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Step 14-<\/strong> Also, define the view for this mail at resources >> views >> emails >> registeredcount.blade.php<\/strong> file. The mails folder is not there, so we need to create one and then add the view registeredcount.blade.php<\/strong>.<\/p>\n\n\n\n
\n    Total number of registered users for today is: {{ $count }}\n<\/div>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Step 15-<\/strong> Now, add this mailable class inside the RegisteredUsers.php<\/strong> file.<\/p>\n\n\n\n
Mail::to(Config::get('app.MAIL_FROM'))->send(new SendMailable($totalUsers));<\/pre>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Step 16-<\/strong> For sending a mail, I have used Mailtrap<\/strong>. You can quickly signup there. It is free for some usage. It fakes the email, so it is convenient to test our application.<\/p>\n\n\n\n
MAIL_DRIVER=smtp\nMAIL_HOST=smtp.mailtrap.io\nMAIL_PORT=2525\nMAIL_USERNAME=your-username\nMAIL_PASSWORD=your-password\nMAIL_ENCRYPTION=null\nMAIL_FROM=info@devopsschool.com\nMAIL_FROM_NAME=DevopsSchool<\/pre>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Step 17- <\/strong>Configure  MAIL_FROM<\/strong> and MAIL_FROM_NAME<\/strong> on config\/app.php<\/strong> <\/p>\n\n\n\n
'MAIL_FROM' => env('MAIL_FROM', 'not found in .env file'),\n'MAIL_FROM_NAME' => env('MAIL_FROM_NAME', 'not found in .env file'),\n<\/pre>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Step 18-<\/strong> Now, type the following command to execute our code. Let us see that if we can get the mail.<\/p>\n\n\n\n
php artisan registered:users\n<\/pre>\n\n\n\n
Step 19-<\/strong>Task Scheduler in Laravel
Task Scheduler in Laravel executes the artisan command, shell, or a callback periodically on the defined time. To do this, we use the schedule method in app\/Console\/Kernel.php<\/strong>, as we discussed earlier.<\/p>\n\n\n\n
protected function schedule(Schedule $schedule)\n{\n$schedule->command('registered:users')\n->daily();\n}\n<\/pre>\n\n\n\n
\"\"<\/figure>\n\n\n