Creating notifications in Laravel

Introduction

Notifications help you send messages to users about important events. They keep users informed without needing them to check manually.

When you want to alert a user about a new message or comment.

When you need to inform users about system updates or maintenance.

To notify users about successful or failed actions, like order confirmation.

When sending reminders for upcoming events or deadlines.

To alert admins about critical system errors or user reports.

Syntax

Laravel

php artisan make:notification NotificationName

// In the notification class:
public function via($notifiable)
{
    return ['mail', 'database'];
}

public function toMail($notifiable)
{
    return (new MailMessage)
        ->line('Notification message')
        ->action('Notification Action', url('/'))
        ->line('Thank you!');
}

public function toArray($notifiable)
{
    return [
        'data' => 'Notification data here',
    ];
}

Use php artisan make:notification to create a new notification class.

The via method defines how the notification is sent (mail, database, etc.).

Examples

This sends the notification only by email.

Laravel

public function via($notifiable)
{
    return ['mail'];
}

This stores the notification in the database for later display.

Laravel

public function via($notifiable)
{
    return ['database'];
}

This defines the data saved in the database notification.

Laravel

public function toArray($notifiable)
{
    return [
        'message' => 'You have a new friend request!'
    ];
}

Sample Program

This notification sends a welcome email to a new user with a link to the dashboard.

Laravel

<?php

namespace App\Notifications;

use Illuminate\Notifications\Notification;
use Illuminate\Notifications\Messages\MailMessage;

class WelcomeUser extends Notification
{
    public function via($notifiable)
    {
        return ['mail'];
    }

    public function toMail($notifiable)
    {
        return (new MailMessage)
            ->subject('Welcome to Our App')
            ->line('Hello! Thanks for joining us.')
            ->action('Visit Dashboard', url('/dashboard'))
            ->line('We hope you enjoy your stay.');
    }
}

// Usage example in a controller or event:
// $user->notify(new WelcomeUser());

Important Notes

Notifications can be sent via multiple channels like mail, database, SMS, or Slack.

Make sure to configure mail settings in .env to send emails.

Database notifications require a notifications table created by php artisan notifications:table and migration.

Summary

Notifications keep users informed about important events.

Create notifications with php artisan make:notification and define delivery channels.

Use notify() on user models to send notifications.

Practice

1. What is the primary purpose of notifications in Laravel?

easy

A. To inform users about important events or updates

B. To create database tables automatically

C. To handle user authentication

D. To optimize application performance

Solution

1. Step 1: Understand the role of notifications

   Notifications are designed to keep users informed about events or updates in the application.

2. Step 2: Compare with other options

   Creating tables, authentication, and performance optimization are unrelated to notifications.

3. Final Answer:

   To inform users about important events or updates -> Option A

4. Quick Check:

   Notifications = Inform users [OK]

Hint: Notifications inform users about events [OK]

Common Mistakes:

• Confusing notifications with database migrations
• Thinking notifications handle authentication
• Assuming notifications improve performance directly

2. Which artisan command is used to create a new notification class in Laravel?

easy

A. php artisan make:notify NotificationName

B. php artisan generate:notification NotificationName

C. php artisan create:notification NotificationName

D. php artisan make:notification NotificationName

Solution

1. Step 1: Recall the artisan command for notifications

   The correct command to create a notification class is php artisan make:notification followed by the notification name.

2. Step 2: Identify incorrect commands

   Other commands like make:notify, create:notification, or generate:notification do not exist in Laravel.

3. Final Answer:

   php artisan make:notification NotificationName -> Option D

4. Quick Check:

   Use make:notification to create notifications [OK]

Hint: Use 'make:notification' with artisan [OK]

Common Mistakes:

• Using 'make:notify' instead of 'make:notification'
• Confusing 'create' or 'generate' commands
• Omitting the notification class name

3. Given this code snippet, what will be the result?

use App\Notifications\InvoicePaid;
$user = User::find(1);
$user->notify(new InvoicePaid($invoice));

medium

A. Throws an error because notify() is not a valid method

B. Sends an InvoicePaid notification to the user with ID 1

C. Creates a new user with an InvoicePaid notification

D. Deletes the user with ID 1 after notification

Solution

1. Step 1: Understand the notify() method

   The notify() method sends the given notification instance to the user model.

2. Step 2: Analyze the code behavior

   The code finds the user with ID 1 and sends them the InvoicePaid notification.

3. Final Answer:

   Sends an InvoicePaid notification to the user with ID 1 -> Option B

4. Quick Check:

   notify() sends notification to user [OK]

Hint: notify() sends notification to the user model [OK]

Common Mistakes:

• Thinking notify() creates or deletes users
• Assuming notify() is not a valid method
• Confusing notification sending with user creation

4. Identify the error in this notification sending code:

$user = User::find(5);
$user->notify(InvoicePaid);

medium

A. InvoicePaid should be instantiated with new keyword

B. User::find should be User::get

C. notify() method does not exist on User model

D. User ID 5 does not exist

Solution

1. Step 1: Check how notifications are sent

   The notify() method requires a notification instance, so InvoicePaid must be created with new InvoicePaid().

2. Step 2: Verify other parts

   User::find(5) is correct to get a user by ID, and notify() exists on the User model. User existence is not guaranteed but not a syntax error.

3. Final Answer:

   InvoicePaid should be instantiated with new keyword -> Option A

4. Quick Check:

   Notifications need new instance [OK]

Hint: Always use 'new' to create notification instances [OK]

Common Mistakes:

• Passing class name without instantiation
• Using User::get instead of find for single user
• Assuming notify() method is missing

5. You want to send a notification only via email and database channels. Which method should you define in your notification class to specify these channels?

hard

A. public function sendChannels() { return ['mail', 'database']; }

B. public function channels() { return ['email', 'db']; }

C. public function via($notifiable) { return ['mail', 'database']; }

D. public function notifyChannels() { return ['email', 'database']; }

Solution

1. Step 1: Recall the via() method role

   In Laravel notifications, the via() method defines which channels the notification uses.

2. Step 2: Check correct channel names and method signature

   The method must accept the $notifiable parameter and return an array with channel names like 'mail' and 'database'. Other method names or channel names are incorrect.

3. Final Answer:

   public function via($notifiable) { return ['mail', 'database']; } -> Option C

4. Quick Check:

   via() defines notification channels [OK]

Hint: Use via() method to list channels [OK]

Common Mistakes:

• Using wrong method names like channels()
• Using incorrect channel names like 'email' instead of 'mail'
• Omitting the $notifiable parameter