kalitics/notification-bundle

Add notifications to symfony app

2.0.13 2021-10-05 09:25 UTC

Requires

• php: ^7.4
• doctrine/collections: ^1.5
• doctrine/doctrine-bundle: ^2.0
• doctrine/orm: ^2.7
• doctrine/persistence: ^2.2
• gedmo/doctrine-extensions: ^2.3.4 || ^3.0.0
• swiftmailer/swiftmailer: ^6.0
• symfony/config: ^4.4 || ^5.0
• symfony/console: ^4.4 || ^5.0
• symfony/dependency-injection: ^4.4 || ^5.0
• symfony/doctrine-bridge: ^4.4 || ^5.0
• symfony/form: ^4.4 || ^5.0
• symfony/framework-bundle: ^4.4 || ^5.0
• symfony/http-foundation: ^4.4 || ^5.0
• symfony/http-kernel: ^4.4 || ^5.0
• symfony/options-resolver: ^4.4 || ^5.0
• symfony/routing: ^4.4 || ^5.0
• symfony/validator: ^4.4 || ^5.0
• twig/twig: ^2.4 || ^3.0

MIT

• Gauthier Coste

README

Notifications management

Installation

Require the bundle using

composer require kalitics/notification-bundle

Create the file config/packages/kalitics_notification.yaml with the following content :

kalitics_notification:

Add a new path for template in config/packages/twig.yaml

twig:
    ...
    paths:
        '%kernel.project_dir%/vendor/kalitics/notification-bundle/src/Ressources/views': kaliticsNotification

Add a new entry in config/bundles.php to register the new bundle

Kalitics\NotificationBundle\KaliticsNotificationBundle::class => ['all' => true],

Create a new file config/routes/kalitics_notification.yaml

_kalitics_notification:
  resource: '@KaliticsNotificationBundle/Ressources/config/routes.xml'
  prefix: /kalitics/notifications/

Add the following in the application header to display the notifications icon

{{ include('@KaliticsNotification/icon/notifications_container.html.twig') }}

Add the following in the application layout to have the detail modal

{{ include('@KaliticsNotification/_includes/_modal.html.twig') }}

The management of notification Subscriptions is display using the following controller :

{{ render(path('kalitics_notification_subscription_manage', {'id' : app.user.id})) }}

important

There must be an entity User such as : `App\Entity\User\User`

There must be an entity Group such as : `App\Entity\Security\Group`

Database configuration

To get properly configured, the database need some informations such as Notification type and difusion lists using the following tables :

ntf_notification_subscription_included_groups
ntf_notification_subscription_included_members
ntf_notification_subscription_excluded_members

Usage

To trigger a notification,

$this->notificationService->generateNotification(NotificationTypeEnum::CREATE_USER);
//Where NotificationTypeEnum::CREATE_USER is the notification slug configured in database