muchg0di/larafcm-http-v1

Implementation of FCM http v1 for laravel 5 (PHP 5.6)

dev-master 2024-08-28 16:20 UTC

Requires

• php: ^5.6
• google/auth: ^1.19
• guzzlehttp/guzzle: ^6.3
• illuminate/support: 5.*|^6

Requires (Dev)

• laravel/laravel: 5.2.*
• laravel/tinker: ^1.0
• mockery/mockery: 0.9.*
• phpunit/phpunit: 4.7.*
• satooshi/php-coveralls: 2.2.x-dev

MIT

• mUcHG0Di

• push
• firebase
• FCM

README

Implementation of FCM http v1 for Laravel 5 (PHP 5.6)

Table of Contents

• Disclaimer
• Introduction
• Installation
• Usage
• Configuration
• License

Disclaimer

This is an implementation for a really old setup, if you want something well implemented and updated, go check https://github.com/kreait/firebase-php and https://github.com/kreait/laravel-firebase. Maybe if I have time later, I'll improve this.

Introduction

This package provides an implementation of the Firebase Cloud Messaging (FCM) HTTP v1 protocol for Laravel 5 (PHP 5.6). It allows you to send push notifications to Android and iOS devices using the FCM service.

Installation

To install the package, run the following command in your terminal:

composer require muchg0di/larafcm-http-v1

Laravel

Register the provider directly in your app configuration file config/app.php config/app.php:

Laravel >= 5.5 provides package auto-discovery, thanks to rasmuscnielsen and luiztessadri who help to implement this feature in Laravel-FCM, the registration of the provider and the facades should not be necessary anymore.

'providers' => [
	// ...
	Muchg0di\LarafcmHttpV1\LarafcmHttpV1ServiceProvider::class,
]

Add the facade aliases in the same file:

'aliases' => [
	// ...
	'LarafcmHttpV1' => Muchg0di\LarafcmHttpV1\Facades\LarafcmHttpV1::class,
]

Usage

To use the package, you can import the Facade LarafcmHttpV1 call the createFirebaseDriver method to create a Firebase driver. Then, you can use the driver to send push notifications.

use LarafcmHttpV1;
use Muchg0di\LarafcmHttpV1\DataTransferObjects\NotificationPayloadDto;
use Muchg0di\LarafcmHttpV1\DataTransferObjects\RequestOptionsDto;

$payload = new NotificationPayloadDto('Title', 'Body');
$options = new RequestOptionsDto(30); // timeout in seconds

LarafcmHttpV1::driver('firebase')
    ->sendToTopic('topic-name', $payload, $options);

Configuration

You need to configure the package by publishing the configuration file and setting the FCM credentials.

php artisan vendor:publish --provider="Muchg0di\LarafcmHttpV1\LarafcmHttpV1ServiceProvider"

Then, update the config/larafcm-http-v1.php file with your FCM credentials.

'drivers' => [
    'firebase' => [
        'driver' => 'firebase',
        'project_id' => env('FIREBASE_PROJECT_ID', 'your project id'),
        'credentials' => env('FIREBASE_CREDENTIALS', 'path/to/your/firebase-credentials.json'),
        'scope' => env('FIREBASE_SCOPE', 'your-firebase-scope'),
    ],

License

This package is licensed under the MIT License.