Download the PHP package swanflutter/notification-master without Composer

swanflutter/notification-master

A modern, production-ready PHP 8.2+ / Laravel push notification package built on the Firebase Cloud Messaging (FCM) HTTP v1 API.

Supports real-time FCM delivery and a polling-mode fallback — all with a clean fluent API, typed exceptions, and first-class Laravel integration.

Table of Contents

• Requirements
• Installation
  • Laravel Setup
  • Standalone PHP Setup
• Configuration
• Usage — FCM Push
  • Send to a Device Token
  • Send to a Topic
  • Send to a Condition
  • Multicast (Multiple Tokens)
  • Advanced Message Builder
  • Raw Payload
  • Dry-Run Mode
  • Retry Configuration
• Usage — Laravel Notification Channel
• Usage — Laravel Facade
• Usage — Polling Mode
  • How Polling Works
  • Enqueue a Notification
  • Client Polling Endpoint
  • Flush & Forward via FCM
  • Custom Poll Store
• Exception Handling
• Testing
• Changelog
• License

Requirements

Note: This package uses swanflutter/native-jwt for JWT signing (RS256). It is a drop-in, dependency-free replacement for firebase/php-jwt with built-in alg=none and algorithm-confusion protection. The old firebase/php-jwt dependency has been removed.

Installation

Install the package via Composer:

To install a specific version:

Resolving a JWT library conflict

This package depends on swanflutter/native-jwt for RS256 JWT signing. If your application still requires the deprecated firebase/php-jwt, you can migrate to swanflutter/native-jwt, which is a drop-in replacement exposing the same JWT::encode() / JWT::decode() API:

If your application or another dependency still pins firebase/php-jwt, run composer why firebase/php-jwt to find which package holds it back.

Laravel Setup

The package is auto-discovered. After installing, publish the config file:

This creates config/push-notification.php in your application.

Set the path to your Firebase service-account JSON file in .env:

The service-account JSON is generated in the Firebase Console under Project Settings → Service Accounts → Generate New Private Key.

Standalone PHP Setup

No framework integration required — just instantiate FirebasePush directly:

Configuration

config/push-notification.php (after publishing):

Usage — FCM Push

Send to a Device Token

Send to a Topic

Send to a Condition

Multicast (Multiple Tokens)

Advanced Message Builder

Raw Payload

Send any FCM-compatible payload directly, bypassing the builder:

Dry-Run Mode

Retry Configuration

Usage — Laravel Notification Channel

Add toFcm() to your Laravel notification class:

Your notifiable model must implement routeNotificationForFcm() if no target is set on the Message:

Then send it like any other Laravel notification:

Usage — Laravel Facade

Usage — Polling Mode

Polling mode stores notifications server-side so that client devices can retrieve them on demand via a regular HTTP call. No native push infrastructure required.

How Polling Works

Enqueue a Notification

Schedule delivery for a future time:

Client Polling Endpoint

Flush & Forward via FCM

Deliver all queued notifications immediately via FCM and mark them delivered:

Custom Poll Store

Implement PollStoreInterface to use your own storage backend (Eloquent, Redis, SQS, …):

Bind it in your AppServiceProvider:

Exception Handling

All exceptions extend SwanFlutter\NotificationMaster\Exceptions\PushNotificationException.

Testing

For unit tests, use ArrayPollStore as a lightweight in-memory poll store:

Changelog

See CHANGELOG.md for a full history of changes.

License

This package is open-source software licensed under the MIT License.