Defining events in Laravel

Introduction

Events let your app react to things happening, like a user logging in. They help keep your code organized and easy to manage.

When you want to run some code after a user registers, like sending a welcome email.

When you need to update other parts of your app after a change, like logging activity.

When you want to separate different tasks that happen after an action, making your code cleaner.

When you want to trigger notifications after a specific event happens.

When you want to handle complex workflows by breaking them into smaller steps.

Syntax

Laravel

php artisan make:event EventName

// Event class example
namespace App\Events;

use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class EventName
{
    use Dispatchable, SerializesModels;

    public $data;

    public function __construct($data)
    {
        $this->data = $data;
    }
}

Use php artisan make:event EventName to create a new event class.

Events usually carry data that listeners can use.

Examples

This command creates an event called UserRegistered.

Laravel

php artisan make:event UserRegistered

This event holds a $user object to share with listeners.

Laravel

namespace App\Events;

use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class UserRegistered
{
    use Dispatchable, SerializesModels;

    public $user;

    public function __construct($user)
    {
        $this->user = $user;
    }
}

Sample Program

This example defines an OrderPlaced event that carries an order ID. When an order is placed, the event is fired with the order ID.

Laravel

<?php

namespace App\Events;

use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class OrderPlaced
{
    use Dispatchable, SerializesModels;

    public $orderId;

    public function __construct(int $orderId)
    {
        $this->orderId = $orderId;
    }
}

// Usage example in a controller or service

use App\Events\OrderPlaced;

function placeOrder(int $orderId) {
    // Order placing logic here

    event(new OrderPlaced($orderId));

    return "Order placed with ID: $orderId";
}

// Calling the function
echo placeOrder(123);

Important Notes

Events help keep your code clean by separating actions from reactions.

Always pass only the data listeners need to the event.

Use Laravel's event() helper to fire events easily.

Summary

Events are special classes that represent something happening in your app.

You create events with artisan and add data to share.

Fire events to let other parts of your app respond.

Practice

1. What is the main purpose of defining events in a Laravel application?

easy

A. To respond to actions in a clean and organized way

B. To directly modify database tables

C. To create user interface components

D. To handle HTTP routing

Solution

1. Step 1: Understand the role of events

   Events in Laravel are designed to help the app respond to actions or changes without mixing code logic.

2. Step 2: Compare with other options

   Modifying database tables, creating UI components, and handling routing are done by other parts of Laravel, not events.

3. Final Answer:

   To respond to actions in a clean and organized way -> Option A

4. Quick Check:

   Events = Respond to actions [OK]

Hint: Events handle actions, not UI or database directly [OK]

Common Mistakes:

• Confusing events with database migrations
• Thinking events create UI elements
• Mixing events with routing logic

2. Which artisan command correctly creates a new event named UserRegistered?

easy

A. php artisan make:event UserRegistered

B. php artisan event:create UserRegistered

C. php artisan make:event --new UserRegistered

D. php artisan create:event UserRegistered

Solution

1. Step 1: Recall the artisan command for events

   The correct command to create an event is php artisan make:event EventName.

2. Step 2: Check each option

   Only php artisan make:event UserRegistered matches the correct syntax. Others use invalid commands or flags.

3. Final Answer:

   php artisan make:event UserRegistered -> Option A

4. Quick Check:

   make:event = create event [OK]

Hint: Use 'make:event' with artisan to create events [OK]

Common Mistakes:

• Using 'event:create' instead of 'make:event'
• Adding unnecessary flags like '--new'
• Swapping command order

3. Given this event class snippet:

class OrderShipped {
    public $order;
    public function __construct($order) {
        $this->order = $order;
    }
}

What will be the correct way to fire this event with an $order object?

medium

A. event(OrderShipped($order));

B. OrderShipped::fire($order);

C. event(new OrderShipped($order));

D. fire_event('OrderShipped', $order);

Solution

1. Step 1: Understand how to fire events in Laravel

   Events are fired by calling the global event() helper with a new instance of the event class.

2. Step 2: Check each option

   event(new OrderShipped($order)); correctly uses event(new OrderShipped($order)). event(OrderShipped($order)); misses new, C and D use invalid syntax.

3. Final Answer:

   event(new OrderShipped($order)); -> Option C

4. Quick Check:

   Fire event = event(new EventClass) [OK]

Hint: Always use 'new' keyword inside event() to fire events [OK]

Common Mistakes:

• Omitting 'new' keyword when firing event
• Trying to call static fire methods
• Using non-existent helper functions

4. Identify the error in this event class definition:

class ProductCreated {
    public $product;
    public function ProductCreated($product) {
        $this->product = $product;
    }
}

medium

A. Property should be private, not public

B. Missing public keyword before property

C. Event class must extend a base Event class

D. Constructor method name should be __construct, not class name

Solution

1. Step 1: Check constructor syntax in PHP

   In modern PHP (and Laravel), constructors must be named __construct, not the class name.

2. Step 2: Verify other options

   Property visibility is correct as public, extending base class is optional, so only constructor name is wrong.

3. Final Answer:

   Constructor method name should be __construct, not class name -> Option D

4. Quick Check:

   Constructor = __construct method [OK]

Hint: Use __construct() for constructors, not class name [OK]

Common Mistakes:

• Using old PHP constructor style
• Forgetting visibility keywords
• Assuming event classes must extend a base class

5. You want to define an event InvoicePaid that carries an Invoice object and a payment amount. Which is the best way to define its constructor?

hard

A. public function __construct(array $data) { $this->invoice = $data['invoice']; $this->amount = $data['amount']; }

B. public function __construct(Invoice $invoice, float $amount) { $this->invoice = $invoice; $this->amount = $amount; }

C. public function InvoicePaid(Invoice $invoice, float $amount) { $this->invoice = $invoice; $this->amount = $amount; }

D. public function __construct($invoice, $amount) { $invoice = $invoice; $amount = $amount; }

Solution

1. Step 1: Check constructor naming and parameter types

   The constructor must be named __construct and accept typed parameters for clarity and safety.

2. Step 2: Verify property assignments

   public function __construct(Invoice $invoice, float $amount) { $this->invoice = $invoice; $this->amount = $amount; } correctly assigns parameters to properties. public function __construct($invoice, $amount) { $invoice = $invoice; $amount = $amount; } assigns parameters to themselves (wrong). public function InvoicePaid(Invoice $invoice, float $amount) { $this->invoice = $invoice; $this->amount = $amount; } uses old constructor name. public function __construct(array $data) { $this->invoice = $data['invoice']; $this->amount = $data['amount']; } uses array but less clear and no type safety.

3. Final Answer:

   public function __construct(Invoice $invoice, float $amount) { $this->invoice = $invoice; $this->amount = $amount; } -> Option B

4. Quick Check:

   Use __construct with typed params and assign to properties [OK]

Hint: Use __construct with typed params and assign to $this->props [OK]

Common Mistakes:

• Using old constructor method name
• Assigning parameters to themselves
• Using untyped or array parameters without clarity