Dispatching jobs in Laravel - Mini Project: Build & Apply

Dispatching Jobs in Laravel

📖 Scenario: You are building a Laravel application that needs to send welcome emails to new users without slowing down the main app. To do this, you will use Laravel's job dispatching system to handle email sending in the background.

🎯 Goal: Build a Laravel job that sends a welcome email and dispatch it from a controller.

📋 What You'll Learn

Create a job class named SendWelcomeEmail that accepts a User object.

Add a handle method in the job to simulate sending an email.

Dispatch the SendWelcomeEmail job from a controller method called sendEmail.

Use the dispatch() helper to queue the job.

💡 Why This Matters

🌍 Real World

Dispatching jobs in Laravel is used to handle time-consuming tasks like sending emails, processing files, or calling APIs without blocking the main application flow.

💼 Career

Understanding job dispatching is essential for backend developers working with Laravel to build scalable and responsive applications.

1

Create the SendWelcomeEmail job class

Create a Laravel job class named SendWelcomeEmail that accepts a User object in its constructor and stores it in a public property called user.

Laravel

<?php

namespace App\Jobs;

use App\Models\User;

class SendWelcomeEmail
{
    public User $user;

    // Your code here
}

Hint

Use the __construct method to accept the User object and assign it to the user property.

2

Add the handle method to the job

Add a public method called handle inside the SendWelcomeEmail job class. Inside it, add a comment // Simulate sending welcome email.

Laravel

user = $user;
    }

    // Add the handle method below
    // Your code here
}

Hint

The handle method is where the job's main work happens.

3

Create a controller method to dispatch the job

In a controller named UserController, create a public method called sendEmail that accepts a User object as a parameter. Inside this method, dispatch the SendWelcomeEmail job using the dispatch() helper and pass the User object to it.

Laravel

user = $user;
    }

    public function handle()
    {
        // Simulate sending welcome email
    }
}

namespace App\Http\Controllers;

use App\Models\User;
use App\Jobs\SendWelcomeEmail;

class UserController
{
    // Add the sendEmail method below
    // Your code here
}

Hint

Use the dispatch() helper to send the job to the queue.

4

Complete the job dispatching setup

Add the ShouldQueue interface and the Dispatchable trait to the SendWelcomeEmail job class to make it queueable.

Laravel

user = $user;
    }

    public function handle()
    {
        // Simulate sending welcome email
    }
}

namespace App\Http\Controllers;

use App\Models\User;
use App\Jobs\SendWelcomeEmail;

class UserController
{
    public function sendEmail(User $user)
    {
        dispatch(new SendWelcomeEmail($user));
    }
}

Hint

Implement ShouldQueue and use the Dispatchable trait to enable queueing.

Practice

1. What is the main purpose of dispatching jobs in Laravel?

easy

A. To handle user authentication

B. To run tasks in the background without blocking user requests

C. To create database tables automatically

D. To directly output data to the browser

Solution

1. Step 1: Understand what dispatching jobs means

   Dispatching jobs means sending tasks to run in the background, separate from the main app flow.

2. Step 2: Identify the benefit of background jobs

   Running tasks in the background improves app speed and user experience by not blocking user requests.

3. Final Answer:

   To run tasks in the background without blocking user requests -> Option B

4. Quick Check:

   Dispatching jobs = background tasks [OK]

Hint: Jobs run in background to keep app fast and responsive [OK]

Common Mistakes:

• Thinking dispatching jobs outputs data immediately
• Confusing jobs with database migrations
• Assuming jobs handle user login

2. Which is the correct way to dispatch a job called SendEmailJob in Laravel?

easy

A. SendEmailJob.dispatch();

B. dispatch SendEmailJob();

C. SendEmailJob::dispatch();

D. dispatch::SendEmailJob();

Solution

1. Step 1: Recall Laravel job dispatch syntax

   Laravel uses the static method ::dispatch() on the job class to send it to the queue.

2. Step 2: Match the syntax to the options

   SendEmailJob::dispatch(); uses SendEmailJob::dispatch(); which is the correct Laravel syntax.

3. Final Answer:

   SendEmailJob::dispatch(); -> Option C

4. Quick Check:

   JobClass::dispatch() = correct syntax [OK]

Hint: Use ClassName::dispatch() to send jobs [OK]

Common Mistakes:

• Using dot instead of double colon for static call
• Trying to call dispatch as a function without ::
• Incorrect order or missing parentheses

3. Given this code:

SendReportJob::dispatch();
return 'Report sent';

What will the user see immediately after this code runs?

medium

A. The report is sent and user sees 'Report sent' immediately

B. The user waits until the report is sent, then sees 'Report sent'

C. An error because dispatch() is not a valid method

D. Nothing happens because dispatch() does not run the job

Solution

1. Step 1: Understand dispatch() behavior

   Dispatching a job sends it to the queue to run in the background immediately without blocking.

2. Step 2: Analyze the return statement

   The return 'Report sent' runs right after dispatch(), so the user sees this message immediately.

3. Final Answer:

   The report is sent and user sees 'Report sent' immediately -> Option A

4. Quick Check:

   dispatch() runs background job, return runs immediately [OK]

Hint: dispatch() queues job; return runs right after [OK]

Common Mistakes:

• Thinking dispatch() waits for job to finish
• Assuming dispatch() causes an error
• Believing dispatch() does nothing

4. What is wrong with this code snippet?

dispatch SendEmailJob();

medium

A. dispatch is not a function, should use SendEmailJob::dispatch()

B. Missing parentheses after dispatch

C. SendEmailJob must be instantiated with new keyword

D. dispatch should be lowercase

Solution

1. Step 1: Check dispatch usage

   In Laravel, dispatching a job is done by calling ::dispatch() on the job class, not by calling dispatch as a function.

2. Step 2: Identify the error in the code

   The code tries to call dispatch as a function without parentheses and without using the static method on the job class.

3. Final Answer:

   dispatch is not a function, should use SendEmailJob::dispatch() -> Option A

4. Quick Check:

   Use JobClass::dispatch() not dispatch function [OK]

Hint: dispatch() is a static method on job class, not a function [OK]

Common Mistakes:

• Calling dispatch as a standalone function
• Forgetting :: before dispatch
• Trying to instantiate job without dispatch

5. You want to dispatch a job ProcessOrderJob with an order ID parameter 123. Which code correctly dispatches this job with the parameter?

hard

A. ProcessOrderJob::dispatch()->with(123);

B. dispatch(ProcessOrderJob(123));

C. ProcessOrderJob->dispatch(123);

D. ProcessOrderJob::dispatch(123);

Solution

1. Step 1: Understand how to pass parameters to jobs

   Jobs accept constructor parameters, and dispatch() forwards them to the constructor.

2. Step 2: Match correct syntax

   ProcessOrderJob::dispatch(123); calls ProcessOrderJob::dispatch(123); which passes 123 to the job constructor correctly.

3. Final Answer:

   ProcessOrderJob::dispatch(123); -> Option D

4. Quick Check:

   dispatch(params) passes args to job constructor [OK]

Hint: Pass parameters inside dispatch() to send to job constructor [OK]

Common Mistakes:

• Trying to call dispatch on an instance
• Using dispatch as a function with wrong syntax
• Chaining with() method which does not exist