Downloads
Stars
Version
Here's the latest documentation on Laravel Notifications System: https://laravel.com/docs/master/notifications
This package makes it easy to send notifications using Firebase with Laravel 5.
$ composer require feugene/firebase-notifications-laravel "^2.1"
Installed
composer
is required (how to install composer).
You need to fix the major version of package.
Laravel 5.5 and above uses Package Auto-Discovery, so doesn't require you to manually register the service-provider. Otherwise you must add the service provider to the providers
array in ./config/app.php
:
<?php
return [
// ...
'providers' => [
// ...
Feugene\FirebaseNotificationsChannel\FcmServiceProvider::class,
],
];
If you wants to disable package service-provider auto discover, just add into your composer.json next lines:
{
"extra": {
"laravel": {
"dont-discover": [
"feugene/firebase-notifications-laravel"
]
}
}
}
You need to set up firebase channel in config file ./config/services.php
.
To generate a private key file for your service account:
Next select the "driver" file
or config
contains credintails for Firebase service account in ./config/services.php
:
<?php
return [
// ...
/*
|--------------------------------------------------------------------------
| Firebase Settings section
|--------------------------------------------------------------------------
|
| Here you may specify some configs for FCM.
|
*/
'fcm' => [
/*
|----------------------------------------------------------------------
| Firebase service driver
|----------------------------------------------------------------------
|
| Value `file` or `config`:
| - Select `file` option to make service read json file
| - Select `config` option to set up all section in config file
|
*/
'driver' => env('FCM_DRIVER', 'config'),
/*
|---------------------------------------------------------------------
| FCM Drivers
|---------------------------------------------------------------------
|
| Here are each of the firebase.
|
*/
'drivers' => [
'file' => [
'path' => env('FCM_FILE_PATH', base_path('storage/fcm.json')),
],
'config' => [
/*
|------------------------------------------------------------
| Credentials
|------------------------------------------------------------
|
| Content of `firebase.json` file in config. Using if
| `fcm.driver` is `config`. All fields required!
|
*/
'credentials'=>[
'private_key_id' => env('FCM_CREDENTIALS_PRIVATE_KEY_ID', 'da80b3bbceaa554442ad67e6be361a66'),
'private_key' => env('FCM_CREDENTIALS_PRIVATE_KEY', '-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n'),
'client_email' => env('FCM_CREDENTIALS_CLIENT_EMAIL', '[email protected]'),
'client_id' => env('FCM_CREDENTIALS_CLIENT_ID', '22021520333507180281'),
'auth_uri' => env('FCM_CREDENTIALS_AUTH_URI', 'https://accounts.google.com/o/oauth2/auth'),
'token_uri' => env('FCM_CREDENTIALS_TOKEN_URI', 'https://oauth2.googleapis.com/token'),
'auth_provider_x509_cert_url' => env('FCM_CREDENTIALS_AUTH_PROVIDER_CERT', 'https://www.googleapis.com/oauth2/v1/certs'),
'client_x509_cert_url' => env('FCM_CREDENTIALS_CLIENT_CERT', 'https://www.googleapis.com/robot/v1/metadata/x509/firebase-adminsdk-mwax6%40test.iam.gserviceaccount.com'),
],
],
],
],
];
Now you can use the channel in your via()
method inside the notification as well as send a push notification:
<?php
use Illuminate\Notifications\Notification;
use Feugene\FirebaseNotificationsChannel\FcmChannel;
use Feugene\FirebaseNotificationsChannel\FcmMessage;
class AccountApproved extends Notification
{
public function via($notifiable)
{
return [FcmChannel::class];
}
/**
* @return FcmMessage
*/
public function toFcm(): FcmMessage
{
return (new FcmMessage)
->setTitle('Approved!')
->setBody('Your account was approved!');
}
}
<?php
use Illuminate\Notifications\Notifiable;
use Feugene\FirebaseNotificationsChannel\Receivers\FcmDeviceReceiver;
use Feugene\FirebaseNotificationsChannel\Receivers\FcmNotificationReceiverInterface;
class SomeNotifible
{
use Notifiable;
/**
* Reveiver of firebase notification.
*
* @return FcmNotificationReceiverInterface
*/
public function routeNotificationForFcm(): FcmNotificationReceiverInterface
{
return new FcmDeviceReceiver($this->firebase_token);
}
}
Subscribe devices on topic
<?php
class PushTopicSendCommand extends Command
{
public function handle(): void
{
$topicName = 'topic-name';
$resultList = app('firebase')->subscribe($topicName, [
"eKYl5MT4Ra8:APA91bHZXfYo....tGMs4UxJS9LI_V",
"eKY...UxJS9LI_F",
]);
dd($resultList, app('firebase')->getLastResponse());
}
}
Example Notification Message:
<?php
namespace App\Notifications;
use Feugene\FirebaseNotificationsChannel\FcmChannel;
use Feugene\FirebaseNotificationsChannel\FcmMessage;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Notifications\Notification;
/**
* Class PushToDeviceMsg
* @package App\Notifications
*/
class PushToDeviceMsg extends Notification implements Arrayable
{
/** @var string */
protected $title;
/** @var string */
protected $body;
/** @var array */
protected $data;
/** @var bool */
protected $mutableContent;
public function __construct(string $title, string $body, array $data = [], $mutableContent = true)
{
$this->title = $title;
$this->body = $body;
$this->data = $data;
$this->mutableContent = $mutableContent;
}
/**
* @return array
*/
public function via(): array
{
return [FcmChannel::class];
}
/**
* @return FcmMessage
*/
public function toFcm(): FcmMessage
{
$msg = (new FcmMessage)
->setTitle($this->title)
->setBody($this->body)
->setData($this->data);
if ($this->mutableContent) {
$msg
->getApns()
->enableMutableContent();
$msg
->getApns()
->setCategory('ActionRichPush');
$msg
->getApns()
->setTitle($this->title);
$msg
->getApns()
->setBody($this->body);
$msg
->getAndroid()
->setHideNotification(true);
}
return $msg;
}
/**
* @return array
*/
public function toArray(): array
{
return [
'title' => $this->title,
'body' => $this->body,
'data' => $this->data,
];
}
}
This pakage supports all fields from HTTP v1 FCM API. Message class contains setters for all the fields:
Field | Type |
---|---|
data |
array |
title |
string |
body |
string |
android |
AndroidFcmPlatformSettings |
webpush |
WebpushFcmPlatformSettings |
apns |
AppleFcmPlatformSettings |
PlatformSettings classes contain platform secific setters
For package testing we use phpunit
framework. Just write into your terminal (installed docker-ce
is required):
$ git clone [email protected]:efureev/firebase-notifications-laravel.git ./firebase-notifications-laravel && cd $_
$ make install
$ make test
Changes log can be found here.
If you will find any package errors, please, make an issue in current repository.
If you discover any security related issues, please email [email protected]
instead of using the issue tracker.
This is open-sourced software licensed under the MIT License.