Event subscribers in Laravel - Mini Project: Build & Apply

Laravel Event Subscribers Setup

📖 Scenario: You are building a Laravel application that needs to respond to user registration events. Instead of handling events directly in controllers, you want to organize event handling using an event subscriber class.

🎯 Goal: Create an event subscriber class that listens to the Registered event and handles it by calling a method. Then, register this subscriber in the EventServiceProvider.

📋 What You'll Learn

Create an event subscriber class named UserEventSubscriber in the app/Listeners directory

Inside UserEventSubscriber, define a subscribe method that listens to the IlluminateAuthEventsRegistered event

Create a handler method named onUserRegistered inside UserEventSubscriber that will be called when the event fires

Register the UserEventSubscriber class in the EventServiceProvider $subscribe array

💡 Why This Matters

🌍 Real World

Event subscribers help keep Laravel applications organized by grouping event handlers in one class, making code easier to maintain.

💼 Career

Understanding event subscribers is important for Laravel developers to build scalable and maintainable applications that respond to system events.

1

Create the UserEventSubscriber class

Create a PHP class named UserEventSubscriber inside the app/Listeners directory with a public method onUserRegistered that accepts a parameter named $event. The method body can be empty for now.

Laravel

<?php

namespace App\Listeners;

class UserEventSubscriber
{
    // Your code here
}

Hint

Remember to declare the namespace App\Listeners and create a public method onUserRegistered with a parameter $event.

2

Add the subscribe method to UserEventSubscriber

Inside the UserEventSubscriber class, add a public method named subscribe that accepts a parameter $events. Inside this method, use $events->listen() to listen to the Illuminate\Auth\Events\Registered event and map it to the onUserRegistered method.

Laravel

<?php

namespace App\Listeners;

class UserEventSubscriber
{
    public function onUserRegistered($event)
    {
        // Handle the event
    }

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

Hint

The subscribe method registers event listeners. Use $events->listen() with the full event class name and the handler method.

3

Register the subscriber in EventServiceProvider

Open the app/Providers/EventServiceProvider.php file. Add the UserEventSubscriber::class to the protected $subscribe array property inside the EventServiceProvider class.

Laravel

listen(
            \Illuminate\Auth\Events\Registered::class,
            [self::class, 'onUserRegistered']
        );
    }
}

// EventServiceProvider.php

namespace App\Providers;

use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;

class EventServiceProvider extends ServiceProvider
{
    protected $subscribe = [
        // Add UserEventSubscriber here
        // Your code here
    ];
}

Hint

Remember to import UserEventSubscriber with a use statement and add it to the $subscribe array.

4

Complete the event subscriber setup

Ensure the UserEventSubscriber class and the EventServiceProvider are correctly defined and saved. The subscriber should now listen to the Registered event and call onUserRegistered when a user registers.

Laravel

listen(
            \Illuminate\Auth\Events\Registered::class,
            [self::class, 'onUserRegistered']
        );
    }
}

// EventServiceProvider.php

namespace App\Providers;

use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;

use App\Listeners\UserEventSubscriber;

class EventServiceProvider extends ServiceProvider
{
    protected $subscribe = [
        UserEventSubscriber::class,
    ];
}

// Confirm the setup is complete

Hint

Double-check that the subscriber class and the event provider are properly set up and saved.

Practice

1. What is the main purpose of an event subscriber in Laravel?

easy

A. To replace middleware in routing

B. To group multiple event handlers in one class for better organization

C. To directly dispatch events to the database

D. To handle HTTP requests and responses

Solution

1. Step 1: Understand event subscribers role

   Event subscribers group multiple event handlers in one class to keep code organized.

2. Step 2: Compare with other options

   Options A, B, and D describe unrelated Laravel features like middleware, database dispatch, and HTTP handling.

3. Final Answer:

   To group multiple event handlers in one class for better organization -> Option B

4. Quick Check:

   Event subscribers organize handlers = C [OK]

Hint: Subscribers group handlers in one class for neat code [OK]

Common Mistakes:

• Confusing subscribers with middleware
• Thinking subscribers dispatch events
• Mixing subscribers with HTTP controllers

2. Which method must a Laravel event subscriber class implement to register its event handlers?

easy

A. boot()

B. handle()

C. listen()

D. subscribe()

Solution

1. Step 1: Recall subscriber method

   Laravel event subscribers use the subscribe() method to register event handlers.

2. Step 2: Eliminate other methods

   handle() is for event listeners, listen() is used in EventServiceProvider, boot() is for service providers.

3. Final Answer:

   subscribe() -> Option D

4. Quick Check:

   subscribe() registers handlers = A [OK]

Hint: Subscribers use subscribe() to register handlers [OK]

Common Mistakes:

• Using handle() instead of subscribe()
• Confusing listen() with subscribe()
• Thinking boot() is for subscribers

3. Given this subscriber class, what will happen when the UserRegistered event is fired?

class UserEventSubscriber {
    public function subscribe($events) {
        $events->listen('UserRegistered', [self::class, 'onUserRegistered']);
    }

    public function onUserRegistered($event) {
        echo 'User registered: ' . $event->user->name;
    }
}

medium

A. Nothing happens because subscribe is not called automatically

B. It will throw a syntax error

C. It will echo the registered user's name

D. It will echo 'User registered:' without the name

Solution

1. Step 1: Understand event firing and subscriber listening

   The subscriber listens for 'UserRegistered' and calls onUserRegistered which echoes the user's name.

2. Step 2: Confirm subscribe method usage

   Laravel calls subscribe() automatically when registered, so the handler runs and echoes the message with the name.

3. Final Answer:

   It will echo the registered user's name -> Option C

4. Quick Check:

   Event triggers echo with name = A [OK]

Hint: subscribe() auto-registers handlers; echo shows user name [OK]

Common Mistakes:

• Thinking subscribe() must be called manually
• Assuming syntax error due to self::class
• Ignoring the event object passed to handler

4. Identify the error in this subscriber class:

class OrderSubscriber {
    public function subscribe($events) {
        $events->listen('OrderPlaced', 'handleOrderPlaced');
    }

    public function handleOrderPlaced($event) {
        // process order
    }
}

medium

A. The listener callback should be an array with class and method

B. The handleOrderPlaced method must be static

C. The subscribe method must return a value

D. The event name should be lowercase

Solution

1. Step 1: Check listener callback format

   Laravel expects the listener callback as an array with class and method when used in subscribers.

2. Step 2: Analyze given code

   The code uses a string 'handleOrderPlaced' instead of [self::class, 'handleOrderPlaced'], causing a runtime error.

3. Final Answer:

   The listener callback should be an array with class and method -> Option A

4. Quick Check:

   Listener callback must be array = D [OK]

Hint: Use [ClassName::class, 'method'] for subscriber callbacks [OK]

Common Mistakes:

• Passing method name as string only
• Thinking subscribe must return a value
• Assuming method must be static

5. You want to create a subscriber that listens to OrderPlaced and OrderShipped events. Which is the correct way to register both handlers in the subscribe method?

hard

A. public function subscribe($events) {
$events->listen('OrderPlaced', [self::class, 'handleOrderPlaced']);
$events->listen('OrderShipped', [self::class, 'handleOrderShipped']);
}

B. public function subscribe($events) {
$events->listen(['OrderPlaced', 'OrderShipped'], [self::class, 'handleOrder']);
}

C. public function subscribe($events) {
$events->listen('OrderPlaced', 'handleOrderPlaced');
$events->listen('OrderShipped', 'handleOrderShipped');
}

D. public function subscribe($events) {
$events->listen('OrderPlaced', self::handleOrderPlaced);
$events->listen('OrderShipped', self::handleOrderShipped);
}

Solution

1. Step 1: Understand correct listener registration

   Each event must be registered separately with an array callback [Class, method].

2. Step 2: Evaluate options

   public function subscribe($events) { $events->listen('OrderPlaced', [self::class, 'handleOrderPlaced']); $events->listen('OrderShipped', [self::class, 'handleOrderShipped']); } correctly registers both events with proper callbacks. public function subscribe($events) { $events->listen(['OrderPlaced', 'OrderShipped'], [self::class, 'handleOrder']); } wrongly groups events in one call. public function subscribe($events) { $events->listen('OrderPlaced', 'handleOrderPlaced'); $events->listen('OrderShipped', 'handleOrderShipped'); } uses strings instead of array callbacks. public function subscribe($events) { $events->listen('OrderPlaced', self::handleOrderPlaced); $events->listen('OrderShipped', self::handleOrderShipped); } uses invalid syntax without quotes.

3. Final Answer:

   public function subscribe($events) { $events->listen('OrderPlaced', [self::class, 'handleOrderPlaced']); $events->listen('OrderShipped', [self::class, 'handleOrderShipped']); } -> Option A

4. Quick Check:

   Separate listen calls with array callbacks = B [OK]

Hint: Register each event separately with [Class::class, 'method'] [OK]

Common Mistakes:

• Grouping multiple events in one listen call
• Using string method names without array
• Using invalid syntax without quotes