Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coder966/fcm-simple
PHP API for Firebase Cloud Messaging (FCM)
https://github.com/coder966/fcm-simple
fcm fcm-http firebase firebase-cloud-messaging gcm php
Last synced: 2 months ago
JSON representation
PHP API for Firebase Cloud Messaging (FCM)
- Host: GitHub
- URL: https://github.com/coder966/fcm-simple
- Owner: coder966
- Created: 2016-06-16T23:25:33.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-06-23T08:17:03.000Z (over 5 years ago)
- Last Synced: 2024-10-12T05:10:33.647Z (4 months ago)
- Topics: fcm, fcm-http, firebase, firebase-cloud-messaging, gcm, php
- Language: PHP
- Homepage:
- Size: 117 KB
- Stars: 13
- Watchers: 5
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# FCMSimple
[](https://packagist.org/packages/coder966/fcm-simple)
[](https://packagist.org/packages/coder966/fcm-simple)
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](https://github.com/coder966/FCMSimple/blob/master/Wiki.md "Wiki")
### Installation
You need PHP >= 5.4
```
$ composer require coder966/fcm-simple
```
### PHP Server
```php
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:
```java
Map 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.
```