symbiote/silverstripe-notifications

Send CMS editable system notifications from code

Installs: 809

Dependents: 3

Suggesters: 0

Stars: 14

Watchers: 8

Forks: 10

Open Issues: 0

Type:silverstripe-vendormodule

4.4.1 2019-11-14 04:34 UTC

README

Send CMS managed system email notifications from code.

Maintainer Contacts

Requirements

  • SilverStripe 4.0 +

Installation Instructions

composer require symbiote/silverstripe-notifications

Sending a notification

The module comes with a default BroadcastNotification object that can be used to send a notification to multiple people at once. First, create the SystemNotification (which defines how the notification will be sent)

Notifications => Add System Notification

  • Identifier: BROADCAST
  • Title: (your own)
  • Relevant For: BroadcastNotification
  • Send via channels: Internal
  • Text: (Your own; use $Context.Content to output the broadcast content)

Notifications => Add Broadcast Notification

  • Title: (your own)
  • Content: (your own)
  • Click Create
  • Groups: choose which groups to receive the notification
  • Send Now: Click when ready for the notification to send.

Creating System Notifications

Creating custom notifications requires a few pieces of code to put things together. Use the BroadcastNotification as an example, with the key points identified below

1)

In your _config yml file, add an identifier for each notification you require. This allows you to lookup Notification objects in the database from your code.

Symbiote\Notifications\Model\SystemNotification:
  identifiers:
    - 'NAME_OF_NOTIFICATION1'
    - 'NAME_OF_NOTIFICATION2'

2)

Add the NotifiedOn interface to any dataobjects that are relevant to the notifications you will be sending. This is required so the Notifications module can look up the below methods on your object to send the notification.

use Symbiote\Notifications\Model\NotifiedOn;

class MyDataObject extends DataObject implements NotifiedOn {
	...

Define the following interface methods on the Object being notified on.

/**
 * Return a list of available keywords in the format 
 * array('keyword' => 'A description') to help users format notification fields
 * @return array
 */
public function getAvailableKeywords();
/**
 * Gets an associative array of data that can be accessed in
 * notification fields and templates 
 * @return array
 */
public function getNotificationTemplateData();

Note: the follow template data is automatically included:

  • $ThemeDirs (an ArrayList object of themes, if you only have one theme using $ThemeDirs.First should be the same as the old $ThemeDir )
  • $SiteConfig
  • $MyDataObject (whatever the ClassName of your NotifiedOn DataObject is)
  • $Member (The Member object this message is being sent to)
/**
 * Gets the list of recipients for a given notification event, based on this object's 
 * state. 
 * $event The identifier of the event that triggered this notification
 * @return array An array of Member objects
 */
public function getRecipients($event);

Note: getRecipients() can return an array of any objects, as long as they have an Email property or method

3)

Create a notification in the Notifications model admin, in the CMS.

4)

Send the notification from your code, where $contextObject is an instance of the DataObject being NotifiedOn

use Symbiote\Notifications\Service\NotificationService;

singleton(NotificationService::class)->notify('NOTIFICATION_IDENTIFIER', $contextObject);

Templates

Notifications can be rendered with .ss templates. This is useful if you want to have a header/footer in your email notifications. You can either specify a template on a per/notification basis in the CMS, and/or set a default template for all notifications to be rendered with:

Symbiote\Notifications\Model\SystemNotification:
  default_template: EmailNotification

In your templates, you render the notification text with the $Body variable.

Configuration

You will probably want to configure a send_from email address -

Symbiote\Notifications\Service\EmailNotificationSender:
  send_notifications_from: 'notifications@example.com'

TODO

  • Test with QueuedJobs module for handling large amounts of notifications in configurable batches/queues