Changeset 7948

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

Location:

trunk

Files:

• bp-groups/bp-groups-classes.php (modified) (6 diffs)
• bp-groups/bp-groups-functions.php (modified) (3 diffs)
• bp-groups/bp-groups-template.php (modified) (3 diffs)
• tests/testcases/groups/class-bp-group-member-query.php (modified) (1 diff)

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

trunk/bp-groups/bp-groups-functions.php

@@ -385 +385 @@
  *           Default: 1.
  *     @type array $group_role Optional. Array of group roles to include.
+ *     @type string $search_terms Optional. Filter results by a search string.
+ *     @type string $type Optional. Sort the order of results. 'last_joined',
+ *           'first_joined', or any of the $type params available in
+ *           {@link BP_User_Query}. Default: 'last_joined'.
  * }
- * @param int $group_id
- * @param int $limit Maximum members to return
- * @param int $page The page of results to return (requires $limit)
- * @param bool $exclude_admins_mods Whether to exclude admins and mods
- * @param bool $exclude_banned Whether to exclude banned users
- * @param array|string $exclude Array or comma-sep list of users to exclude
- * @return array Multi-d array of 'members' list and 'count'
+ * @return array Multi-d array of 'members' list and 'count'.
  */
 function groups_get_group_members( $args = array() ) {
@@ -423 +421 @@
         'group_role'          => array(),
         'search_terms'        => false,
+        'type'                => 'last_joined',
     ) );
 
@@ -456 +455 @@
             'exclude'        => $r['exclude'],
             'search_terms'   => $r['search_terms'],
-            'type'           => 'last_modified',
+            'type'           => $r['type'],
         ) );
 

trunk/bp-groups/bp-groups-template.php

@@ -2020 +2020 @@
             'group_role'          => false,
             'search_terms'        => false,
+            'type'                => 'last_joined',
         ) );
 
@@ -2123 +2124 @@
  *           Default: 1.
  *     @type array $group_role Optional. Array of group roles to include.
+ *     @type string $type Optional. Sort order of results. 'last_joined',
+ *           'first_joined', or any of the $type params available in
+ *           {@link BP_User_Query}. Default: 'last_joined'.
  *     @type string $search_terms Optional. Search terms to match.
  * }
@@ -2139 +2143 @@
         'group_role'          => false,
         'search_terms'        => false,
+        'type'                => 'last_joined',
     ) );
 

trunk/tests/testcases/groups/class-bp-group-member-query.php

@@ -335 +335 @@
     }
 
+    /**
+     * @group type
+     */
+    public function test_get_with_type_last_joined() {
+        $g = $this->factory->group->create();
+        $u1 = $this->create_user();
+        $u2 = $this->create_user();
+        $time = time();
+
+        $this->add_user_to_group( $u1, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 500 ),
+        ) );
+
+        $this->add_user_to_group( $u2, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+        ) );
+
+        $query_members = new BP_Group_Member_Query( array(
+            'group_id' => $g,
+            'type' => 'last_joined',
+        ) );
+
+        $ids = wp_parse_id_list( array_keys( $query_members->results ) );
+        $this->assertEquals( array( $u2, $u1 ), $ids );
+    }
+
+    /**
+     * @group type
+     */
+    public function test_get_with_type_first_joined() {
+        $g = $this->factory->group->create();
+        $u1 = $this->create_user();
+        $u2 = $this->create_user();
+        $time = time();
+
+        $this->add_user_to_group( $u1, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 500 ),
+        ) );
+
+        $this->add_user_to_group( $u2, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+        ) );
+
+        $query_members = new BP_Group_Member_Query( array(
+            'group_id' => $g,
+            'type' => 'first_joined',
+        ) );
+
+        $ids = wp_parse_id_list( array_keys( $query_members->results ) );
+        $this->assertEquals( array( $u1, $u2 ), $ids );
+    }
+
+    /**
+     * @group type
+     */
+    public function test_get_with_type_alphabetical() {
+        $g = $this->factory->group->create();
+        $u1 = $this->create_user( array(
+            'display_name' => 'AAA',
+        ) );
+        $u2 = $this->create_user( array(
+            'display_name' => 'CCC',
+        ) );
+        $u3 = $this->create_user( array(
+            'display_name' => 'BBB',
+        ) );
+        $time = time();
+
+        $this->add_user_to_group( $u1, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+        ) );
+
+        $this->add_user_to_group( $u2, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 200 ),
+        ) );
+
+        $this->add_user_to_group( $u3, $g, array(
+            'date_modified' => gmdate( 'Y-m-d H:i:s', $time - 300 ),
+        ) );
+
+        $query_members = new BP_Group_Member_Query( array(
+            'group_id' => $g,
+            'type' => 'alphabetical',
+        ) );
+
+        $ids = wp_parse_id_list( array_keys( $query_members->results ) );
+        $this->assertEquals( array( $u1, $u3, $u2 ), $ids );
+    }
 }