Add Notification extender beforeSending method (#2533)

src/Extend/Notification.php

@@ -10,6 +10,8 @@
 namespace Flarum\Extend;
 
 use Flarum\Extension\Extension;
+use Flarum\Foundation\ContainerUtil;
+use Flarum\Notification\NotificationSyncer;
 use Illuminate\Contracts\Container\Container;
 
 class Notification implements ExtenderInterface
@@ -18,6 +20,7 @@ class Notification implements ExtenderInterface
     private $serializers = [];
     private $drivers = [];
     private $typesEnabledByDefault = [];
+    private $beforeSendingCallbacks = [];
 
     /**
      * @param string $blueprint The ::class attribute of the blueprint class.
@@ -51,6 +54,17 @@ class Notification implements ExtenderInterface
         return $this;
     }
 
+    /**
+     * @param callable|string $callback
+     * @return self
+     */
+    public function beforeSending($callback)
+    {
+        $this->beforeSendingCallbacks[] = $callback;
+
+        return $this;
+    }
+
     public function extend(Container $container, Extension $extension = null)
     {
         $container->extend('flarum.notification.blueprints', function ($existingBlueprints) {
@@ -74,5 +88,9 @@ class Notification implements ExtenderInterface
         $container->extend('flarum.notification.drivers', function ($existingDrivers) {
             return array_merge($existingDrivers, $this->drivers);
         });
+
+        foreach ($this->beforeSendingCallbacks as $callback) {
+            NotificationSyncer::beforeSending(ContainerUtil::wrapCallback($callback, $container));
+        }
     }
 }

src/Notification/NotificationSyncer.php

@@ -43,6 +43,11 @@ class NotificationSyncer
      */
     protected static $notificationDrivers = [];
 
+    /**
+     * @var array
+     */
+    protected static $beforeSendingCallbacks = [];
+
     /**
      * Sync a notification so that it is visible to the specified users, and not
      * visible to anyone else. If it is being made visible for the first time,
@@ -94,6 +99,10 @@ class NotificationSyncer
             $this->setDeleted($toUndelete, false);
         }
 
+        foreach (static::$beforeSendingCallbacks as $callback) {
+            $newRecipients = $callback($blueprint, $newRecipients);
+        }
+
         // Create a notification record, and send an email, for all users
         // receiving this notification for the first time (we know because they
         // didn't have a record in the database). As both operations can be
@@ -176,4 +185,12 @@ class NotificationSyncer
     {
         return static::$notificationDrivers;
     }
+
+    /**
+     * @param callable|string $callback
+     */
+    public static function beforeSending($callback): void
+    {
+        static::$beforeSendingCallbacks[] = $callback;
+    }
 }