Skip to content

Latest commit

 

History

History
79 lines (61 loc) · 2.2 KB

README.md

File metadata and controls

79 lines (61 loc) · 2.2 KB
Raw

FCMSimple

Latest Stable Version License

A PHP library to send messages to devices registered through Firebase Cloud Messaging (FCM).

Features:

  • Lightweight & simple
  • Zero dependencies
  • Implemented using cURL
  • Support sending to topics and tokens
  • Support various message options like CollapseKey, Priority, TimeToLive and more
  • Provides you with the tokens you should update/remove from your database

Usage

For further details, see the Wiki

Installation

You need PHP >= 5.4

$ composer require coder966/fcm-simple

PHP Server

require 'vendor/autoload.php';

use FCMSimple\Client;
use FCMSimple\Message;

// create the client
$client = new Client("YOUR_SERVER_KEY");

// create the message
$msg = new Message();
$msg->put("key1", "value1");
$msg->put("key2", "value2");

// send the message to a specific topic
$client->sendToTopic($msg, "my_topic");

// or you can send to specific devices using their registration tokens
// so first prepare your array of tokens, typically retrieve from DB
$tokens = [
    "token_1",
    "token_2",
    "token_3"
];
// and send
$client->sendToTokens($msg, $tokens);

Android Client

In the service that extends FirebaseMessagingService, in method onMessageReceived, use:

Map<String, String> msg = remoteMessage.getData();
String value1 = msg.get("key1");
String value2 = msg.get("key2");

License

Copyright 2016 Khalid H. Alharisi

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.