Defining events in Laravel - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is an event in Laravel?

An event in Laravel is a way to signal that something important has happened in the application, like a user registering or an order being placed. It helps separate code that triggers actions from code that responds to them.

beginner

How do you define a new event class in Laravel?

You create a new event class by running <code>php artisan make:event EventName</code>. This generates a class in the <code>app/Events</code> folder where you can add any data the event should carry.

beginner

What is the purpose of the event's constructor?

The constructor in an event class is used to accept and store any data that should be passed when the event is fired, like user details or order info.

intermediate

Where do you register event listeners for your events in Laravel?

You register event listeners in the EventServiceProvider class, inside the protected $listen array, mapping events to their listeners.

beginner

How do you fire an event in Laravel?

You fire an event by calling event(new EventName($data)) or using the Event facade like Event::dispatch(new EventName($data)). This triggers all listeners for that event.

Which artisan command creates a new event class in Laravel?

A php artisan make:listener EventName

B php artisan make:event EventName

C php artisan make:eventlistener EventName

D php artisan create:event EventName

The correct command to create a new event class is php artisan make:event EventName.

Where do you map events to their listeners in Laravel?

A In the EventServiceProvider's $listen array

B In the routes/web.php file

C In the config/app.php file

D In the .env file

Event listeners are registered in the EventServiceProvider class inside the protected $listen array.

What is the main role of an event's constructor in Laravel?

A To dispatch the event

B To register the event in the system

C To listen for other events

D To store data passed when the event is fired

The constructor stores any data passed to the event when it is fired.

How do you trigger an event in Laravel?

A By calling event(new EventName($data))

B By creating a new listener

C By adding it to routes

D By running an artisan command

You trigger an event by calling event(new EventName($data)).

What folder contains the event classes by default in Laravel?

A app/Http/Events

B app/Listeners

C app/Events

D app/Providers

Event classes are stored in the app/Events folder by default.

Explain how to create and use a custom event in Laravel from start to finish.

Think about the steps from creating the event to making it work in your app.

Describe the role of events and listeners in Laravel and why they help organize code.

Consider how events and listeners work like a messaging system.

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