plokko / firebase-php Goto Github PK

Php integration of Firebase API (FCM Http v1, RealTime database)

PHP 100.00%

firebase-php's Introduction

Firebase php

Php implementation of Firebase API.

Why

This package is built to be simple, scalable and configurable to allow easy integration in other packages or frameworks (ex: laravel-firebase ).

This package uses google/auth to generate OAuth2.0 tokens from the service account and guzzlehttp/guzzle as http library.

Install

Install it with composer via

composer require plokko/firebase-php

Usage

All the calls on the API are made using a Firebase OAuth2.0 token, this token is generated using your ServiceAccount informations.

Service Account

To use the API you need to authenticate the requests with your service account: this is done by the ServiceAccount class that uses your Firebase ServiceAccount json credential file. You can download your service account json file from the Firebase console in settings > service accounts, keep in mind to store this file in a secure non-public location.

use Plokko\Firebase\ServiceAccount;

//Use one of those methods:
$sa = new ServiceAccount('/path/to/your/serviceaccount/file.json');
$sa = new ServiceAccount('{"type":"service_account",..............}');
$sa = new ServiceAccount(['type'=>'service_account',/*...*/]);

Accepted methods for the constructor are:

string: ServiceAccount file content (json string)
string: path to the serviceAccount json file
array: php-translated array of the service account content

You can also add a token cache handler via the setCacheHandler method that accepts an implementation of CacheItemPoolInterface to allow custom cache integrations.

see google/auth MemoryCacheItemPool for an example implementation:

$handler = new Google\Auth\Cache\MemoryCacheItemPool\MemoryCacheItemPool();
$sa->setCacheHandler($handler);

FCM

This package implements FCM Http v1 Api

see FCM docs

Real time database

This package includes the Firebase Real time database API integration

see Real time database docs

firebase-php's People

Contributors

Stargazers

Watchers

Forkers

xhooch venux92 marianoarga wmedia xykcya pety-dc chte tbsmark86 nagasir

firebase-php's Issues

Multiline or HTML Body

Is it possible to include multiple lines or HTML in the content body.

$message->notification
->setTitle('Notification title')
->setBody('firstLine\nSecond Line');

$message->notification
->setTitle('Notification title')
->setBody('firstLine
second Line');

Any insight to the possibilities and limitation would be appreciated. thanks

Apns config does not work

Hi, I'm trying the apn settings to set the thread-id, since I need notifications to be repeated, or replaced with an existing one

https://stackoverflow.com/questions/49758268/can-you-set-thread-id-with-fcm-nottoos-for-ios

But I can not set this configuration, I'm doing it in the following way

$message->apns->payload->aps->thread_id = "example";

and I do not get an error but it does not work either

Composer require error

composer require plokko\firebase-php gives error:

[InvalidArgumentException]                                                                                                                                                                                      
Could not find a matching version of package plokkofirebase-php. Check the package spelling, your version constraint and that the package is available in a stability which matches your minimum-stability (dev).

Old Version on Composer

Would be cool if you could update the version on Composer too, the property "mutable content" is still missing there

Fail to set headers on webpush

I am trying to use the API to set TTL and priority settings for webpush, but the the API does not support it seems?

Request->submit

Should the following code for the submit method

return ($json && isset($json['message']['name']))?$json['message']['name']:null;

not be

return ($json && isset($json['name']))?$json['name']:null;

As the message object doesn't exist it's just returning null.

ApnsConfig

https://github.com/plokko/firebase-php/blob/master/src/FCM/Message/ApnsConfig.php#L28
This will throw an exception (InvalidArgumentException)

The JSON dictionary object must contain an aps key, the value of which is a dictionary containing data used by the system to deliver the notification.

For example
https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CreatingtheNotificationPayload.html#//apple_ref/doc/uid/TP40008194-CH10-SW1

Can not submit data as nested array

Hello,

Thank you for your awesome code, but I have a problem sending this kind of nested array in the data property

$message->data->fill(
      [
	 “type_of_food” => ”vegetable”,
	 “example” => 
                [
                    0 => 
                      [
                          "red" => “carrots”,
                          "green" => “broccoli”
                      ]
	       ]
      ]
)

Could you please help..the "example" part still recognized as an array in Flutter code