Event dispatching in Laravel - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is event dispatching in Laravel?

Event dispatching in Laravel is a way to send signals (events) when something happens in your app, so other parts can listen and react without being tightly connected.

beginner

How do you create a new event class in Laravel?

You use the Artisan command: <code>php artisan make:event EventName</code>. This creates a new event class where you can define data to pass when the event is fired.

beginner

What method do you use to dispatch an event in Laravel?

You use the event() helper function or the Event::dispatch() method to send the event so listeners can respond.

intermediate

What is the role of listeners in Laravel's event system?

Listeners wait for specific events and run code when those events happen. They help keep your code organized by separating reactions from the main logic.

intermediate

How do you register event listeners in Laravel?

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

Which command creates a new event class in Laravel?

A php artisan make:eventlistener EventName

B php artisan make:listener ListenerName

C php artisan event:create EventName

D php artisan make:event EventName

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

How do you dispatch an event in Laravel?

A Event::fire('EventName')

B event(new EventName())

C dispatchEvent('EventName')

D sendEvent('EventName')

You dispatch events using the event() helper with a new event instance.

Where do you register event listeners in Laravel?

A In the EventServiceProvider's $listen array

B In the routes/web.php file

C In the .env file

D In the config/app.php file

Listeners are registered in the $listen array inside EventServiceProvider.

What is the main benefit of using events and listeners?

A To separate concerns and keep code organized

B To speed up database queries

C To create user interfaces

D To handle HTTP requests

Events and listeners help separate concerns by decoupling code that triggers actions from code that reacts.

Which of these is NOT a valid way to dispatch an event in Laravel?

A dispatch(new EventName())

B Event::dispatch(new EventName())

C Event::fire(new EventName())

D event(new EventName())

The Event::fire() method is deprecated; use dispatch() or the event() helper instead.

Explain how event dispatching works in Laravel and why it is useful.

Think about how sending signals and reacting separately helps keep your app clean.

Describe the steps to create and use a custom event with a listener in Laravel.

Imagine you want to notify parts of your app when a user registers.

Practice

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

easy

A. To create new routes for the application

B. To directly update the database records

C. To send messages about actions happening in the application

D. To handle user authentication automatically

Solution

1. Step 1: Understand event dispatching concept

   Event dispatching is used to send messages or signals when something happens in the app.

2. Step 2: Identify the correct purpose

   It is not about database updates, routing, or authentication but about notifying parts of the app.

3. Final Answer:

   To send messages about actions happening in the application -> Option C

4. Quick Check:

   Event dispatching = sending messages [OK]

Hint: Events notify parts of app about actions [OK]

Common Mistakes:

• Confusing events with database operations
• Thinking events create routes
• Assuming events handle authentication

2. Which of the following is the correct syntax to dispatch an event named UserRegistered with a user object $user?

easy

A. sendEvent('UserRegistered', $user);

B. dispatch(UserRegistered, $user);

C. UserRegistered::dispatch($user);

D. event(new UserRegistered($user));

Solution

1. Step 1: Recall Laravel event dispatch syntax

   Laravel uses the global event() helper with a new event instance.

2. Step 2: Match syntax with options

   Only event(new UserRegistered($user)); matches Laravel's pattern.

3. Final Answer:

   event(new UserRegistered($user)); -> Option D

4. Quick Check:

   Use event(new EventName($data)) [OK]

Hint: Use event(new EventName($data)) to dispatch [OK]

Common Mistakes:

• Using dispatch() without new keyword
• Calling event as a static method
• Using non-existent sendEvent function

3. Given the following code, what will be the output?

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

// Dispatch event
event(new OrderPlaced(123));

// Listener logs the order ID
Log::info('Order placed with ID: ' . 123);

medium

A. Logs: 'Order placed with ID: 123'

B. Logs: 'Order placed with ID: OrderPlaced'

C. No log output because event is not handled

D. Syntax error due to missing listener

Solution

1. Step 1: Understand event dispatch and listener

   The event OrderPlaced is dispatched with order ID 123, and the listener logs this ID.

2. Step 2: Check the log output

   The log line explicitly outputs 'Order placed with ID: 123'.

3. Final Answer:

   Logs: 'Order placed with ID: 123' -> Option A

4. Quick Check:

   Listener logs correct order ID [OK]

Hint: Listener logs event data as given [OK]

Common Mistakes:

• Assuming event dispatch alone logs output
• Confusing event class name with data
• Expecting error without listener registration

4. Identify the error in this event dispatching code:

event(UserRegistered($user));

medium

A. Missing the 'new' keyword before the event class

B. Incorrect event name, should be 'UserRegister'

C. Event dispatching requires a string, not an object

D. The variable $user is not passed correctly

Solution

1. Step 1: Check event dispatch syntax

   Laravel requires creating a new instance of the event class using new.

2. Step 2: Identify missing 'new' keyword

   The code calls UserRegistered($user) like a function, missing new.

3. Final Answer:

   Missing the 'new' keyword before the event class -> Option A

4. Quick Check:

   Use new EventClass($data) when dispatching [OK]

Hint: Always use new keyword before event class [OK]

Common Mistakes:

• Calling event class as function without new
• Wrong event class name
• Passing wrong data type

5. You want to dispatch an event ProfileUpdated only if the user's email has changed. Which code correctly implements this conditional event dispatch?

hard

A. ProfileUpdated::dispatch($user) when $user->email != old_email;

B. if ($user->isDirty('email')) { event(new ProfileUpdated($user)); }

C. event(new ProfileUpdated($user)) if $user->email_changed();

D. if ($user->email !== null) { dispatch(ProfileUpdated($user)); }

Solution

1. Step 1: Understand Laravel's model change detection

   The isDirty('email') method checks if the email attribute changed.

2. Step 2: Verify correct conditional event dispatch

   if ($user->isDirty('email')) { event(new ProfileUpdated($user)); } uses correct syntax and condition to dispatch event only if email changed.

3. Final Answer:

   if ($user->isDirty('email')) { event(new ProfileUpdated($user)); } -> Option B

4. Quick Check:

   Use isDirty() to check changes before event [OK]

Hint: Use isDirty('field') to check changes before event [OK]

Common Mistakes:

• Using incorrect syntax for condition
• Calling dispatch without new keyword
• Checking wrong condition for email change