mgilet/notification-bundle

A simple Symfony 3 bundle for user notifications

mgilet/notification-bundle

An easy yet powerful notification bundle for Symfony

, _(*1)

, _(*2)

, _(*3)

Create and manage notifications in an efficient way., _(*4)

Symfony support : * 2.7.x (bundle version 2.x) * 2.8.x (bundle version 2.x) * 3.x * 4.x, _(*5)

NOW SUPPORTS SYMFONY FLEX !

Version 3.0 out now., _(*6)

Features

• Easy setup
• Easy to use
• Powerful notification management
• Simple Twig render methods
• Fully customizable
• Multiple notifiables entities
• No bloated dependencies (little requirements)

Notice: Only Doctrine ORM is supported for now., _(*7)

Upgrade from 3.x

Custom Notification entity usage

If you use a custom Notification entitiy you must remove the resolve_target_entities directive from the doctrine configuration and add a configuration file., _(*8)

Example

After adding the customized notification class as in #39 just add a configuration file, _(*9)

config/packages/mgilet_notification.yaml, _(*10)

mgilet_notification:
  notification_class: App\Entity\MyCustomNotification

Installation & usage

This bundle is available on packagist., _(*11)

Add notification-bundle to your project :, _(*12)

$ composer require mgilet/notification-bundle

See documentation for next steps, _(*13)

Basic usage

class MyController extends Controller
{

    ...

    public function sendNotification(Request $request)
    {
      $manager = $this->get('mgilet.notification');
      $notif = $manager->createNotification('Hello world!');
      $notif->setMessage('This a notification.');
      $notif->setLink('https://symfony.com/');
      // or the one-line method :
      // $manager->createNotification('Notification subject', 'Some random text', 'https://google.fr/');

      // you can add a notification to a list of entities
      // the third parameter `$flush` allows you to directly flush the entities
      $manager->addNotification(array($this->getUser()), $notif, true);

      ...
    }

Translations

For now this bundle is only translated to de, en, es, fa, fr, it, nl, pt_BR, pl., _(*14)

Help me improve this by submitting your translations., _(*15)

Community

You can help make this bundle better by contributing (every pull request will be considered) or submitting an issue., _(*16)

Enjoy and share if you like it., _(*17)

Licence

MIT, _(*18)