\ParsedNotification
Given a {@link NotificationType} and data, parse the notification into message elements suitable for a {@link Sender}.
Synopsis
class ParsedNotification
implements
ParsedNotificationInterface
{
- // members
- protected $type;
- protected $data;
- protected $member;
- protected boolean $subject = false;
- protected boolean $systemSubject = false;
- protected boolean $shortMessage = false;
- protected boolean $richMessage = false;
- // methods
- public void __construct()
- public string getSubject()
- public string getSystemSubject()
- public string getShortMessage()
- public string getRichMessage()
- protected string getGeneric()
- protected string parse()
Hierarchy
Implements
Members
protected
- $data
- $member
- $richMessage
- $shortMessage
- $subject
- $systemSubject
- $type
Methods
protected
- getGeneric() — Retrieve a message element based on its field name. Will parse it if necessary.
- parse() — Parse a format from the Notification Type.
public
- __construct() — Instanciate a new ParsedNotification.
- getRichMessage() — Retrieve an HTML-enriched messages.
- getShortMessage() — Retrieve a Short Message suitable for an SMS message.
- getSubject() — Retrieve a short statement suitable for an Email message subject line.
- getSystemSubject() — Retrieve a short statement suitable for display in a private setting.