Download the PHP package rubik-llc/laravel-notification-manager without Composer

Laravel notification manager

In addition to Laravel’s default notifications, this package adds further attributes like seen_at, is_prioritised, is_muted, preview_type and alert_type. These attributes can be used to classify notifications for a better user experience. Furthermore, using this package you can manage subscriptions to certain notifications based on user preference, meaning that a user can specify whether or not to receive a certain notification type, channel or even a specific notification.

Features

• Manage subscribers
• Manage notification priorities
• Manage muted notifications (mute, unmute)
• Classifies notifications according to the way they appear
• Classifies notifications according where they appear
• Mark as seen

Installation

You can install the package via composer:

You can publish and run the migrations with:

You can publish the config file with:

This is the contents of the published config file:

Usage

1. Use our “Notifiable” trait in all models you wish to send notifications(most cases Users)
   • This can be done by changing the import from “use Illuminate\Notifications\Notifiable;” to “use Rubik\NotificationManager\Traits\Notifiable;”, and also if not yet use the trait “use Notifiable”;. Your model should look like
2. Use HasNotificationSubscription trait in all models you wish to send notifications
3. Create subscribale notification by using “-s” flag in the default artisan command to create a notification.
4. Add this notification to config file

From now on everything is the same as a normal notification. Below you can see how your Model and Notification should look like:

If you want to convert a notification to a subscribable notification all you have to do is add SubscribaleNotification Contract and implement all methods required, and use SubscribaleNotification trait. Do not forget to add this notifion to your config. Your notification should look like:

All changes will affect only future notifications, and if not specified different changes will affect the desired notification of the authenticated user. Will be explained below.

Subscribers/Unsubscribe

Subscribe to a notification:

or:

Unsubscribe to a notification:

or:

Subscribe a user to a notification:

Unsubscribe a user to a notification:

Subscribe to all notifications:

Unsubscribe to all notifications:

Subscribe a user to all notifications:

Unsubscribe a user to all notifications:

Send notification to all subscribers:

Instead of using:

Use:

Everything passed to send to subscriber will be passed to notification constructor.

Priority

Set priority to a notification:

or:

Unset priority to a notification:

or:

Set priority to a notification as a user:

Unset priority to a notification as a user:

Mute

Mute a notification:

or:

Unmute a notification:

or:

Mute a notification for a user:

Unmute a notification for a user:

Alert type

Set/update alert type:

or:

Available alert types:

those are only values and in no way they represent a logic. You can use those values to classify notifications.

Preview type

Set/update preview type:

or:

Available alert types:

Seen

Mark as seen

or:

or:

or:

Mark as unseen

or:

or:

or:

Get all seen notifications:

Get all unseen notifications:

Get all prioritized notifications:

Get all trivialized notifications:

Get all muted notifications:

Get all unmuted notifications:

Get all notifications with alert type set to 'notification-center':

Get all notifications with alert type set to 'banner':

Get all notifications with alert type set to 'lock-screen':

Get all notifications with preview type set to 'always':

Get all notifications with preview type set to 'when-unlocked':

Get all notifications with preview type set to 'never':

Check if a notification is seen:

Check if a notification is unseen:

Check if a notification is prioritised:

Check if a notification is trivialised:

Check if a notification is muted:

Check if a notification is unmuted:

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Yllndrit Beka
• Rron Nela
• All Contributors

License

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