erickskrauch/fcm

PHP application server for google firebase cloud messaging (FCM)

0.2.1 2022-12-21 20:00 UTC

Requires

• php: ^7.4 || ^8.0
• ext-json: *
• php-http/discovery: ^1.4
• psr/http-client: ^1.0
• psr/http-client-implementation: ^1.0
• psr/http-factory: ^1.0
• psr/http-factory-implementation: ^1.0

Requires (Dev)

• ely/php-code-style: ^0.4.0
• ergebnis/composer-normalize: ^2.28
• infection/infection: ^0.26.6
• nyholm/psr7: ^1.3
• php-http/mock-client: ^1.5
• phpstan/extension-installer: ^1
• phpstan/phpstan: ^1
• phpstan/phpstan-phpunit: ^1
• phpstan/phpstan-strict-rules: ^1
• phpunit/phpunit: ^9.5
• roave/security-advisories: dev-latest

MIT

• ErickSkrauch

• notifications
• google
• android
• gcm
• ios
• firebase
• FCM
• Firebase Cloud Messaging

README

Just another client to send push notifications via Firebase Cloud Messaging (FCM). The implementation is inspired by Paragraph1/php-fcm and its fork guigpm/php-fcm, but heavily reworked in favor of simpler code and better implementation.

Installation

This library relies on PSR-18 which defines how HTTP message should be sent and received. You can use any library to send HTTP messages that implements psr/http-client-implementation. Read more about PSR-18 in this blog.

To install this library with Guzzle you may run the following command:

composer require erickskrauch/fcm guzzlehttp/guzzle

Or using the curl client (you'll need to provide a PSR7 implementation such as nyholm/psr7 if not using Guzzle):

composer require erickskrauch/fcm php-http/curl-client nyholm/psr7

Usage

The component's constructor allows you to explicitly pass all dependencies. But you can also pass only the mandatory API token, and all other dependencies will be found automatically. The example below relies on auto discovery.

use ErickSkrauch\Fcm\Client;
use ErickSkrauch\Fcm\Message\Message;
use ErickSkrauch\Fcm\Message\Notification;
use ErickSkrauch\Fcm\Recipient\Device;

$client = new Client('YOUR SERVER KEY');

$notification = new Notification(, 'testing body');
$notification->setTitle('Wow, something happened...');
$notification->setBody('It just works!');

$message = new Message();
$message->setNotification($notification);
$message->setCollapseKey('collapse.key');

$recipient = new Device('your-device-token');

$result = $client->send($message, $recipient);

The library provides several implementations for the Recipient interface:

• Device is used to send notifications to a single device.
• Topic is used to send notifications to a single topic.
• MultipleDevices is used to send notifications to multiple devices. The FCM documentation doesn't recommend using this method to send to 1 device.
• MultipleTopics is used to send notifications to multiple topics combined by the operator ||.

At the moment, the library does not have a builder for complex conditions. But you can always create your own implementation of the Recipient interface:

use ErickSkrauch\Fcm\Recipient\Recipient;

class MyComplexCondition implements Recipient {

    public function getConditionParam(): string{
        return Recipient::PARAM_CONDITION;
    }
    
    public function getConditionValue(): string {
        return "'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)";
    }

}

Contribute

This library in an Open Source under the MIT license. It is, thus, maintained by collaborators and contributors.

Feel free to contribute in any way. As an example you may:

• Trying out the master code.
• Create issues if you find problems.
• Reply to other people's issues.
• Review PRs.

Ensuring code quality

The project has several tools for quality control. All checks are performed in CI, but if you want to perform checks locally, here are the necessary commands:

vendor/bin/php-cs-fixer fix -v
vendor/bin/phpstan analyse
vendor/bin/phpunit
vendor/bin/infection # Try "env XDEBUG_MODE=coverage vendor/bin/infection" in case of errors