singlephon/hotification

Easy configurable event-based Laravel notification package.

v2.0.0 2024-12-18 12:39 UTC

Requires

• php: ^8.2
• illuminate/collections: ^10.0 || ^11.0
• illuminate/console: ^10.0 || ^11.0
• illuminate/database: ^10.0 || ^11.0
• illuminate/log: ^10.0 || ^11.0
• illuminate/notifications: ^10.0 || ^11.0
• illuminate/support: ^10.0 || ^11.0

Requires (Dev)

• phpunit/phpunit: ^10.0

MIT

• Rakhat Bakytzhanov

• notification
• singlephon
• hotification

README

Hotification is a powerful and flexible package for managing notifications in Laravel applications. It provides a convenient API for sending notifications, adding observers, and handling events.

Key Features

• Easy configuration through a single file: config/hotification.php.
• Extensibility with custom sender and observer classes.
• Instant sending of notifications to the database.
• Dynamic addition of observers for models.
• Execute any logic upon model changes.

Installation

1. Install via Composer:

composer require singlephon/hotification

php artisan hotification:install

1. Register the service provider and alias:

Add the following to config/app.php:

'providers' => [
    # ...
    Singlephon\Hotification\HotificationServiceProvider::class,
],
'aliases' => [
    # ...
    'Hotification' => \Singlephon\Hotification\Hotification::class,
]

Quick Start

Sending Notifications

Use the HotificationSender class for instant sending of notifications to the database:

use App\Models\User;

(new Hotification())
    ->notify(User::find(1))
    ->icon('exclamation-triangle')
    ->title('Important notification...')
    ->description('Some description...')
    ->url('/app/friends/invitations')
    ->actionable()
    ->send();

This will add a record to the notifications table.

Automating Notification Sending with Observers

Define observers and scheduled notifications directly in App\Hotification\Models and App\Hotification\Schedules classes.

Example: Configuring Observers

The example below demonstrates how to define observers for models in the App\Hotification\Models class:

namespace App\Hotification;

use Hotification;

class Models
{
    public function observers(): array
    {
        return [
            # ... 
        ];
    }
}

Using Observers for Models

The example below shows how to configure observers for the Post and User models using hooks like onCreated, onUpdated, and onDeleted:

return [
    \App\Models\Post::class => [
        # Send a notification when a new post is created
        'onCreated' => [
            \App\Notifications\PostCreatedNotification::class, # Should extend Singlephon\Hotification\Notifications\AbstractHotification
            function (Post $post) {
                # Callback to execute custom logic when a post is created
                # For example, sending a Push notification, logging, or modifying other properties
            },
        ],
        # Send a notification when a post is updated
        'onUpdated' => [
            \App\Notifications\PostUpdatedNotification::class,
        ]
    ],

    \App\Models\User::class => [
        'onCreated' => [
            function (User $user) {
                # Callback for executing logic when a new user is created
                # For example, sending a welcome message or logging activity
                (new Hotification())
                    ->notify($user)
                    ->icon('check-badge')
                    ->title('Welcome ' . $user->name)
                    ->description('Please continue registration form...')
                    ->url('/app/registration/continue')
                    ->actionable()
                    ->send();
            },
        ],
        # Send a notification when a user is deleted
        'onDeleted' => [
            \App\Notifications\ByeByeNotification::class,
            function (User $user) {
                # Callback for executing logic when a user is deleted
                # For example, sending a notification to the administrator
            }
        ]
    ]

]

⚠️ Note: Notification classes must extend the Singlephon\Hotification\Notifications\AbstractHotification class.

Advantages of Using Observers

• Centralized Logic: Allows all logic related to model events to be concentrated in one place.
• Easy Management: Easily add or change behavior on events by simply updating observer configuration.
• Extensibility: Use both built-in notifications and custom callbacks, providing flexibility in event handling.

Recommendations

• Use hooks only when necessary to avoid unnecessary complexity in logic.
• Avoid overloading a single hook with too many actions to maintain performance and ease of debugging.
• For complex logic, consider moving it into separate services or classes to maintain clean and readable code.

Using Scheduled Notifications

Scheduled notifications are defined in the App\Hotification\Schedules class. You can specify tasks to be performed on a schedule, such as sending notifications or executing custom logic.

Example: Configuring Scheduled Notifications

namespace App\Hotification;

use Notification;

class Schedules
{
    public function setup(): array
    {
        return [
            'weekly_report' => function (Schedule $schedule) {
                $schedule->call(function () {
                    (new Hotification())
                        ->notify(User::all())
                        ->icon('check-badge')
                        ->title('Welcome ' . $user->name)
                        ->description('Please continue registration form...')
                        ->url('/app/registration/continue')
                        ->actionable()
                        ->send();
                })->everyWeek(); # Runs every week
            },
            'daily_report' => [
                'events' => [
                    \App\Notifications\DailyReportNotification::class, # Sending a notification
                    function () {
                        # Logic for executing a custom action
                        # For example, generating a report and sending it via email
                    },
                ],
                'schedule' => '0 0 * * *', # Every day at midnight
            ]
        ]
    }
}

⚠️ Note: Notification classes must extend the Singlephon\Hotification\Notifications\AbstractHotification class.

Advantages of Using scheduled_notifications

• Flexibility: Combine notifications and custom callbacks in a single task.
• Convenience: Easily add and modify tasks using configuration files.
• Automation: Automatically perform routine tasks like sending reports or performing regular updates.

Recommendations

• Test your tasks: Ensure schedules are set correctly and tasks run at the intended times.
• Avoid overly frequent tasks: Schedule tasks at reasonable intervals to avoid overloading the system.
• Use callbacks for complex logic: If a task requires complex processing, move that logic into callbacks or separate services.

Dynamic Addition of Observers at Runtime

One of the key aspects of using Hotification is the ability to dynamically add observers (handlers) to models directly at runtime, not only through configuration files. This provides high flexibility and allows for programmatic management of notification behavior depending on context or business logic.

Example Code

Consider the following example, which dynamically adds an observer for the User model:

(new Hotification())
    ->manager()
    ->add(User::class,
        onUpdated: [function (User $user) {}],
        onCreated: [function (User $user) {}],
        onDeleted: [function (User $user) {}]
    );

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

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

Credits

• Rakhat Bakytzhanov
• All Contributors

License

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