cimons/larafcm

Laravel FCM Package

Laravel-FCM

Introduction

Laravel-FCM is an easy to use package working with both Laravel and Lumen for sending push notification with Firebase Cloud Messaging (FCM)., _(*1)

It currently only supports HTTP protocol for :, _(*2)

• sending a downstream message to one device

Note: The XMPP protocol is not currently supported., _(*3)

Installation

To get the latest version of Laravel-FCM on your project, require it from "composer":, _(*4)

$ composer require cimons/larafcm:dev-master

Or you can add it directly in your composer.json file:, _(*5)

{
    "require": {
           "cimons/larafcm": "dev-master"
    }
}

Laravel

Register the provider directly in your app configuration file config/app.php config/app.php:, _(*6)

'providers' => [
    // ...

    Cimons\LaraFcm\LaraFcmServiceProvider::class,
]

Add the facade aliases in the same file:, _(*7)

'aliases' => [
    ...
    'FCM'             => Cimons\LaraFcm\Facades\FCM::class,
]

Copy the config file fcm.php manually from the directory /vendor/cimons/larafcm/config to the directory /config (you may need to create this directory)., _(*8)

Package Configuration

In your .env file, add the server key and the secret key for the Firebase Cloud Messaging:, _(*9)

FCM_SERVER_KEY=my_secret_server_key
FCM_SENDER_ID=my_secret_sender_id

Downstream Messages

A downstream message is a notification message, a data message, or both, that you send to a target device or to multiple target devices using its registration_Ids., _(*10)

The following use statements are required for the examples below:, _(*11)

use Cimons\LaraFcm\Message\NotificationBuilder;
use Cimons\LaraFcm\Facades\FCM;

Sending a Downstream Message to a Device

```php, <sub>(*12)</sub>

$notificationBuilder = NotificationBuilder('my title'); $notificationBuilder->setBody('Hello world') ->setSound('default'); $notification = $notificationBuilder->build();, <sub>(*13)</sub>

$token = "a_registration_from_your_database"; $downstreamResponse = FCM::sendTo($token, $notification);, <sub>(*14)</sub>

if ($downstreamResponse->isSent == 1) { echo "The message has been sent."; } else { echo "The message could not be sent." } ````, <sub>(*15)</sub>

Licence

This library is open-sourced software licensed under the MIT license., <sub>(*16)</sub>

Some of this documentation is coming from the official documentation. You can find it completely on the Firebase Cloud Messaging Website., <sub>(*17)</sub>