Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lkaybob/php-fcm-v1

Implementation of Firebase Cloud Messaging HTTP v1 API in PHP
https://github.com/lkaybob/php-fcm-v1

fcm firebase notifications php php-fcm

Last synced: 10 days ago
JSON representation

Implementation of Firebase Cloud Messaging HTTP v1 API in PHP

Host: GitHub
URL: https://github.com/lkaybob/php-fcm-v1
Owner: lkaybob
License: mit
Created: 2018-03-19T15:40:01.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-07-12T10:25:38.000Z (4 months ago)
Last Synced: 2024-10-13T13:22:24.864Z (24 days ago)
Topics: fcm, firebase, notifications, php, php-fcm
Language: PHP
Homepage: https://packagist.org/packages/lkaybob/php-fcm-v1
Size: 58.6 KB
Stars: 14
Watchers: 3
Forks: 17
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        
# php-fcm-v1

[![Build Status](https://github.com/lkaybob/php-fcm-v1/actions/workflows/main.yml/badge.svg)](https://github.com/lkaybob/php-fcm-v1/actions)

[![codecov](https://codecov.io/gh/lkaybob/php-fcm-v1/branch/master/graph/badge.svg)](https://codecov.io/gh/lkaybob/php-fcm-v1)

[![Latest Stable Version](https://poser.pugx.org/lkaybob/php-fcm-v1/v/stable)](https://packagist.org/packages/lkaybob/php-fcm-v1)

[![Total Downloads](https://poser.pugx.org/lkaybob/php-fcm-v1/downloads)](https://packagist.org/packages/lkaybob/php-fcm-v1)

[![License](https://poser.pugx.org/lkaybob/php-fcm-v1/license)](https://packagist.org/packages/lkaybob/php-fcm-v1)

php-fcm-v1 is an PHP implementation of [FCM](https://firebase.google.com/docs/cloud-messaging) HTTP v1 API

### What is different compared to others FCM Libraries?

Most of other libraries are implementation of FCM's [Legacy HTTP Server Protocol](https://firebase.google.com/docs/cloud-messaging/http-server-ref). It requires a server key from Firebase console (which means you have to copy and paste in your code) ([Docs](https://firebase.google.com/docs/cloud-messaging/auth-server#authorize_legacy_protocol_send_requests))

HTTP v1 API, in contrast, leverages OAuth2 security model. You need to get an access token (which is valid for about an hour) in order to request sending notification with service account's private key file. Although 

(See the blog [post](https://firebase.googleblog.com/2017/11/whats-new-with-fcm-customizing-messages.html) about HTTP v1 API)

### References

* [google/node-gtoken](https://github.com/google/node-gtoken)

* [google/google-auth-library-nodejs](https://github.com/google/google-auth-library-nodejs) 

  : Above two libraries let me understand how HTTP v1 API works in FCM

* [guzzlehttp/guzzle](https://github.com/guzzle/guzzle) : GuzzleHttp let this library to PSR7 compatible

* [Paragraph1/php-fcm](https://github.com/Paragraph1/php-fcm) : Inspired me how FCM libraries are used in Legacy HTTP Protocol

### How to use

* Install the library with composer

  ```

  composer require lkaybob/php-fcm-v1

  ```

****

* Import the library with *autoload.php*

  ```php

   setSingleREcipient('DEVICE_TOKEN');

  // Setup Notificaition title and body

  $notification -> setNotification('NOTIFICATION_TITLE', 'NOTIFICATION_BODY');

  // Build FCM request payload

  $client -> build($recipient, $notification);

  ```

* Fire in the FCM Server!

  ```php

  $result = $client -> fire();

  // You can check the result

  // If successful, true will be returned

  // If not, error message will be returned

  echo $result;

  ```

### Further Example

* Full Simple Example

  ```php

   setSingleRecipient('DEVICE_TOKEN');

  $notification -> setNotification('NOTIFICATION_TITILE', 'NOTIFICATION_BODY');

  $client -> build($recipient, $notification);

  $client -> fire();

  ```

* Using with *PRIOIRTY* option (for both Android & iOS)

  ```php

   setSingleRecipient('DEVICE_TOKEN');

  $notification -> setNotification('NOTIFICATION_TITLE', 'NOTIFICATION_BODY');

  $config -> setPriority(Config::PRIORITY_HIGH);

  $client -> build($recipient, $notification, null, $config);

  $result = $client -> fire();

  ```

* For independent platform (either Android or iOS)

  ```

  // Option Instance for Android

  // Use phpFCMv1\AndroidConfig Class

  $androidConfig = new Config\AndroidConfig();

  $androidConfig -> setPriority(Config\AndroidConfig::PRIORITY_HIGH);

  $client -> build($recipient, $notification, null, $androidConfig);

  

  // Option Instance for iOS (which is APNs header)

  // Use phpFCMv1\APNsCOnfig Class

  $apnsConfig = new APNsConfig();

  $apnsConfig -> setPriority(APNsConfig::PRIORITY_HIGH);

  $client -> build($recipient, $notification, null, $apnsConfig);

  ```

### Future Works

- [ ] Implement simultaneous send (Currently supports single recipient or topic one at a time)

- [ ] Setup Read the Docs

- [x] Add CI Test

- [x] Add CodeCov Badge