Installation

Requirements

• PHP ^8.2
• Laravel 10, 11, 12 or 13 (illuminate/support, illuminate/database, illuminate/notifications)
• PostgreSQL, MySQL 8.0.13+ or SQLite

The migration creates unique indexes over COALESCE(...) expressions (functional key parts). MySQL supports them from 8.0.13; MariaDB does not support them at all.

Install

composer require fomvasss/laravel-notify-templates

The service provider and the NotifyTemplates facade alias are registered by package auto-discovery.

Publish and run the migrations:

php artisan vendor:publish --tag=notify-templates-migrations
php artisan migrate

Note

Before 0.12.1 the three migrations were published with the same timestamp, add_content_to_notify_logs_table ran first and failed with “table notify_logs doesn’t exist”. If you published them on an older version, delete that file (it is only for installs that created notify_logs on 0.8.x) or give it a later timestamp than create_notify_logs_table.

Each migration is published only if a file with the same name suffix is not in database/migrations yet, so running the command again after an upgrade publishes only the new ones.

Migration	Creates
create_notifytemplates_tables	notify_templates, notify_role_subscriptions, notify_user_settings
create_notify_logs_table	notify_logs — used only when the delivery log is enabled
add_content_to_notify_logs_table	notify_logs.subject, notify_logs.body for 0.8.x installs; a no-op when the columns exist

Publish the config if you need to change anything in it (optional):

php artisan vendor:publish --tag=notify-templates-config

Publish the status label translations if you want to change them (optional):

php artisan vendor:publish --tag=notify-templates-lang

Bind a recipient resolver

The package does not know your roles and users. If notifications are sent per role from event listeners, implement NotifyRoleResolverInterface and bind it — see Recipients & role subscriptions. The package itself never calls the resolver, so nothing breaks without a binding until your own code asks for it.

// AppServiceProvider::register()
$this->app->bind(
    \Fomvasss\NotifyTemplates\Contracts\NotifyRoleResolverInterface::class,
    \App\Services\AppNotifyRoleResolver::class,
);

First notification

php artisan notify:make OrderOrdered

This creates app/Notifications/OrderOrderedNotify.php. Fill in typeDefinition(), then create an active subscription for a role — nothing is sent for a regular type without one:

use Fomvasss\NotifyTemplates\Models\NotifyRoleSubscription;

NotifyRoleSubscription::create([
    'role_key' => 'client',
    'notify_key' => 'OrderOrdered',
    'is_active' => true,
    'channels' => ['mail'],
]);

Next: Notify types and Sending notifications.