Changeset 7296

Timestamp:

07/23/2013 05:31:39 PM (13 years ago)

Author:

boonebgorges

Message:

Tell BP_Group_Member_Query queries to order by FIELD()

BP_Group_Member_Query works by first querying for a list of group members
that match the query params, sorted by date_modified. Then, it feeds those ids
to the BP_User_Query parent class. In order to maintain the proper
date_modified sort, we have to override BP_User_Query's ORDER BY param, and
replace it with ORDER BY FIELD(), using the user ids from the first query.

This fixes a regression in BP 1.8, where the default sort order for
bp_group_has_members() was inadvertantly changed to user_id DESC, rather than
the legacy date_modified that existed before the introduction of
BP_Group_Member_Query.

Fixes #5106

Location:

branches/1.8

Files:

• bp-groups/bp-groups-classes.php (modified) (4 diffs)
• tests/testcases/groups/template.php (modified) (1 diff)

branches/1.8/bp-groups/bp-groups-classes.php

@@ -967 +967 @@
 class BP_Group_Member_Query extends BP_User_Query {
         /**
+         * Array of group member ids, cached to prevent redundant lookups
+         *
+         * @var null|array Null if not yet defined, otherwise an array of ints
+         * @since BuddyPress (1.8.1)
+         */
+        protected $group_member_ids;
+
+        /**
          * Set up action hooks
          *
@@ -978 +986 @@
                         $this->query_vars_raw['type'] = 'last_modified';
                 }
+
+                // Set the sort order
+                add_action( 'bp_pre_user_query', array( $this, 'set_orderby' ) );
 
                 // Set up our populate_extras method
@@ -1029 +1040 @@
                 global $wpdb;
 
+                if ( is_array( $this->group_member_ids ) ) {
+                        return $this->group_member_ids;
+                }
+
                 $bp  = buddypress();
                 $sql = array(
@@ -1107 +1122 @@
 
                 /** LIMIT clause ******************************************************/
-
-                $ids = $wpdb->get_col( "{$sql['select']} {$sql['where']} {$sql['orderby']} {$sql['order']} {$sql['limit']}" );
-
-                return $ids;
+                $this->group_member_ids = $wpdb->get_col( "{$sql['select']} {$sql['where']} {$sql['orderby']} {$sql['order']} {$sql['limit']}" );
+
+                return $this->group_member_ids;
+        }
+
+        /**
+         * Tell BP_User_Query to order by the order of our query results
+         *
+         * This implementation assumes the 'last_modified' sort order
+         * hardcoded in BP_Group_Member_Query::get_group_member_ids().
+         *
+         * @param object $query BP_User_Query object
+         */
+        public function set_orderby( $query ) {
+                $gm_ids = $this->get_group_member_ids();
+                if ( empty( $gm_ids ) ) {
+                        $gm_ids = array( 0 );
+                }
+
+                // The first param in the FIELD() clause is the sort column id
+                $gm_ids = array_merge( array( 'u.id' ), wp_parse_id_list( $gm_ids ) );
+                $gm_ids_sql = implode( ',', $gm_ids );
+
+                $query->uid_clauses['orderby'] = "ORDER BY FIELD(" . $gm_ids_sql . ")";
+
+                // Prevent this filter from running on future BP_User_Query
+                // instances on the same page
+                remove_action( 'bp_pre_user_query', array( $this, 'set_orderby' ) );
         }
 

branches/1.8/tests/testcases/groups/template.php

@@ -352 +352 @@
         }
 
+        /**
+         * Default sort order should be the joined date
+         *
+         * @tickett BP5106
+         * @group bp_group_has_members
+         */
+        public function test_bp_group_has_members_default_order() {
+                $u1 = $this->create_user( array(
+                        'last_activity' => gmdate( 'Y-m-d H:i:s', time() - 60 ),
+                ) );
+                $u2 = $this->create_user( array(
+                        'last_activity' => gmdate( 'Y-m-d H:i:s', time() - 600 ),
+                ) );
+                $u3 = $this->create_user( array(
+                        'last_activity' => gmdate( 'Y-m-d H:i:s', time() - 6000 ),
+                ) );
+
+
+                $g = $this->factory->group->create( array(
+                        'creator_id' => $u1,
+                ) );
+
+                $this->add_user_to_group( $u2, $g, array(
+                        'date_modified' => gmdate( 'Y-m-d H:i:s', time() - 60*60*24 ),
+                ) );
+
+                $this->add_user_to_group( $u3, $g, array(
+                        'date_modified' => gmdate( 'Y-m-d H:i:s', time() - 60*60*12 ),
+                ) );
+
+                global $members_template;
+                bp_group_has_members( array(
+                        'group_id' => $g,
+                        'exclude_banned' => 0,
+                        'exclude_admins_mods' => false,
+                ) );
+
+                $ids = wp_parse_id_list( wp_list_pluck( $members_template->members, 'user_id' ) );
+                $this->assertEquals( array( $u1, $u3, $u2, ), $ids );
+        }
 }