Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ankurk91/fcm-notification-channel
All in One Firebase push notification channel for Laravel :bell:
https://github.com/ankurk91/fcm-notification-channel
fcm firebase laravel notification-channel
Last synced: 8 days ago
JSON representation
All in One Firebase push notification channel for Laravel :bell:
- Host: GitHub
- URL: https://github.com/ankurk91/fcm-notification-channel
- Owner: ankurk91
- License: mit
- Created: 2022-01-16T08:12:38.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-15T14:04:49.000Z (24 days ago)
- Last Synced: 2024-10-29T20:45:07.465Z (10 days ago)
- Topics: fcm, firebase, laravel, notification-channel
- Language: PHP
- Homepage: https://packagist.org/packages/ankurk91/fcm-notification-channel
- Size: 89.8 KB
- Stars: 70
- Watchers: 4
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# FCM Notification Channel for Laravel
[](https://packagist.org/packages/ankurk91/fcm-notification-channel)
[](https://github.com/ankurk91/fcm-notification-channel/tags)
[](LICENSE.txt)
[](https://packagist.org/packages/ankurk91/fcm-notification-channel/stats)
[](https://github.com/ankurk91/fcm-notification-channel/actions)
[](https://codecov.io/gh/ankurk91/fcm-notification-channel)
Send [Firebase](https://firebase.google.com/docs/cloud-messaging) push notifications with Laravel php framework.
## Highlights
* Using the latest Firebase HTTP v1 [API](https://firebase.google.com/docs/cloud-messaging/migrate-v1)
* Send message to a topic or condition :wink:
* Send message to a specific device or multiple devices (Multicast)
* Send additional RAW data with notification
* Supports multiple Firebase projects in single Laravel app:fire:
* Invalid token handling with event and listeners
* Fully tested package with automated test cases
* Powered by battle tested [Firebase php SDK](https://firebase-php.readthedocs.io/) :rocket:
## Installation
You can install this package via composer:
```bash
composer require "ankurk91/fcm-notification-channel"
```
## Configuration
This package relies on [laravel-firebase](https://github.com/kreait/laravel-firebase) package to interact with Firebase
services. Here is the minimal configuration you need in your `.env` file
```dotenv
# relative or full path to the Service Account JSON file
FIREBASE_CREDENTIALS=firebase-credentials.json
```
You will need to create a [service account](https://firebase.google.com/docs/admin/setup#initialize-sdk)
and place the JSON file in your project root.
Additionally, you can update your `.gitignore` file
```gitignore
/firebase-credentials*.json
```
## Usage
You can use the FCM channel in the `via()` method inside your Notification class:
```php
withDefaultSounds()
->withNotification([
'title' => 'Order shipped',
'body' => 'Your order for laptop is shipped.',
])
->withData([
'orderId' => '#123'
]);
}
}
```
Prepare your Notifiable model:
```php
hasMany(DeviceToken::class);
}
public function routeNotificationForFCM($notification): string|array|null
{
return $this->deviceTokens->pluck('token')->toArray();
}
/**
* Optional method to determine which message target to use
* We will use TOKEN type when not specified
* @see \Kreait\Firebase\Messaging\MessageTarget::TYPES
*/
public function routeNotificationForFCMTargetType($notification): ?string
{
return \Kreait\Firebase\Messaging\MessageTarget::TOKEN;
}
/**
* Optional method to determine which Firebase project to use
* We will use default project when not specified
*/
public function routeNotificationForFCMProject($notification): ?string
{
return config('firebase.default');
}
}
```
## Send to a topic or condition
This package is not limited to sending notification to tokens.
You can use Laravel's [on-demand](https://laravel.com/docs/9.x/notifications#on-demand-notifications) notifications to
send push notification to a topic or condition or multiple tokens.
```php
route('FCMTargetType', MessageTarget::TOPIC)
->notify(new ExampleNotification());
Notification::route('FCM', "'TopicA' in topics")
->route('FCMTargetType', MessageTarget::CONDITION)
->notify(new ExampleNotification());
Notification::route('FCM', ['token_1', 'token_2'])
->route('FCMTargetType', MessageTarget::TOKEN)
->notify(new ExampleNotification());
```
## Events
You can consume Laravel's inbuilt notification [events](https://laravel.com/docs/9.x/notifications#notification-events)
```php
[
//\App\Listeners\FCMNotificationSent::class,
],
Events\NotificationFailed::class => [
\App\Listeners\FCMNotificationFailed::class,
],
];
}
```
Here is the example of the failed event listener class
```php
channel !== FCMChannel::class) {
return;
}
/** @var User $user */
$user = $event->notifiable;
$invalidTokens = $this->findInvalidTokens($user);
if (count($invalidTokens)) {
$user->deviceTokens()->whereIn('token', $invalidTokens)->delete();
}
}
protected function findInvalidTokens(User $user): array
{
$tokens = Arr::wrap($user->routeNotificationFor('FCM'));
if (! count($tokens)) {
return [];
}
$project = $user->routeNotificationFor('FCMProject');
$response = Firebase::project($project)->messaging()->validateRegistrationTokens($tokens);
return array_unique(array_merge($response['invalid'], $response['unknown']));
}
}
```
Read more about validating device
tokens [here](https://firebase-php.readthedocs.io/en/stable/cloud-messaging.html#validating-registration-tokens)
Then; you may want to ignore this exception in your `app/Exceptions/Handler.php`
```php
protected $dontReport = [
\NotificationChannels\FCM\Exception\InvalidRecipientException::class,
];
```
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
### Testing
```bash
composer test
```
### Security
If you discover any security issue, please email `pro.ankurk1[at]gmail[dot]com` instead of using the issue tracker.
### Attribution
The package is based on [this](https://github.com/kreait/laravel-firebase/pull/69) rejected PR
### License
This package is licensed under [MIT License](https://opensource.org/licenses/MIT).