Changeset 8744

Timestamp:

07/31/2014 05:31:52 PM (10 years ago)

Author:

johnjamesjacoby

Message:

Introduce bp_notifications_get_all_notifications_for_user() and move duplicated caching code into it.

This enables manipulating of notifications in other ways outside of the grouping performed for the adminbar.

File:

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

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

@@ -129 +129 @@
 
 /**
- * Get notifications for a specific user.
- *
- * @since BuddyPress (1.9.0)
- *
- * @param int $user_id ID of the user whose notification are being fetched.
- * @param string $format Format of the returned values. 'string' returns HTML,
- *        while 'object' returns a structured object for parsing.
- * @return mixed Object or array on success, false on failure.
- */
-function bp_notifications_get_notifications_for_user( $user_id, $format = 'string' ) {
-
-    // Setup local variables
-    $bp = buddypress();
+ * Get all notifications for a user and cache them
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param int $user_id 
+ * @return array
+ */
+function bp_notifications_get_all_notifications_for_user( $user_id = 0 ) {
+
+    // Default to displayed user if no ID is passed
+    if ( empty( $user_id ) ) {
+        $user_id = ( bp_displayed_user_id() ) ? bp_displayed_user_id() : bp_loggedin_user_id();
+    }
 
     // Get notifications out of the cache, or query if necessary
@@ -152 +152 @@
     }
 
+    // Filter and return
+    return apply_filters( 'bp_notifications_get_all_notifications_for_user', $notifications, $user_id );
+}
+
+/**
+ * Get notifications for a specific user.
+ *
+ * @since BuddyPress (1.9.0)
+ *
+ * @param int $user_id ID of the user whose notification are being fetched.
+ * @param string $format Format of the returned values. 'string' returns HTML,
+ *        while 'object' returns a structured object for parsing.
+ * @return mixed Object or array on success, false on failure.
+ */
+function bp_notifications_get_notifications_for_user( $user_id, $format = 'string' ) {
+
+    // Setup local variables
+    $bp = buddypress();
+
+    // Get notifications (out of the cache, or query if necessary)
+    $notifications         = bp_notifications_get_all_notifications_for_user( $user_id );
     $grouped_notifications = array(); // Notification groups
     $renderable            = array(); // Renderable notifications
@@ -519 +540 @@
  */
 function bp_notifications_get_unread_notification_count( $user_id = 0 ) {
-
-    // Default to displayed user if no ID is passed
-    if ( empty( $user_id ) ) {
-        $user_id = ( bp_displayed_user_id() ) ? bp_displayed_user_id() : bp_loggedin_user_id();
-    }
-
-    // Get the notifications, and count them
-    $notifications = wp_cache_get( 'all_for_user_' . $user_id, 'bp_notifications' );
-    if ( false === $notifications ) {
-        $notifications = BP_Notifications_Notification::get( array(
-            'user_id' => $user_id,
-        ) );
-        wp_cache_set( 'all_for_user_' . $user_id, $notifications, 'bp_notifications' );
-    }
-
-    $count = ! empty( $notifications ) ? count( $notifications ) : 0;
-
-    return apply_filters( 'bp_notifications_get_total_notification_count', $count );
+    $notifications = bp_notifications_get_all_notifications_for_user( $user_id );
+    $count         = ! empty( $notifications ) ? count( $notifications ) : 0;
+
+    return apply_filters( 'bp_notifications_get_total_notification_count', (int) $count );
 }