Changeset 11533

Timestamp:

04/20/2017 12:56:53 AM (7 years ago)

Author:

dcavins

Message:

Add 'meta_id' orderby option to BP_Groups_Group::get().

Add meta_id orderby option to groups_get_groups() and its
underlying function BP_Groups_Group::get(). When searching for groups
by meta value, the found groups may now be ordered by the order in
which the found meta rows appear in the bp_groups_groupmeta table.

See #6014.

Location:

trunk

Files:

• src/bp-groups/bp-groups-functions.php (modified) (1 diff)
• src/bp-groups/classes/class-bp-groups-group.php (modified) (4 diffs)
• tests/phpunit/testcases/groups/class-bp-groups-group.php (modified) (1 diff)

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

@@ -705 +705 @@
         'type'               => false,          // Active, newest, alphabetical, random, popular, most-forum-topics or most-forum-posts.
         'order'              => 'DESC',         // 'ASC' or 'DESC'
-        'orderby'            => 'date_created', // date_created, last_activity, total_member_count, name, random.
+        'orderby'            => 'date_created', // date_created, last_activity, total_member_count, name, random, meta_id.
         'user_id'            => false,          // Pass a user_id to limit to only groups that this user is a member of.
         'include'            => false,          // Only include these specific groups (group_ids).

trunk/src/bp-groups/classes/class-bp-groups-group.php

@@ -884 +884 @@
      *                                            Default: null.
      *     @type string       $orderby            Optional. Property to sort by. 'date_created', 'last_activity',
-     *                                            'total_member_count', 'name', 'random'. Default: 'date_created'.
+     *                                            'total_member_count', 'name', 'random', 'meta_id'.
+     *                                            Default: 'date_created'.
      *     @type string       $order              Optional. Sort order. 'ASC' or 'DESC'. Default: 'DESC'.
      *     @type int          $per_page           Optional. Number of items to return per page of results.
@@ -994 +995 @@
         $where_conditions = array();
 
-
         if ( ! empty( $r['status'] ) ) {
             if ( ! is_array( $r['status'] ) ) {
@@ -1139 +1139 @@
             $sql['from'] .= " JOIN {$bp->groups->table_name_groupmeta} gm_last_activity on ( g.id = gm_last_activity.group_id )";
             $where_conditions['last_activity'] = "gm_last_activity.meta_key = 'last_activity'";
+        }
+
+        // If 'meta_id' is the requested order, and there's no meta query, fall back to the default.
+        if ( 'meta_id' === $orderby && empty( $meta_query_sql['join'] ) ) {
+            $orderby = 'date_created';
         }
 
@@ -1443 +1448 @@
                 $order_by_term = 'rand()';
                 break;
+
+            case 'meta_id' :
+                $order_by_term = buddypress()->groups->table_name_groupmeta . '.id';
+                break;
         }
 

trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php

@@ -957 +957 @@
     }
 
+    /**
+     * @group groups_get_orderby_meta_id
+     */
+    public function test_get_orderby_meta_id() {
+        $g1 = $this->factory->group->create();
+        $g2 = $this->factory->group->create();
+        $g3 = $this->factory->group->create();
+
+        groups_update_groupmeta( $g2, 'orderup', 'sammy' );
+        groups_update_groupmeta( $g1, 'orderup', 'sammy' );
+
+        $args = array(
+            'meta_query'         => array(
+                array(
+                    'key'   => 'orderup',
+                    'value' => 'sammy'
+                ),
+            ),
+            'orderby'           => 'meta_id',
+            'order'             => 'ASC',
+        );
+        $groups = BP_Groups_Group::get( $args );
+
+        $found = wp_list_pluck( $groups['groups'], 'id' );
+        $this->assertEquals( array( $g2, $g1 ), $found );
+    }
+
+    /**
+     * @group groups_get_orderby_meta_id
+     */
+    public function test_get_orderby_meta_id_invalid_fallback_to_date_created() {
+        $time = time();
+        $g1 = $this->factory->group->create( array(
+            'date_created' => gmdate( 'Y-m-d H:i:s', $time - 10000 ),
+        ) );
+        $g2 = $this->factory->group->create( array(
+            'date_created' => gmdate( 'Y-m-d H:i:s', $time - 1000 ),
+        ) );
+        $g3 = $this->factory->group->create( array(
+            'date_created' => gmdate( 'Y-m-d H:i:s', $time - 100 ),
+        ) );
+
+        $args = array(
+            'orderby' => 'meta_id',
+        );
+        $groups = BP_Groups_Group::get( $args );
+
+        // Orderby meta_id should be ignored if no meta query is present.
+        $found = wp_list_pluck( $groups['groups'], 'id' );
+        $this->assertEquals( array( $g3, $g2, $g1 ), $found );
+    }
+
     public function test_filter_user_groups_normal_search() {
         $g1 = $this->factory->group->create( array(