asgardcms/notification-module

Module handling the real time notifications

Notification module

, _(*1)

, _(*2)

Quickly send (real-time) notifications to your AsgardCms application., _(*3)

php $this->notification->push('New subscription', 'Someone has subscribed!', 'fa fa-hand-peace-o text-green', route('admin.user.user.index'));, _(*4)

php /** * Push a notification on the dashboard * @param string $title * @param string $message * @param string $icon * @param string|null $link */ public function push($title, $message, $icon, $link = null);, _(*5)

Quick demo, _(*6)

Installation

Module Download

Using AsgardCMS's module download command:, _(*7)

``` bash php artisan asgard:download:module asgardcms/notification --migrations, <sub>(*8)</sub>

This will download the module and run its migrations .

This is the recommended way if you wish to customise the fields, views, etc.

### Composer

Execute the following command in your terminal:

``` bash
composer require asgardcms/notification-module

Note: After installation you'll have to give you the required permissions to get to the blog module pages in the backend., <sub>(*9)</sub>

Run migrations

``` bash php artisan module:migrate notification, <sub>(*10)</sub>

### Publish the configuration

``` bash
php artisan module:publish-config notification

Real time?

If you want real time notifications over websockets, you need to configure the broadcasting.php config file. After that is done, set the asgard.notification.config.real-time option to true., <sub>(*11)</sub>

Currently, Laravel broadcasting supports Pusher and Redis, but AsgardCms only has the front-end integration for Pusher. More integrations are welcome via pull-request. Look at the Pusher integration for inspiration., <sub>(*12)</sub>

For configuring Pusher, you can add the following lines to your .env file:, <sub>(*13)</sub>

PUSHER_APP_KEY=
PUSHER_APP_SECRET=
PUSHER_APP_ID=
PUSHER_APP_CLUSTER=us2
PUSHER_APP_ENCRYPTED=true

Your app's "Getting Started" tab on Pusher's website has a section for .env. You can just copy and paste those directly., <sub>(*14)</sub>

Usage

Usage is simple and straightforward:, <sub>(*15)</sub>

Inject the Modules\Notification\Services\Notification interface where you need it and assign it to a class variable., <sub>(*16)</sub>

Send notification to logged in user

``` php $this->notification->push('New subscription', 'Someone has subscribed!', 'fa fa-hand-peace-o text-green', route('admin.user.user.index'));, <sub>(*17)</sub>

### Send notification to a specific user

``` php
$this->notification->to($userId)->push('New subscription', 'Someone has subscribed!', 'fa fa-hand-peace-o text-green', route('admin.user.user.index'));