Laravel Subscribable Notifications

Last update: Mar 18, 2022

Laravel Subscribable Notifications

Latest Version on Packagist Total Downloads GitHub Actions

This package allows you to subscribe your app Users to your app Notifications and dispatch them without specifying the recipient. The main goal of this package is allowing you to create "lists of recipients" for your Notification classes and dispatch notifications to your users easily.

Motivation

Recently I've been developing back-office kind of apps where a group of users need to be notified via email for a particular event or scenario in the system. These users were being hardcoded in the app and sometimes they needed to subscribe or be removed from certain emails, depending on the job they were doing at the company. Since their emails were hardcoded, it was tricky to update the "subscribers" list to each mailable that was sent by the application. With that idea in mind, this package was created to allow configuring users to each mailable they need to receive.

Installation

You can install the package via composer:

composer require asantibanez/laravel-subscribable-notifications

Afterwards, export both the config and migrations by using the php artisan vendor:publish command.

Once the laravel-subscribable-notifications.php config file is exported, make sure you define your User model and your subscribable_notifications (more on this below). Only the notifications you configure will be available for subscription.

Usage

Using Laravel notifications system, you normally dispatch notifications using the Notification facade or via the User model notify() method when implementing the Notifiable trait.

Notification::send([$user1, $user2, $user3], new OrderShipped($order));

// or 
$notification = new OrderShipped($order);

$user1->notify($notification);
$user2->notify($notification);
$user3->notify($notification);

With laravel-subscribable-notifications, you send the notification by "dispatching" it. Any subscribed user to the notification will receive it.

OrderShipped::dispatch($order);

Preparing your Notifications

Notifications must implement the SubscribableNotification interface which will require to implement the following methods:

  • dispatch
  • subscribers
  • subscribableNotificationType

For these, add the DispatchesToSubscriber trait to your notification which will cover dispatch and subscribers. Lastly, implement subscribableNotificationType by providing a string that identifies your notification. This value will be saved in the database for your users subscriptions.

class SalesOrderApprovedNotification extends Notification implements SubscribableNotification
{
    use DispatchesToSubscribers;

    public static function subscribableNotificationType(): string
    {
        return 'sales-order.approved';
    }
    
    // notification implementation here
}

You must also add your notification to the subscribable_notifications array inside laravel-subscribable-notifications config. Registering your notification here will allow the package to know which notifications can be dispatched throughout this interface.

Subscribing/Unsubscribing Users

Under the hood, a notification_subscriptions table is used to track all user subscriptions to your notifications.

Using the NotificationSubscriptionManager facade, you can subscribe and unsubscribe users from notification using the subscribe and unsubscribe methods respectively. There's also a unsubscribeFromAll method to remove all subscription from a user.

Note: Your User model can implement the HasNotificationSubscriptions trait to get helper methods in order to know what subscriptions each user has been subscribed to.

Utilities

The package register a new subscribable-notifications:manage command which you can run in your terminal and interact with the notification_subscriptions table. The command allows you to list/add/remove users from notifications you've defined in the laravel-subscribable-notifications config file.

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

GitHub

https://github.com/asantibanez/laravel-subscribable-notifications
You might also like...

:computer: Send notifications to your desktop directly from your PHP script

:computer: Send notifications to your desktop directly from your PHP script

About JoliNotif JoliNotif is a cross-platform PHP library to display desktop notifications. It works on Linux, Windows or MacOS. Requires PHP = 7.2 (

May 12, 2022

A very lightweight library to handle notifications the smart way.

A very lightweight library to handle notifications the smart way.

NAMSHI | Notificator Notificator is a very simple and lightweight library to handle notifications the smart way. It took inspiration from other librar

May 9, 2022

Takes care of Apple push notifications (APNS) in your PHP projects.

Notificato Notificato takes care of push notifications in your PHP projects. Italian: notificato è: participio passato English: notified Why use Notif

Apr 17, 2022

A PHP Library to easily send push notifications with the Pushwoosh REST Web Services.

php-pushwoosh A PHP Library to easily send push notifications with the Pushwoosh REST Web Services. First sample, creating a Pushwoosh message // Crea

Jan 27, 2022

Notifications in PHP (notify-send, growl, etc) like that.

#Nod Notifications in PHP (notify-send, growl, etc) like that. ##Examples Letting Nod figure out the best Adapter to use (not recommend ATM, only work

Mar 26, 2019

Sends notifications via one or more channels (email, SMS, ...).

Notifier Component The Notifier component sends notifications via one or more channels (email, SMS, ...). Resources Documentation Contributing Report

May 21, 2022

Send push notifications to apple devices (iPhone, iPad, iPod).

Apple Apn Push Send push notifications to apple devices (iPhone, iPad, iPod). Support authenticators: Certificate Json Web Token Supported protocols:

Apr 26, 2022

This package allows you to send notifications to Microsoft Teams.

This package allows you to send notifications to Microsoft Teams.

Teams connector This package allows you to send notifications to Microsoft Teams. Installation You can install the package using the Composer package

May 6, 2022

Push notifications Library for PHP

Push notifications Library for PHP Supported Protocols Protocol Supported Driver Options APNs (Token Based) ✓ APNs\Token APNs\Token\Option APNs (Certi

Mar 25, 2022
Comments
  • 1. Attempted to lazy load [user] on model [Asantibanez\LaravelSubscribableNotifications\Models\NotificationSubscription] but lazy loading is disabled.

    Fix add $with = ['user'];

    class NotificationSubscription extends Model
    {
        use HasFactory;
    
        protected $guarded = [];
        protected $with = ['user'];
    
        public function user()
        {
            return $this->belongsTo(NotificationSubscriptionManager::userModel());
        }
    
    Reviewed by ridiks10 at 2021-10-16 20:14
Laravel package to launch toast notifications.
Laravel package to launch toast notifications.

Laravel package to launch toast notifications. This package provides assistance when using toast notifications. Using the iziTOAST package, which allo

Mar 14, 2022
Larafirebase is a package thats offers you to send push notifications or custom messages via Firebase in Laravel.
Larafirebase is a package thats offers you to send push notifications or custom messages via Firebase in Laravel.

Introduction Larafirebase is a package thats offers you to send push notifications or custom messages via Firebase in Laravel. Firebase Cloud Messagin

May 6, 2022
Flexible Flash notifications for Laravel
Flexible Flash notifications for Laravel

Introduction Laravel Notify is a package that lets you add custom notifications to your project. A diverse range of notification design is available.

May 23, 2022
A package to simplify automating future notifications and reminders in Laravel
A package to simplify automating future notifications and reminders in Laravel

Laravel Snooze Schedule future notifications and reminders in Laravel Why use this package? Ever wanted to schedule a future notification to go out at

May 11, 2022
📨 Facebook Notifications Channel for Laravel
📨 Facebook Notifications Channel for Laravel

Facebook Notifications Channel for Laravel This package makes it easy to send notifications using the Facebook Messenger with Laravel. Contents Instal

Apr 13, 2022
Push Notifications using Laravel
Push Notifications using Laravel

laravel-push-notification Push Notifications using Laravel PushNotification::send(['deviceToken1', 'deviceToken2',..], 'Notification Message', 'Action

Apr 6, 2022
Laravel package to enable sending push notifications to devices

Laravel Push Notification Package to enable sending push notifications to devices Installation Update your composer.json file to include this package

Apr 25, 2022
✈️ Whatsapp Notifications Channel for Laravel

Whatsapp Notifications Channel for Laravel This package makes it easy to send Whatsapp notification using Venom API with Laravel. This package was cre

Apr 27, 2022
Send Firebase push notifications with Laravel php framework.

FCM Notification Channel for Laravel Send Firebase push notifications with Laravel php framework. Installation You can install this package via compos

May 21, 2022
Standalone PHP library for easy devices notifications push.

NotificationPusher Standalone PHP library for easy devices message notifications push. Feel free to contribute! Thanks. Contributors Cédric Dugat (Aut

May 9, 2022