Download the PHP package asantibanez/laravel-subscribable-notifications without Composer

On this page you can find all versions of the php package asantibanez/laravel-subscribable-notifications. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package laravel-subscribable-notifications

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:

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.

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

Preparing your Notifications

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

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.

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

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.


All versions of laravel-subscribable-notifications with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4|^8.0|^8.1|^8.2
illuminate/support Version ^7.0|^8.0|^9.0|^10.0|^11.0
laravel/legacy-factories Version ^1.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package asantibanez/laravel-subscribable-notifications contains the following files

Loading the files please wait ....