Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kutia-software-company/larafirebase
😍 Laravel Firebase Cloud Messaging. ✍️ Developed by Gentrit Abazi.
https://github.com/kutia-software-company/larafirebase
firebase firebase-cloud-messaging larafirebase laravel laravel-fcm laravel-firebase laravel-firebase-push-notification laravel-push-notifications laravel-real-time notifications php php-fcm php-firebase
Last synced: 24 days ago
JSON representation
😍 Laravel Firebase Cloud Messaging. ✍️ Developed by Gentrit Abazi.
- Host: GitHub
- URL: https://github.com/kutia-software-company/larafirebase
- Owner: kutia-software-company
- License: mit
- Created: 2021-01-28T22:24:24.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-06T07:10:40.000Z (6 months ago)
- Last Synced: 2024-10-01T06:23:20.361Z (about 1 month ago)
- Topics: firebase, firebase-cloud-messaging, larafirebase, laravel, laravel-fcm, laravel-firebase, laravel-firebase-push-notification, laravel-push-notifications, laravel-real-time, notifications, php, php-fcm, php-firebase
- Language: PHP
- Homepage:
- Size: 114 KB
- Stars: 368
- Watchers: 12
- Forks: 78
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
### Introduction
**Larafirebase** is a package thats offers you to send push notifications or custom messages via Firebase in Laravel.
Firebase Cloud Messaging (FCM) is a cross-platform messaging solution that lets you reliably deliver messages at no cost.
For use cases such as instant messaging, a message can transfer a payload of up to 4KB to a client app.
### Installation
Follow the steps below to install the package.
**Composer**
```
composer require kutia-software-company/larafirebase
```
**Copy Config**
Run `php artisan vendor:publish --provider="Kutia\Larafirebase\Providers\LarafirebaseServiceProvider"` to publish the `larafirebase.php` config file.
**Get Athentication Key**
Get Authentication Key from https://console.firebase.google.com/
**Configure larafirebase.php as needed**
```
'authentication_key' => '{AUTHENTICATION_KEY}'
```
### Usage
Follow the steps below to find how to use the package.
Example usage in **Controller/Service** or any class:
```php
use Kutia\Larafirebase\Facades\Larafirebase;
class MyController
{
private $deviceTokens =['{TOKEN_1}', '{TOKEN_2}'];
public function sendNotification()
{
return Larafirebase::withTitle('Test Title')
->withBody('Test body')
->withImage('https://firebase.google.com/images/social.png')
->withIcon('https://seeklogo.com/images/F/firebase-logo-402F407EE0-seeklogo.com.png')
->withSound('default')
->withClickAction('https://www.google.com')
->withPriority('high')
->withAdditionalData([
'color' => '#rrggbb',
'badge' => 0,
])
->sendNotification($this->deviceTokens);
// Or
return Larafirebase::fromArray(['title' => 'Test Title', 'body' => 'Test body'])->sendNotification($this->deviceTokens);
}
public function sendMessage()
{
return Larafirebase::withTitle('Test Title')
->withBody('Test body')
->sendMessage($this->deviceTokens);
// Or
return Larafirebase::fromArray(['title' => 'Test Title', 'body' => 'Test body'])->sendMessage($this->deviceTokens);
}
}
```
Example usage in **Notification** class:
```php
use Illuminate\Notifications\Notification;
use Kutia\Larafirebase\Messages\FirebaseMessage;
class SendBirthdayReminder extends Notification
{
/**
* Get the notification's delivery channels.
*/
public function via($notifiable)
{
return ['firebase'];
}
/**
* Get the firebase representation of the notification.
*/
public function toFirebase($notifiable)
{
$deviceTokens = [
'{TOKEN_1}',
'{TOKEN_2}'
];
return (new FirebaseMessage)
->withTitle('Hey, ', $notifiable->first_name)
->withBody('Happy Birthday!')
->asNotification($deviceTokens); // OR ->asMessage($deviceTokens);
}
}
```
### Tips
- Check example how to receive messages or push notifications in a [JavaScript client](/javascript-client).
- You can use `larafirebase()` helper instead of Facade.
### Payload
Check how is formed payload to send to firebase:
Example 1:
```php
Larafirebase::withTitle('Test Title')->withBody('Test body')->sendNotification('token1');
```
```json
{
"registration_ids": [
"token1"
],
"notification": {
"title": "Test Title",
"body": "Test body"
},
"priority": "normal"
}
```
Example 2:
```php
Larafirebase::withTitle('Test Title')->withBody('Test body')->sendMessage('token1');
```
```json
{
"registration_ids": [
"token1"
],
"data": {
"title": "Test Title",
"body": "Test body"
}
}
```
If you want to create payload from scratch you can use method `fromRaw`, for example:
```php
return Larafirebase::fromRaw([
'registration_ids' => ['token1', 'token2'],
'data' => [
'key_1' => 'Value 1',
'key_2' => 'Value 2'
],
'android' => [
'ttl' => '1000s',
'priority' => 'normal',
'notification' => [
'key_1' => 'Value 1',
'key_2' => 'Value 2'
],
],
])->send();
```
---
Made with ♥ by Gentrit Abazi ([@gentritabazi](https://github.com/gentritabazi)).