Download the PHP package devkandil/notifire without Composer

Laravel FCM Notifier 🔥📬

Send push notifications with style, grace, and a tiny bit of panic.

A Laravel package for sending Firebase Cloud Messaging (FCM) notifications with support for Laravel's notification system.

Why?

Because your app deserves to annoy users in real-time — respectfully, of course.

Features

• Easy integration with Laravel's notification system
• Support for both simple and complex FCM messages
• Fluent interface for building notifications
• Automatic logging of notification delivery status
• Database migration for storing FCM tokens
• Configurable default settings
• Send notification to single or multiple topics

Coming Soon

• More methods
• Better docs
• A therapist for your app’s notification anxiety

Installation

You can install the package via composer:

Configuration

1. Publish the package files:

2. Add your Firebase project ID to your .env file:

3. Place your Firebase service account credentials JSON file in your Laravel storage directory:

Important: Make sure to add this file to your .gitignore to keep your credentials secure.

If you need to use a different location for your credentials file, you can modify the credentials_path value in the published config file (config/fcm.php).

4. Run the migrations:

5. Add the fcm_token field to your model's $fillable array:

This is required for the package to store FCM tokens.

Custom Model Configuration

By default, the package uses the User model and users table. To use a different model, update your config/fcm.php:

Note: Make sure to set the table config before running migrations, as the migration uses this value to determine which table to add the fcm_token column to.

Usage

Using the Facade

Direct Usage

Updating FCM Token

The package includes a built-in controller (FcmController) that handles FCM token updates. This controller is automatically loaded by the package and doesn't need to be published to your application.

You can use the provided API endpoint to update a user's FCM token:

Headers:

Request Body:

Response:

Note: The route is automatically registered with Sanctum authentication middleware. Make sure your user is authenticated with Sanctum before making this request.

Using the HasFcm Trait

Add the HasFcm trait to your model to easily manage FCM tokens and send notifications:

This trait provides the following methods:

Using Laravel Notifications

The package includes an example notification that demonstrates all available features:

To create your own notification:

1. Create a notification:

2. Implement the toFcm method:

3. Add the FCM channel to your notification:

4. Add the HasFcm trait to your Notifiable model (this automatically adds the routeNotificationForFcm method):

5. Send the notification:

Sending to Topics with Laravel Notifications

To send notifications to topics instead of individual users, use the toTopics() method on FcmMessage:

Or for multiple topics:

Then trigger the notification:

Raw FCM Messages

For complete control over the FCM message payload, you can use the fromRaw method. This method allows you to send a custom FCM message with your own payload structure:

This method is useful when you need to customize the FCM message beyond what the fluent interface provides, or when you're migrating from an existing FCM implementation.

Available Notification Options

The NotiFire package provides several options to customize your notifications:

When using the HasFcm trait, you can pass these options as an array:

Logging

All notification attempts are automatically logged. You can find the logs in your Laravel log files with the following contexts:

• Successful notifications: info level with message ID
• Failed notifications: error level with error details
• Missing FCM tokens: warning level

You can disable logging by setting the FCM_LOGGING_ENABLED environment variable:

Debugging

By default, the package silently returns false when a notification fails to send. To help debug issues like cURL errors, authentication failures, or invalid tokens, you can enable exception throwing:

When enabled, the package will:

1. Log the error (if logging is enabled)
2. Throw the original exception instead of returning false

This is useful for debugging production issues or during development when you want to see the exact error that occurred.

Testing

To run the tests, you need to have a valid Firebase configuration:

1. Set up your Firebase project and obtain the credentials JSON file

2. Configure your .env file with the required Firebase variable:

3. Place your Firebase service account credentials JSON file in your Laravel storage directory:

4. Optionally, you can set a custom FCM test token in your .env file:

This is particularly useful when running tests in applications that use this package, as you won't be able to modify the test files in the vendor directory.

5. When writing tests, make sure to use properly formatted FCM tokens. Firebase Cloud Messaging tokens follow a specific format:

The token typically consists of:

• A registration ID (before the colon)
• A colon separator
• A string starting with "APA91b" followed by a Base64-encoded payload

Using invalid token formats (like test-token) will cause tests to fail when run against the actual Firebase service.

Then run the tests:

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

Credits

• Abdelrazek Kandil

License

The MIT License (MIT). Please see License File for more information.