bosym/webpush

Web Push Notifications driver for Laravel.

Web push notifications channel for Laravel

, _(*1)

This package makes it easy to send web push notifications with Laravel., _(*2)

Installation

You can install the package via composer:, _(*3)

``` bash composer require laravel-notification-channels/webpush, <sub>(*4)</sub>

First you must install the service provider (skip for Laravel>=5.5):

``` php
// config/app.php
'providers' => [
    ...
    NotificationChannels\WebPush\WebPushServiceProvider::class,
],

Add the NotificationChannels\WebPush\HasPushSubscriptions trait to your User model:, <sub>(*5)</sub>

``` php use NotificationChannels\WebPush\HasPushSubscriptions;, <sub>(*6)</sub>

class User extends Model { use HasPushSubscriptions; }, <sub>(*7)</sub>

Next publish the migration with:

``` bash
php artisan vendor:publish --provider="NotificationChannels\WebPush\WebPushServiceProvider" --tag="migrations"

Run the migrate command to create the necessary table:, <sub>(*8)</sub>

``` bash php artisan migrate, <sub>(*9)</sub>

You can also publish the config file with:

``` bash
php artisan vendor:publish --provider="NotificationChannels\WebPush\WebPushServiceProvider" --tag="config"

Generate the VAPID keys with (required for browser authentication) with:, <sub>(*10)</sub>

``` bash php artisan webpush:vapid, <sub>(*11)</sub>

This command will set `VAPID_PUBLIC_KEY` and `VAPID_PRIVATE_KEY`in your `.env` file.

__These keys must be safely stored and should not change.__

If you still want support [Google Cloud Messaging](https://console.cloud.google.com) set the `GCM_KEY` and `GCM_SENDER_ID` in your `.env` file.

## Usage

Now you can use the channel in your `via()` method inside the notification as well as send a web push notification:

``` php
use Illuminate\Notifications\Notification;
use NotificationChannels\WebPush\WebPushMessage;
use NotificationChannels\WebPush\WebPushChannel;

class AccountApproved extends Notification
{
    public function via($notifiable)
    {
        return [WebPushChannel::class];
    }

    public function toWebPush($notifiable, $notification)
    {
        return (new WebPushMessage)
            ->title('Approved!')
            ->icon('/approved-icon.png')
            ->body('Your account was approved!')
            ->action('View account', 'view_account');
            // ->data(['id' => $notification->id])
            // ->badge()
            // ->dir()
            // ->image()
            // ->lang()
            // ->renotify()
            // ->requireInteraction()
            // ->tag()
            // ->vibrate()
    }
}

Save/Update Subscriptions

To save or update a subscription use the updatePushSubscription($endpoint, $key = null, $token = null) method on your user:, <sub>(*12)</sub>

``` php $user = \App\User::find(1);, <sub>(*13)</sub>

$user->updatePushSubscription($endpoint, $key, $token);, <sub>(*14)</sub>

The `$key` and `$token` are optional and are used to encrypt your notifications. Only encrypted notifications can have a payload.

### Delete Subscriptions

To delete a subscription use the `deletePushSubscription($endpoint)` method on your user:

``` php
$user = \App\User::find(1);

$user->deletePushSubscription($endpoint);

Demo

For a complete implementation with a Service Worker check this demo., <sub>(*15)</sub>

Browser Compatibility

The Push API currently works on Chrome and Firefox., <sub>(*16)</sub>

Changelog

Please see CHANGELOG for more information what has changed recently., <sub>(*17)</sub>

Testing

bash $ composer test, <sub>(*18)</sub>

Security

If you discover any security related issues, please email themsaid@gmail.com instead of using the issue tracker., <sub>(*19)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*20)</sub>

Credits

• Cretu Eusebiu
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*21)</sub>