Wallogit.com
2017 © Pedro Peláez
Event-driven notification bundle for Symfony 2 environment.
, (*1)
Event-driven notification bundle for Symfony 2 environment. Provides convenient way to manage user notifications in applications, for example to warn administrators about important events like user registration or notify users about any significant things for them like 'your order has been sent'. At that moment supports only swiftmailer as a notification channel, but it could be easily extended. Visual part could be rendered by any supported template engine like twig., (*2)
Install through composer:, (*3)
First step: require bundle, (*4)
composer require hadesarchitect/notification-bundle ~1
Second step: enable bundle, (*5)
<?php
// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
// ...
new HadesArchitect\NotificationBundle\HadesArchitectNotificationBundle(),
);
}
I'd like to receive notifications when someone comments my posts, assuming I've used FOSCommentBundle for commentaries functionality. To do it, I should make two simple steps:, (*6)
First of all, I need to write a template which would be rendered and send to me. I'll use a twig as a template engine. Every template will automatically take some arguments from handler, at that moment it's an event, event name and receiver information. Let me introduce you tiny twig template., (*7)
{# AcmeBundle:Notification:post_commented.html.twig #}
<h1>Post commented!</h1>
<p>Author: {{ event.comment.authorName }}</p>
<p>Time: {{ event.comment.createdAt|date('H:i:s d/m/Y') }}</p>
<p>Text: {{ event.comment.body }}</p>
After that, I should configure event handler., (*8)
ha_notification:
swiftmailer_channel:
sender: no-reply@my-project.com
handlers:
post_commented:
event: fos_comment.comment.post_persist
subject: Post commented!
receiver: administrator@my-project.com
template: AcmeBundle:Notification:post_commented.html.twig
That's all! Don't forget to ensure swiftmailer configuration because mail sending could be not configured or disabled in development environment., (*9)
After initial setup you should configure the bundle in appropriate way. Normally it could be done by some changes in app/config/config.yml or if you would like to keep user notifications in separate file you should create a new file, f.e. app/config/notifications.yml and include it in the config.yml (imports: [{resource: notifications.yml}])., (*10)
A typical way is to specify some data for handlers: expected event, receiver's data, subject and template, (*11)
ha_notification:
swiftmailer_channel:
sender: no-reply@my-project.com # We need to specify sender name for swiftmailer
handlers: # Array of handlers, you could configure as much handlers as you want to.
user_registered: # handler name, should be unique
event: fos_user.registration.completed # Expected event
receiver: administrator@mail.com # Admin email, could be an array of emails
subject: New user registered! # Subject, optional
template: Acme:Notifications:user_registered.html.twig # Template, optional (but recommended to create custom templates)
ha_notification:
default_channel: @ha_notification.channel.swiftmailer # Specify default notification channel, swiftmailer by default
swiftmailer_channel:
sender: no-reply@my-project.com
handlers:
user_registered:
event: fos_user.registration.completed
subject: New user registered!
receiver: administrator@mail.com
template: Acme:Notifications:user_registered.html.twig
handler_class: %ha_notification.handler.default_class% # Overrides handler class
templating: @templating #Templating engine service # Overrides templating engine for the handler
channel: @ha_notification.channel # Overrides notification channel for the handler
Parameters which you could override:, (*12)
Event-driven notification bundle for Symfony 2 environment.
MIT
Event-driven notification bundle for Symfony 2 environment.
MIT
Event-driven notification bundle for Symfony 2 environment.
MIT