Download the PHP package amjitk/laravel-global-notification without Composer

Laravel Global Notification

A comprehensive notification system for Laravel applications. This package allows you to manage notification types and templates via a CMS and automatically trigger them based on system events.

Features

• CMS Interface: Manage types, define variables, and test templates directly from the admin panel.
• Multi-Channel Support: Configure different templates for different channels for the same event.
• User Preference Center: Users can toggle specific notification channels on/off.
• Auto-Triggering: Automatically fire notifications on Eloquent model events (created, updated, etc.).
• In-App Toast Widget: Real-time polling widget to show notifications instantly.
• User Notification Center: Built-in UI for users to view and manage their in-app notifications.
• Dynamic Content: Use placeholders like {{name}} in your templates.

Installation

1. Install the package via Composer:

   Note: If testing locally without Packagist, configure your composer.json repositories to point to the local path.

2. Run Migrations:

3. (Optional) Publish Configuration and Assets:

Configuration

The configuration file config/global-notification.php allows you to customize:

• Channels: Enabled channels (default: mail, database).
• Route Prefix: URL prefix for the package routes (default: global-notification).
• Middleware: Middleware for admin routes. Configurable via .env:

Usage

1. Admin - Manage Notifications

Visit /global-notification/notification-types to create new Notification Types (e.g., order_placed).

• Variables: Define available variables (e.g. order_id, amount) when creating a Type.
• Templates: Create templates for each channel. Use the defined variables (e.g. {{ amount }}).
• Testing: Use the "Send Test" button on any template to send a dummy notification to yourself immediately.

2. Triggering Notifications

Manual Trigger

Use the NotificationService to send a notification programmatically:

Automatic Trigger (Model Events)

Add the AutoNotifyTrait to your Eloquent model:

3. Notification Logs

View all system notifications at: /global-notification/logs

This page displays a global log of all notifications triggered in the system.

4. Scheduled Notifications

You can schedule notifications using the package's send method combined with Laravel's Scheduler. This creates a powerful workflow where you can define templates in the CMS types and trigger them via Cron jobs.

Why use the package's send method instead of Notification::send or Mail::send? Using $service->send() allows you to:

1. Use CMS Templates: Manage the content of your scheduled emails/alerts dynamically without deploying code.
2. Separate Logging: By tagging them with withSource('scheduled'), they appear in the dedicated Scheduled Logs dashboard, separating them from transactional or user alerts.

Example: Sending a Daily Digest

5. In-App Widget (Toast)

To display a real-time toast notification in your application whenever a new notification arrives:

1. Make sure you have published the views (or reference the package view).

2. Add the following line to your main layout file (e.g., resources/views/layouts/app.blade.php), preferably just before the closing </body> tag:

3. Ensure your application layout includes Alpine.js or vanilla JS support (the component uses vanilla JS but allows for easy customization).

6. User Preferences

Users can manage their notification preferences (opt-in/out of specific channels) by visiting: /global-notification/preferences

• The interface allows users to toggle channels (e.g., turn off Email for "Order Updates" but keep it for "Promotions").
• The system automatically checks these preferences before sending any notification.

Testing

To run the package tests: