Merge "Fix type for UserMailer::send $body param"

[lhc/web/wiklou.git] / includes / mail / EmailNotification.php

diff --git a/includes/mail/EmailNotification.php b/includes/mail/EmailNotification.php
index d32e93f..8a089f6 100644 (file)
--- a/includes/mail/EmailNotification.php
+++ b/includes/mail/EmailNotification.php
@@ -23,8 +23,8 @@
  * @author Tim Starling
  * @author Luke Welling lwelling@wikimedia.org
  */
-use MediaWiki\Linker\LinkTarget;
 
+use MediaWiki\Linker\LinkTarget;
 use MediaWiki\MediaWikiServices;
 
 /**
@@ -75,6 +75,20 @@ class EmailNotification {
         */
        protected $editor;
 
+       /**
+        * Extensions that have hooks for
+        * UpdateUserMailerFormattedPageStatus (to provide additional
+        * pageStatus indicators) need a way to make sure that, when their
+        * hook is called in SendWatchlistemailNotification, they only
+        * handle notifications using their pageStatus indicator.
+        *
+        * @since 1.33
+        * @return string
+        */
+       public function getPageStatus() {
+               return $this->pageStatus;
+       }
+
        /**
         * @deprecated since 1.27 use WatchedItemStore::updateNotificationTimestamp directly
         *
@@ -444,11 +458,12 @@ class EmailNotification {
        /**
         * Does the per-user customizations to a notification e-mail (name,
         * timestamp in proper timezone, etc) and sends it out.
-        * Returns true if the mail was sent successfully.
+        * Returns Status if email was sent successfully or not (Status::newGood()
+        * or Status::newFatal() respectively).
         *
         * @param User $watchingUser
         * @param string $source
-        * @return bool
+        * @return Status
         * @private
         */
        function sendPersonalised( $watchingUser, $source ) {