Changeset 11888 for trunk/src/bp-notifications/classes/class-bp-notifications-notification.php

Timestamp:

03/05/2018 12:57:24 PM (7 years ago)

Author:

boonebgorges

Message:

Move notification-grouping logic to MySQL.

The notification-grouping logic required to show the collapsed Notifications
toolbar - "You have 3 pending friend requests", etc - is currently done in
PHP, in a manner that requires all notifications to be loaded into memory
and processed. On sites where users have large numbers of notifications, this
operation requires extensive resources. By leaving the grouping to MySQL,
we can speed up processing in almost all situations.

This changeset also adds specific caching for grouped notifications.

Props m_uysl.
See #7130.

File:

• trunk/src/bp-notifications/classes/class-bp-notifications-notification.php (modified) (1 diff)

trunk/src/bp-notifications/classes/class-bp-notifications-notification.php

@@ -1132 +1132 @@
         return self::update( $update_args, $where_args );
     }
+
+    /**
+     * Get a user's unread notifications, grouped by component and action.
+     *
+     * Multiple notifications of the same type (those that share the same component_name
+     * and component_action) are collapsed for formatting as "You have 5 pending
+     * friendship requests", etc. See bp_notifications_get_notifications_for_user().
+     * For a full-fidelity list of user notifications, use
+     * bp_notifications_get_all_notifications_for_user().
+     *
+     * @since 3.0.0
+     *
+     * @param int $user_id ID of the user whose notifications are being fetched.
+     * @return array Notifications items for formatting into a list.
+     */
+    public static function get_grouped_notifications_for_user( $user_id ) {
+        global $wpdb;
+
+        // Load BuddyPress.
+        $bp = buddypress();
+
+        // SELECT.
+        $select_sql = "SELECT id, user_id, item_id, secondary_item_id, component_name, component_action, date_notified, is_new, COUNT(id) as total_count ";
+
+        // FROM.
+        $from_sql = "FROM {$bp->notifications->table_name} n ";
+
+        // WHERE.
+        $where_sql = self::get_where_sql( array(
+            'user_id'        => $user_id,
+            'is_new'         => 1,
+            'component_name' => bp_notifications_get_registered_components(),
+        ), $select_sql, $from_sql );
+
+        // GROUP
+        $group_sql = "GROUP BY user_id, component_name, component_action";
+
+        // SORT
+        $order_sql = "ORDER BY date_notified desc";
+
+        // Concatenate query parts.
+        $sql = "{$select_sql} {$from_sql} {$where_sql} {$group_sql} {$order_sql}";
+
+        // Return the queried results.
+        return $wpdb->get_results( $sql );
+    }
 }