studiobosco/wn-backendnotifications-plugin

WinterCMS Backend notifications plugin

dev-main 2024-03-19 14:55 UTC

Requires

• composer/installers: ~1.0

MIT

• Ondrej Brinkel

README

This plugin provides an API and UI for sending notifications to backend users.

Usage

The plugin provides a new entry in the backend navigation that shows the number of notifications the user has and on the page it lists all notifications. If allowed by the user, it will make use of browser push-notifications. The plugin will poll for new notifications every 5 seconds.

Notifications can be created programatically by firing an event:

Event::fire('studiobosco.backendnotifications.notify', [$user, $subject, $body, $url, $key]);

• $user can be a user ID or a backend user object
• $subject is mandatory and a string representing the notification subject
• $body is optional and a string representing the html formatted body text of the notification
• $url is optional and a string represting the URL to which the notification should link to.
• $key is optional and if set, notifications with the same key will be debounced

Configuration

You can set the debounce time by creating a config file under config/studiobosco/backendnotifications.php with the following content:

<?php return [
    'debounceTime' => 30 // Debounce time in seconds
];