Changeset 11123

Timestamp:

09/20/2016 02:42:10 PM (9 years ago)

Author:

dcavins

Message:

Introduce BP_Friends_Friendships::get_friendships().

Introduce a new function, BP_Friends_Friendships::get_friendships(),
for fetching and filtering friendships for a
specific user. Also add a new cache group,
bp_friends_friendships_for_user that
get_friendships() interacts with.

This is the second step in moving toward a
split cache approach for friendships.

Props dcavins, boonebgorges.

See #6978.

Location:

trunk/src/bp-friends

Files:

• bp-friends-cache.php (modified) (2 diffs)
• classes/class-bp-friends-component.php (modified) (1 diff)
• classes/class-bp-friends-friendship.php (modified) (2 diffs)

trunk/src/bp-friends/bp-friends-cache.php

@@ -46 +46 @@
  */
 function bp_friends_clear_bp_friends_friendships_cache( $friendship_id, $initiator_user_id, $friend_user_id ) {
+    // Clear friendship ID cache for each user.
+    wp_cache_delete( $initiator_user_id, 'bp_friends_friendships_for_user' );
+    wp_cache_delete( $friend_user_id,    'bp_friends_friendships_for_user' );
+
     // Clear the friendship object cache.
     wp_cache_delete( $friendship_id, 'bp_friends_friendships' );
@@ -62 +66 @@
  */
 function bp_friends_clear_bp_friends_friendships_cache_remove( $friendship_id, BP_Friends_Friendship $friendship ) {
+    // Clear friendship ID cache for each user.
+    wp_cache_delete( $friendship->initiator_user_id, 'bp_friends_friendships_for_user' );
+    wp_cache_delete( $friendship->friend_user_id,    'bp_friends_friendships_for_user' );
+
     // Clear the friendship object cache.
     wp_cache_delete( $friendship_id, 'bp_friends_friendships' );

trunk/src/bp-friends/classes/class-bp-friends-component.php

@@ -291 +291 @@
             'bp_friends_requests',
             'bp_friends_friendships', // Individual friendship objects are cached here by ID.
+            'bp_friends_friendships_for_user' // All friendship IDs for a single user.
         ) );
 

trunk/src/bp-friends/classes/class-bp-friends-friendship.php

@@ -219 +219 @@
 
     /** Static Methods ********************************************************/
+
+    /**
+     * Get the friendships for a given user.
+     *
+     * @since 2.6.0
+     *
+     * @param int   $user_id              ID of the user whose friends are being retrieved.
+     * @param array $args {
+     *        Optional. Filter parameters.
+     *        @type int    $id                ID of specific friendship to retrieve.
+     *        @type int    $initiator_user_id ID of friendship initiator.
+     *        @type int    $friend_user_id    ID of specific friendship to retrieve.
+     *        @type int    $is_confirmed      Whether the friendship has been accepted.
+     *        @type int    $is_limited        Whether the friendship is limited.
+     *        @type string $order_by          Column name to order by.
+     *        @type string $sort_order        ASC or DESC. Default DESC.
+     * }
+     * @param string $operator            Optional. Operator to use in `wp_list_filter()`.
+     *
+     * @return array $friendships Array of friendship objects.
+     */
+    public static function get_friendships( $user_id, $args = array(), $operator = 'AND' ) {
+
+        if ( empty( $user_id ) ) {
+            $user_id = bp_loggedin_user_id();
+        }
+
+        $r = bp_parse_args( $args, array(
+            'id'                => null,
+            'initiator_user_id' => null,
+            'friend_user_id'    => null,
+            'is_confirmed'      => null,
+            'is_limited'        => null,
+            'order_by'          => 'date_created',
+            'sort_order'        => 'DESC',
+            'page'              => null,
+            'per_page'          => null
+        ), 'bp_get_user_friendships' );
+
+        // First, we get all friendships that involve the user.
+        $friendship_ids = wp_cache_get( $user_id, 'bp_friends_friendships_for_user' );
+        if ( false === $friendship_ids ) {
+            $friendship_ids = self::get_friendship_ids_for_user( $user_id );
+            wp_cache_set( $user_id, $friendship_ids, 'bp_friends_friendships_for_user' );
+        }
+
+        // Prime the membership cache.
+        $uncached_friendship_ids = bp_get_non_cached_ids( $friendship_ids, 'bp_friends_friendships' );
+        if ( ! empty( $uncached_friendship_ids ) ) {
+            $uncached_friendships = self::get_friendships_by_id( $uncached_friendship_ids );
+
+            foreach ( $uncached_friendships as $uncached_friendship ) {
+                wp_cache_set( $uncached_friendship->id, $uncached_friendship, 'bp_friends_friendships' );
+            }
+        }
+
+        // Assemble filter array.
+        $filters = wp_array_slice_assoc( $r, array( 'id', 'initiator_user_id', 'friend_user_id', 'is_confirmed', 'is_limited' ) );
+        foreach ( $filters as $filter_name => $filter_value ) {
+            if ( is_null( $filter_value ) ) {
+                unset( $filters[ $filter_name ] );
+            }
+        }
+
+        // Populate friendship array from cache, and normalize.
+        $friendships = array();
+        $int_keys    = array( 'id', 'initiator_user_id', 'friend_user_id' );
+        $bool_keys   = array( 'is_confirmed', 'is_limited' );
+        foreach ( $friendship_ids as $friendship_id ) {
+            // Create a limited BP_Friends_Friendship object (don't fetch the user details).
+            $friendship = new BP_Friends_Friendship( $friendship_id, false, false );
+
+            // Sanity check.
+            if ( ! isset( $friendship->id ) ) {
+                continue;
+            }
+
+            // Integer values.
+            foreach ( $int_keys as $index ) {
+                $friendship->{$index} = intval( $friendship->{$index} );
+            }
+
+            // Boolean values.
+            foreach ( $bool_keys as $index ) {
+                $friendship->{$index} = (bool) $friendship->{$index};
+            }
+
+            // We need to support the same operators as wp_list_filter().
+            if ( 'OR' == $operator || 'NOT' == $operator ) {
+                $matched = 0;
+
+                foreach ( $filters as $filter_name => $filter_value ) {
+                    if ( isset( $friendship->{$filter_name} ) && $filter_value == $friendship->{$filter_name} ) {
+                        $matched++;
+                    }
+                }
+
+                if ( ( 'OR' == $operator && $matched > 0 )
+                  || ( 'NOT' == $operator && 0 == $matched ) ) {
+                    $friendships[ $friendship->id ] = $friendship;
+                }
+
+            } else {
+                /*
+                 * This is the more typical 'AND' style of filter.
+                 * If any of the filters miss, we move on.
+                 */
+                foreach ( $filters as $filter_name => $filter_value ) {
+                    if ( ! isset( $friendship->{$filter_name} ) || $filter_value != $friendship->{$filter_name} ) {
+                        continue 2;
+                    }
+                }
+                $friendships[ $friendship->id ] = $friendship;
+            }
+
+        }
+
+        // Sort the results on a column name.
+        if ( in_array( $r['order_by'], array( 'id', 'initiator_user_id', 'friend_user_id' ) ) ) {
+            $friendships = bp_sort_by_key( $friendships, $r['order_by'], 'num', true );
+        }
+
+        // Adjust the sort direction of the results.
+        if ( 'ASC' === strtoupper( $r['sort_order'] ) ) {
+            // `true` to preserve keys.
+            $friendships = array_reverse( $friendships, true );
+        }
+
+        // Paginate the results.
+        if ( $r['per_page'] && $r['page'] ) {
+            $start       = ( $r['page'] - 1 ) * ( $r['per_page'] );
+            $friendships = array_slice( $friendships, $start, $r['per_page'] );
+        }
+
+        return $friendships;
+    }
+
+    /**
+     * Get all friendship IDs for a user.
+     *
+     * @since 2.7.0
+     *
+     * @param int $user_id ID of the user.
+     * @return array
+     */
+    public static function get_friendship_ids_for_user( $user_id ) {
+        global $wpdb;
+
+        $bp = buddypress();
+
+        $friendship_ids = $wpdb->get_col( $wpdb->prepare( "SELECT id FROM {$bp->friends->table_name} WHERE (initiator_user_id = %d OR friend_user_id = %d) ORDER BY date_created DESC", $user_id, $user_id ) );
+
+        return $friendship_ids;
+    }
 
     /**
@@ -714 +868 @@
 
     /**
+     * Get friendship objects by ID (or an array of IDs).
+     *
+     * @since 2.7.0
+     *
+     * @param int|string|array $friendship_ids Single friendship ID or comma-separated/array list of friendship IDs.
+     * @return array
+     */
+    public static function get_friendships_by_id( $friendship_ids ) {
+        global $wpdb;
+
+        $bp = buddypress();
+
+        $friendship_ids = implode( ',', wp_parse_id_list( $friendship_ids ) );
+        return $wpdb->get_results( "SELECT * FROM {$bp->friends->table_name} WHERE id IN ({$friendship_ids})" );
+    }
+
+    /**
      * Get the friend user IDs for a given friendship.
      *