Symbiote\Notifications\Model\SystemNotification
SystemNotification
- Author: marcus@symbiote.com.au, shea@livesource.co.nz
- License: http://silverstripe.org/bsd-license/
Synopsis
class SystemNotification
extends DataObject
implements
PermissionProvider
{
- // members
- private static string $table_name = 'SystemNotification';
- private static array $notify_on = ;
- private static array $identifiers = ;
- private static array $global_keywords = ;
- private static boolean $html_notifications = false;
- private static $default_template;
- private static array $db = ;
- // methods
- public FieldList getCMSFields()
- public array getKeywords()
- public ArrayList getRecipients()
- public string format()
- public ArrayData getTemplateData()
- public string getTemplate()
- public string NotificationContent()
- public void canView()
- public void canEdit()
- public void canDelete()
- public void canCreate()
- public void providePermissions()
Hierarchy
Extends
- SilverStripe\ORM\DataObject
Implements
- SilverStripe\Security\PermissionProvider
Members
private
- $db
- $default_template
—
string
Name of a template file to render all notifications with Note: it's up to the NotificationSender to decide whether or not to use it - $global_keywords
—
array
A list of globally available keywords for all NotifiedOn implementors - $html_notifications
—
boolean
If true, notification text can contain html and a wysiwyg editor will be used to create the notification text rather than textarea - $identifiers
—
array
A list of all the notifications that the system manages. - $notify_on
—
array
The list of types to allow users to select for being notified on, where the types don't implement NotifiedOn directly. - $table_name
Methods
public
- NotificationContent() — Get the notification content, whether that's html or plain text
- canCreate()
- canDelete()
- canEdit()
- canView()
- format() — Format text with given keywords etc
- getCMSFields()
- getKeywords() — Get a list of available keywords to help the cms user know what's available
- getRecipients() — Get a list of recipients from the notification with the given context
- getTemplate() — Get the custom or default template to render this notification with
- getTemplateData() — Get compiled template data to render a string with
- providePermissions()