synolia/syliusadminnotificationplugin

Admin Notification Plugin

Notification messages in your Sylius admin panel.

Features

• Add custom notification messages in your Sylius admin panel.
• Show list of notifications

Requirements

	Version
PHP	^7.4, ^8.0
Sylius	^1.9

Installation

1. Add the bundle and dependencies in your composer.json :

   composer require synolia/sylius-admin-notification-plugin

2. Import routing in your project config/routes/synolia_sylius_admin_notification.yaml:

   synolia_sylius_admin_notification_plugin:
       resource: "@SynoliaSyliusAdminNotificationPlugin/config/routes/admin_routing.yaml"
       prefix: '%sylius_admin.path_name%'

3. Apply plugin migrations to your database:

   bin/console doctrine:migrations:migrate

How to create a notification

Send notification using Symfony notifier

<?php

declare(strict_types=1);

namespace App\Notification;

use Symfony\Component\Notifier\Notification\Notification;
use Symfony\Component\Notifier\NotifierInterface;

final class SendTestNotification
{
    private NotifierInterface $notifier;

    public function __construct(NotifierInterface $notifier) {
        $this->notifier = $notifier;
    }

    protected function send(string $title, string $content): void
    {
        $notification = (new Notification($title, ['chat/admin_notification']))
            ->content($content);

        $this->notifier->send($notification);
    }
}

Send notification using monolog handler

monolog:
    channels: ['synolia_sylius_admin_notification']
    handlers:
        synolia_sylius_admin_notification:
            channels: [synolia_sylius_admin_notification]
            level: debug
            type: service
            id: Synolia\SyliusAdminNotificationPlugin\Handler\Monolog\AdminNotificationHandler

<?php

declare(strict_types=1);

namespace App\EnvieDeFraiseBundle\Command;

use Psr\Log\LoggerInterface;

final class SendTestNotification
{
    private LoggerInterface $synoliaSyliusAdminNotificationLogger;

    public function __construct(LoggerInterface $synoliaSyliusAdminNotificationLogger) {
        $this->synoliaSyliusAdminNotificationLogger = $synoliaSyliusAdminNotificationLogger;
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $this->synoliaSyliusAdminNotificationLogger->critical('Notification message', [
            'context_1' => 'this is the first context',
            'context_2' => [
                'key' => 'val'
            ],
        ]);
    }
}

Write logs as notification

monolog:
    handlers:
        synolia_sylius_admin_notification:
            level: debug
            type: service
            id: Synolia\SyliusAdminNotificationPlugin\Handler\Monolog\AdminNotificationHandler
        main:
            type: fingers_crossed
            action_level: error
            handler: grouped
            channels: [ "!deprecation", "!sonata"]
            excluded_http_codes: [404, 405]
            buffer_size: 50 # How many messages should be saved? Prevent memory leaks
        grouped:
            type: group
            members: [ nested, deduplicated ]
        nested:
            type: stream
            path: "%kernel.logs_dir%/%kernel.environment%.log"
            level: debug
        deduplicated:
            type: deduplication
            handler: synolia_sylius_admin_notification

Development

See How to contribute.

License

This library is under the EUPL-1.2 license.

Credits

Developed by Synolia.