Changeset 7948 for trunk/bp-groups/bp-groups-classes.php

Timestamp:

02/21/2014 01:50:30 PM (11 years ago)

Author:

boonebgorges

Message:

Introduce support for a 'type' sorting parameter in BP_Group_Member_Query

The 'type' parameter supports any of the arguments ('newest', 'active', etc)
supported by the parent class BP_User_Query. In addition, it's possible to
sort by type 'last_joined' and 'first_joined'.

This changeset also introduces the 'type' parameter through the
bp_group_has_members() function stack.

See #921

Props imath, boonebgorges

File:

• trunk/bp-groups/bp-groups-classes.php (modified) (6 diffs)

trunk/bp-groups/bp-groups-classes.php

@@ -1437 +1437 @@
     public function setup_hooks() {
         // Take this early opportunity to set the default 'type' param
-        // to 'last_modified', which will ensure that BP_User_Query
+        // to 'last_joined', which will ensure that BP_User_Query
         // trusts our order and does not try to apply its own
         if ( empty( $this->query_vars_raw['type'] ) ) {
-            $this->query_vars_raw['type'] = 'last_modified';
+            $this->query_vars_raw['type'] = 'last_joined';
         }
 
@@ -1472 +1472 @@
             'group_role'   => array( 'member' ),
             'is_confirmed' => true,
+            'type'         => 'last_joined',
         ) );
 
@@ -1509 +1510 @@
             'orderby' => '',
             'order'   => '',
-            'limit'   => '',
         );
 
@@ -1572 +1572 @@
         $sql['where'] = ! empty( $sql['where'] ) ? 'WHERE ' . implode( ' AND ', $sql['where'] ) : '';
 
-        /** ORDER BY clause ***************************************************/
-
-        // @todo For now, mimicking legacy behavior of
-        // bp_group_has_members(), which has us order by date_modified
-        // only. Should abstract it in the future
+        // We fetch group members in order of last_joined, regardless
+        // of 'type'. If the 'type' value is not 'last_joined' or
+        // 'first_joined', the order will be overridden in
+        // BP_Group_Member_Query::set_orderby()
         $sql['orderby'] = "ORDER BY date_modified";
-        $sql['order']   = "DESC";
-
-        /** LIMIT clause ******************************************************/
-        $this->group_member_ids = $wpdb->get_col( "{$sql['select']} {$sql['where']} {$sql['orderby']} {$sql['order']} {$sql['limit']}" );
+        $sql['order']   = 'first_joined' === $this->query_vars['type'] ? 'ASC' : 'DESC';
+
+        $this->group_member_ids = $wpdb->get_col( "{$sql['select']} {$sql['where']} {$sql['orderby']} {$sql['order']}" );
+
+        /**
+         * Use this filter to build a custom query (such as when you've
+         * defined a custom 'type').
+         */
+        $this->group_member_ids = apply_filters( 'bp_group_member_query_group_member_ids', $this->group_member_ids, $this );
 
         return $this->group_member_ids;
@@ -1589 +1593 @@
      * 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().
+     * We only override BP_User_Query's native ordering in case of the
+     * 'last_joined' and 'first_joined' $type parameters.
      *
      * @param BP_User_Query $query BP_User_Query object.
@@ -1600 +1604 @@
         }
 
-        // 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 . ")";
+        // For 'last_joined' and 'first_joined' types, we force
+        // the order according to the query performed in
+        // BP_Group_Member_Query::get_group_members(). Otherwise, fall
+        // through and let BP_User_Query do its own ordering.
+        if ( in_array( $query->query_vars['type'], array( 'last_joined', 'first_joined' ) ) ) {
+
+            // 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