Changeset 13112 for trunk/src/bp-notifications/bp-notifications-functions.php

Timestamp:

09/19/2021 03:58:09 PM (4 years ago)

Author:

imath

Message:

Improve SQL performance when updating/deleting a list of notifications

Instead of looping into a list of notifications to run an update/delete query for each notification, update/delete a list of notifications using a single query. Use primarly this change for message thread notifications and bulk notification actions.

Mainly introduces 2 new static methods to BP_Notifications_Notification:

• BP_Notifications_Notification::update_id_list() let you update a list of notifications using their notification IDs or component item IDs.
• BP_Notifications_Notification::delete_id_list() let you delete a list of notifications using their notification IDs or component item IDs.

Props oztaser

Fixes #8426

File:

• trunk/src/bp-notifications/bp-notifications-functions.php (modified) (2 diffs)

trunk/src/bp-notifications/bp-notifications-functions.php

@@ -386 +386 @@
 
 /**
+ * Delete notifications by notification ids.
+ *
+ * @since 10.0.0
+ *
+ * @param  int[]     $ids IDs of the associated notifications.
+ * @return int|false      The number of rows updated. False on error.
+ */
+function bp_notifications_delete_notifications_by_ids( $ids ) {
+    return BP_Notifications_Notification::delete_by_id_list( 'id', $ids );
+}
+
+/**
+ * Delete notifications by item ids and user.
+ *
+ * @since 10.0.0
+ *
+ * @param  int       $user_id          ID of the user whose notifications are being deleted.
+ * @param  int[]     $item_ids         IDs of the associated items.
+ * @param  string    $component_name   Name of the associated component.
+ * @param  string    $component_action Name of the associated action.
+ * @return int|false                   The number of rows updated. False on error.
+ */
+function bp_notifications_delete_notifications_by_item_ids( $user_id, $item_ids, $component_name, $component_action ) {
+    return BP_Notifications_Notification::delete_by_id_list(
+        'item_id',
+        $item_ids,
+        array(
+            'user_id'          => $user_id,
+            'component_name'   => $component_name,
+            'component_action' => $component_action
+        )
+    );
+}
+
+/**
  * Delete all notifications by type.
  *
@@ -581 +616 @@
             'component_name'   => $component_name,
             'component_action' => $component_action,
+        )
+    );
+}
+
+/**
+ * Mark notifications read/unread by item ids and user.
+ *
+ * @since 10.0.0
+ *
+ * @param  int       $user_id          ID of the user whose notifications are being deleted.
+ * @param  int[]     $item_ids         IDs of the associated items.
+ * @param  string    $component_name   Name of the associated component.
+ * @param  string    $component_action Name of the associated action.
+ * @param  int|false $is_new           0 for read, 1 for unread.
+ * @return int|false                   The number of rows updated. False on error.
+ */
+function bp_notifications_mark_notifications_by_item_ids( $user_id, $item_ids, $component_name, $component_action, $is_new = false ) {
+    return BP_Notifications_Notification::update_id_list(
+        'item_id',
+        $item_ids,
+        array(
+            'is_new' => $is_new,
+        ),
+        array(
+            'user_id'          => $user_id,
+            'component_name'   => $component_name,
+            'component_action' => $component_action
+        )
+    );
+}
+
+/**
+ * Mark notifications read/unread by notification ids.
+ *
+ * @since 10.0.0
+ *
+ * @param  int[]     $ids     IDs of the associated notification items.
+ * @param  int|false $is_new  0 for read, 1 for unread.
+ * @return int|false          The number of rows updated. False on error.
+ */
+function bp_notifications_mark_notifications_by_ids( $ids, $is_new = false ) {
+    return BP_Notifications_Notification::update_id_list(
+        'id',
+        $ids,
+        array(
+            'is_new' => $is_new,
         )
     );