dptsi/laravel-push-notification

Laravel Firebase Cloud Messaging.

dev-main 2023-02-01 06:55 UTC

Requires

• illuminate/notifications: ^7.0|^8.0|^9.0
• illuminate/support: ^7.0|^8.0|^9.0

MIT

• Nusantara

README

Introduction

A package that offers you to send push notifications or custom messages via Firebase in Laravel.

Firebase Cloud Messaging (FCM) is a cross-platform messaging solution that lets you reliably deliver messages at no cost.

For use cases such as instant messaging, a message can transfer a payload of up to 4KB to a client app.

Installation

Follow the steps below to install the package.

Composer

composer require dptsi/laravel-push-notification

Copy Config

Run php artisan vendor:publish --provider="Dptsi\PushNotification\Providers\PushNotificationServiceProvider" to publish the pushnotification.php config file.

Get Athentication Key

Get Authentication Key from https://console.firebase.google.com/

Configure pushnotification.php as needed

'authentication_key' => '{AUTHENTICATION_KEY}'

Usage

Follow the steps below to find how to use the package.

Example usage in Controller/Service or any class:

use Dptsi\PushNotification\Facades\PushNotification;

class MyController
{
    private $deviceTokens =['{TOKEN_1}', '{TOKEN_2}'];

    public function sendNotification()
    {
        return PushNotification::withTitle('Test Title')
            ->withBody('Test body')
            ->withImage('https://firebase.google.com/images/social.png')
            ->withIcon('https://seeklogo.com/images/F/firebase-logo-402F407EE0-seeklogo.com.png')
            ->withSound('default')
            ->withClickAction('https://www.google.com')
            ->withPriority('high')
            ->withAdditionalData([
                'color' => '#rrggbb',
                'badge' => 0,
            ])
            ->sendNotification($this->deviceTokens);

        // Or
        return PushNotification::fromArray(['title' => 'Test Title', 'body' => 'Test body'])->sendNotification($this->deviceTokens);
    }

    public function sendMessage()
    {
        return PushNotification::withTitle('Test Title')
            ->withBody('Test body')
            ->sendMessage($this->deviceTokens);

        // Or
        return PushNotification::fromArray(['title' => 'Test Title', 'body' => 'Test body'])->sendMessage($this->deviceTokens);
    }
}

Example usage in Notification class:

use Illuminate\Notifications\Notification;
use Dptsi\PushNotification\Messages\FirebaseMessage;

class SendBirthdayReminder extends Notification
{
    /**
     * Get the notification's delivery channels.
     */
    public function via($notifiable)
    {
        return ['firebase'];
    }

    /**
     * Get the firebase representation of the notification.
     */
    public function toFirebase($notifiable)
    {
        $deviceTokens = [
            '{TOKEN_1}',
            '{TOKEN_2}'
        ];

        return (new FirebaseMessage)
            ->withTitle('Hey, ', $notifiable->first_name)
            ->withBody('Happy Birthday!')
            ->asNotification($deviceTokens); // OR ->asMessage($deviceTokens);
    }
}

Tips

• Check example how to receive messages or push notifications in a JavaScript client.
• You can use pushnotification() helper instead of Facade.

Payload

Check how is formed payload to send to firebase:

Example 1:

PushNotification::withTitle('Test Title')->withBody('Test body')->sendNotification('token1');

{
  "registration_ids": [
    "token1"
  ],
  "notification": {
    "title": "Test Title",
    "body": "Test body"
  },
  "priority": "normal"
}

Example 2:

PushNotification::withTitle('Test Title')->withBody('Test body')->sendMessage('token1');

{
  "registration_ids": [
    "token1"
  ],
  "data": {
    "title": "Test Title",
    "body": "Test body"
  }
}

If you want to create payload from scratch you can use method fromRaw, for example:

return PushNotification::fromRaw([
    'registration_ids' => ['token1', 'token2'],
    'data' => [
        'key_1' => 'Value 1',
        'key_2' => 'Value 2'
    ],
    'android' => [
        'ttl' => '1000s',
        'priority' => 'normal',
        'notification' => [
            'key_1' => 'Value 1',
            'key_2' => 'Value 2'
        ],
    ],
])->send();