Download the PHP package c4studio/notification without Composer
On this page you can find all versions of the php package c4studio/notification. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download c4studio/notification
More information about c4studio/notification
Files in c4studio/notification
Package notification
Short Description Provides an interface for adding and retrieving database stored notifications.
License MIT
Informations about the package notification
Notification
Provides an interface for adding and retrieving database stored notifications.
Installation
Just place require new package for your laravel installation via composer.json
"c4studio/notification": "1.0.*"
Then simply
Registering to use it with laravel
Add following lines to
ServiceProvider array
Alias array
Publishing migrations (Laravel 5.2 and lower only)
php artisan vendor:publish --provider="C4studio\Notification\NotificationServiceProvider" --tag=migrations
Running migrations
Notification uses a database table for storage, so you'll need to run the migrations
php artisan migrate
Usage
Select models which can receive notifications
You must apply the HasNotifications trait to all models that will be able to receive notifications
Add notification using facade
You can add notifications using the notify() method, which take two parameters: the notification message and the recipient(s). The second parameter accepts either a model or an array/collection of models
If no recipient is set, the notification will be treated as a system message, and will be attached to every user model
Add notification using helper function
Retrieving notifications for a model
To get notifications for a model, use the notifications relationship
You can also easily get the system notifications
Marking notification as read/unread
You can mark notification as read/unread by using the markRead() and markUnread() methods. But accept the user model or user ID as a parameter. If ommitted, message will be marked for current authenticated user
Check if notification has been read by current user
You can check if a notification has been read by the currently authenticated user, by accessing the read attribute.
Get recipients of a notification
You can also get all the recipients of a notification
Complex queries
For more complex queries, you can return a Builder object by using query(). Easy, right?