From a77d75c3ee2c99538d68009828e28ad208e5cb40 Mon Sep 17 00:00:00 2001 From: Stephane Bisson Date: Thu, 21 Jul 2016 12:25:46 -0400 Subject: [PATCH] Documentation for EventPresentationModel Change-Id: Ia620bd1a2a562c606752195cb459dc46d41db7b2 --- includes/formatters/EventPresentationModel.php | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/includes/formatters/EventPresentationModel.php b/includes/formatters/EventPresentationModel.php index 56b4d72e5..cb692e6ad 100644 --- a/includes/formatters/EventPresentationModel.php +++ b/includes/formatters/EventPresentationModel.php @@ -342,7 +342,7 @@ abstract class EchoEventPresentationModel implements JsonSerializable { * this. * * This message should be more compact than the header message - * returned by getHeaderMessage. It is displayed when a + * ( getHeaderMessage() ). It is displayed when a * notification is part of an expanded bundle. * * @return Message @@ -369,6 +369,12 @@ abstract class EchoEventPresentationModel implements JsonSerializable { * a parameter. It is expected that subclasses will override * this. The output of the message should be plaintext. * + * This message is used as the subject line in + * single-notification emails. + * + * For backward compatibility, if this is not defined, + * the header message ( getHeaderMessage() ) is used instead. + * * @return Message */ public function getSubjectMessage() {