alfa6661 / laravel-firebase

2.1.1 2017-11-30 04:26 UTC

Requires

• php: >=5.6.4
• paragraph1/php-fcm: *

Requires (Dev)

• mockery/mockery: ^0.9.5
• phpunit/phpunit: 4.*

MIT

• Alfa Adhitya

Published on Packagist.org on 2017-11-30 04:27 UTC

README

Google Firebase Notification for Laravel

This package makes it easy to send Firebase Notification with Laravel

Installation

You can install the package via composer:

composer require alfa6661/laravel-firebase

You must install the service provider:

// config/app.php
'providers' => [
    ...
    Alfa6661\Firebase\FirebaseServiceProvider::class,
],

Setting up your Firebase account

Add your Firebase Key to your config/services.php:

// config/services.php
...
'firebase' => [
    'api_key' => env('FIREBASE_API_KEY'),
],
...

Usage

Now you can use the channel in your via() method inside the notification:

use Alfa6661\Firebase\FirebaseChannel;
use Alfa6661\Firebase\FirebaseMessage;
use Illuminate\Notifications\Notification;

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

    public function toFirebase($notifiable)
    {
        return FirebaseMessage::create()
            ->title('Title')
            ->body('Push notification body')
            ->data(['id' => $notifiable->id]);
    }
}

In order to let your Notification know which device user(s) you are targeting, add the routeNotificationForFirebase method to your Notifiable model.

You can either return a single device token, or if you want to notify multiple device just return an array containing all devices.

public function routeNotificationForFirebase()
{
    return ["DEVICE_TOKEN", "DEVICE_TOKEN"];
}