[8.x] Customize type column in database notifications using databaseT…

…ype me… (#39811) * Customize type column in database notifications using databaseType method. * Update DatabaseChannel.php * formatting Co-authored-by: Taylor Otwell <taylor@laravel.com>
laravel · Nov 29, 2021 · a8f9d65 · a8f9d65
1 parent ab69133
commit a8f9d65
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 17 deletions.
diff --git a/src/Illuminate/Notifications/Channels/DatabaseChannel.php b/src/Illuminate/Notifications/Channels/DatabaseChannel.php
@@ -21,6 +21,25 @@ public function send($notifiable, Notification $notification)
         );
     }
 
+    /**
+     * Build an array payload for the DatabaseNotification Model.
+     *
+     * @param  mixed  $notifiable
+     * @param  \Illuminate\Notifications\Notification  $notification
+     * @return array
+     */
+    protected function buildPayload($notifiable, Notification $notification)
+    {
+        return [
+            'id' => $notification->id,
+            'type' => method_exists($notification, 'databaseType')
+                        ? $notification->databaseType($notifiable)
+                        : get_class($notification),
+            'data' => $this->getData($notifiable, $notification),
+            'read_at' => null,
+        ];
+    }
+
     /**
      * Get the data for the notification.
      *
@@ -43,21 +62,4 @@ protected function getData($notifiable, Notification $notification)
 
         throw new RuntimeException('Notification is missing toDatabase / toArray method.');
     }
-
-    /**
-     * Build an array payload for the DatabaseNotification Model.
-     *
-     * @param  mixed  $notifiable
-     * @param  \Illuminate\Notifications\Notification  $notification
-     * @return array
-     */
-    protected function buildPayload($notifiable, Notification $notification)
-    {
-        return [
-            'id' => $notification->id,
-            'type' => get_class($notification),
-            'data' => $this->getData($notifiable, $notification),
-            'read_at' => null,
-        ];
-    }
 }
diff --git a/tests/Notifications/NotificationDatabaseChannelTest.php b/tests/Notifications/NotificationDatabaseChannelTest.php
@@ -49,6 +49,24 @@ public function testCorrectPayloadIsSentToDatabase()
         $channel = new ExtendedDatabaseChannel;
         $channel->send($notifiable, $notification);
     }
+
+    public function testCustomizeTypeIsSentToDatabase()
+    {
+        $notification = new NotificationDatabaseChannelCustomizeTypeTestNotification;
+        $notification->id = 1;
+        $notifiable = m::mock();
+
+        $notifiable->shouldReceive('routeNotificationFor->create')->with([
+            'id'        => 1,
+            'type'      => 'MONTHLY',
+            'data'      => ['invoice_id' => 1],
+            'read_at'   => null,
+            'something' => 'else',
+        ]);
+
+        $channel = new ExtendedDatabaseChannel;
+        $channel->send($notifiable, $notification);
+    }
 }
 
 class NotificationDatabaseChannelTestNotification extends Notification
@@ -59,6 +77,19 @@ public function toDatabase($notifiable)
     }
 }
 
+class NotificationDatabaseChannelCustomizeTypeTestNotification extends Notification
+{
+    public function toDatabase($notifiable)
+    {
+        return new DatabaseMessage(['invoice_id' => 1]);
+    }
+
+    public function databaseType()
+    {
+        return 'MONTHLY';
+    }
+}
+
 class ExtendedDatabaseChannel extends DatabaseChannel
 {
     protected function buildPayload($notifiable, Notification $notification)