Changeset 11383

Timestamp:

01/14/2017 01:32:34 AM (8 years ago)

Author:

dcavins

Message:

BP_Groups_Group::get(): Add search_column parameter.

Allow developers to specify which column should be searched and where
wildcard characters should be placed in BP_Groups_Group::get().

Fixes #7418.

Location:

trunk

Files:

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

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

@@ -710 +710 @@
         'parent_id'          => null,           // Get groups that are children of the specified group(s).
         'search_terms'       => false,          // Limit to groups that match these search terms.
+        'search_columns'     => array(),        // Select which columns to search.
         'group_type'         => '',             // Array or comma-separated list of group types to limit results to.
         'group_type__in'     => '',             // Array or comma-separated list of group types to limit results to.
@@ -730 +731 @@
         'parent_id'          => $r['parent_id'],
         'search_terms'       => $r['search_terms'],
+        'search_columns'     => $r['search_columns'],
         'group_type'         => $r['group_type'],
         'group_type__in'     => $r['group_type__in'],

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

@@ -883 +883 @@
      *     @type int          $user_id            Optional. If provided, results will be limited to groups
      *                                            of which the specified user is a member. Default: null.
-     *     @type string       $search_terms       Optional. If provided, only groups whose names or descriptions
-     *                                            match the search terms will be returned. Default: false.
+     *     @type string       $search_terms       Optional. If provided, only groups whose names or descriptions
+     *                                            match the search terms will be returned. Allows specifying the
+     *                                            wildcard position using a '*' character before or after the
+     *                                            string or both. Works in concert with $search_columns.
+     *                                            Default: false.
+     *     @type string       $search_columns     Optional. If provided, only apply the search terms to the
+     *                                            specified columns. Works in concert with $search_terms.
+     *                                            Default: empty array.
      *     @type array|string $group_type         Array or comma-separated list of group types to limit results to.
      *     @type array|string $group_type__in     Array or comma-separated list of group types to limit results to.
@@ -940 +946 @@
             'user_id'            => 0,
             'search_terms'       => false,
+            'search_columns'     => array(),
             'group_type'         => '',
             'group_type__in'     => '',
@@ -974 +981 @@
         }
 
-        if ( ! empty( $r['search_terms'] ) ) {
-            $search_terms_like = '%' . bp_esc_like( $r['search_terms'] ) . '%';
-            $where_conditions['search'] = $wpdb->prepare( "( g.name LIKE %s OR g.description LIKE %s )", $search_terms_like, $search_terms_like );
+        $search = '';
+        if ( isset( $r['search_terms'] ) ) {
+            $search = trim( $r['search_terms'] );
+        }
+
+        if ( $search ) {
+            $leading_wild = ( ltrim( $search, '*' ) != $search );
+            $trailing_wild = ( rtrim( $search, '*' ) != $search );
+            if ( $leading_wild && $trailing_wild ) {
+                $wild = 'both';
+            } elseif ( $leading_wild ) {
+                $wild = 'leading';
+            } elseif ( $trailing_wild ) {
+                $wild = 'trailing';
+            } else {
+                // Default is to wrap in wildcard characters.
+                $wild = 'both';
+            }
+            $search = trim( $search, '*' );
+
+            $searches = array();
+            $leading_wild = ( 'leading' == $wild || 'both' == $wild ) ? '%' : '';
+            $trailing_wild = ( 'trailing' == $wild || 'both' == $wild ) ? '%' : '';
+            $wildcarded = $leading_wild . bp_esc_like( $search ) . $trailing_wild;
+
+            $search_columns = array( 'name', 'description' );
+            if ( $r['search_columns'] ) {
+                $search_columns = array_intersect( $r['search_columns'], $search_columns );
+            }
+
+            foreach ( $search_columns as $search_column ) {
+                $searches[] = $wpdb->prepare( "$search_column LIKE %s", $wildcarded );
+            }
+
+            $where_conditions['search'] = '(' . implode(' OR ', $searches) . ')';
         }
 

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

@@ -167 +167 @@
             'parent_id'          => null,
             'search_terms'       => '',
+            'search_columns'     => array(),
             'group_type'         => '',
             'group_type__in'     => '',
@@ -218 +219 @@
                 'user_id'            => $user_id,
                 'search_terms'       => $search_terms,
+                'search_columns'     => $search_columns,
                 'meta_query'         => $meta_query,
                 'group_type'         => $group_type,

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

@@ -307 +307 @@
 
     /**
+     * @group get
+     */
+    public function test_get_search_with_left_wildcard() {
+        $g1 = $this->factory->group->create( array(
+            'name' => 'Ye Lads',
+            'description' => "My Bonnie lies over the ocean",
+        ) );
+        $g2 = $this->factory->group->create();
+
+        $groups = BP_Groups_Group::get( array(
+            'search_terms' => "*ads",
+        ) );
+
+        $found = wp_list_pluck( $groups['groups'], 'id' );
+
+        $this->assertEquals( array( $g1 ), $found );
+    }
+
+    /**
+     * @group get
+     */
+    public function test_get_search_with_left_wildcard_should_miss() {
+        $g1 = $this->factory->group->create( array(
+            'name' => 'Ye Lads',
+            'description' => "My Bonnie lies over the ocean",
+        ) );
+        $g2 = $this->factory->group->create();
+
+        $groups = BP_Groups_Group::get( array(
+            'search_terms' => "*la",
+        ) );
+
+        $found = wp_list_pluck( $groups['groups'], 'id' );
+
+        $this->assertEquals( array(), $found );
+    }
+
+    /**
+     * @group get
+     */
+    public function test_get_search_with_right_wildcard() {
+        $g1 = $this->factory->group->create( array(
+            'name' => 'Ye Lads',
+            'description' => "My Bonnie lies over the ocean",
+        ) );
+        $g2 = $this->factory->group->create();
+
+        $groups = BP_Groups_Group::get( array(
+            'search_terms' => "Ye*",
+        ) );
+
+        $found = wp_list_pluck( $groups['groups'], 'id' );
+
+        $this->assertEquals( array( $g1 ), $found );
+    }
+
+    /**
+     * @group get
+     */
+    public function test_get_search_with_right_wildcard_should_miss() {
+        $g1 = $this->factory->group->create( array(
+            'name' => 'Ye Lads',
+            'description' => "My Bonnie lies over the ocean",
+        ) );
+        $g2 = $this->factory->group->create();
+
+        $groups = BP_Groups_Group::get( array(
+            'search_terms' => "la*",
+        ) );
+
+        $found = wp_list_pluck( $groups['groups'], 'id' );
+
+        $this->assertEquals( array(), $found );
+    }
+
+    /**
+     * @group get
+     */
+    public function test_get_search_with_both_wildcard() {
+        $g1 = $this->factory->group->create( array(
+            'name' => 'Ye Lads',
+            'description' => "My Bonnie lies over the ocean",
+        ) );
+        $g2 = $this->factory->group->create();
+
+        $groups = BP_Groups_Group::get( array(
+            'search_terms' => "*la*",
+        ) );
+
+        $found = wp_list_pluck( $groups['groups'], 'id' );
+
+        $this->assertEquals( array( $g1 ), $found );
+    }
+
+    /**
+     * @group get
+     */
+    public function test_get_search_limited_to_name_column() {
+        $g1 = $this->factory->group->create( array(
+            'name' => 'Ye Lads',
+            'description' => "My Bonnie lies over the ocean",
+        ) );
+        $g2 = $this->factory->group->create();
+        $g3 = $this->factory->group->create( array(
+            'name' => 'Bonnie Lasses',
+            'description' => "That lad is unknown to me",
+        ) );
+
+        $groups = BP_Groups_Group::get( array(
+            'search_terms'   => "lad",
+            'search_columns' => array( 'name' ),
+        ) );
+
+        $found = wp_list_pluck( $groups['groups'], 'id' );
+
+        $this->assertEquals( array( $g1 ), $found );
+    }
+
+    /**
+     * @group get
+     */
+    public function test_get_search_limited_to_description_column() {
+        $g1 = $this->factory->group->create( array(
+            'name' => 'Ye Lads',
+            'description' => "My Bonnie lies over the ocean",
+        ) );
+        $g2 = $this->factory->group->create();
+        $g3 = $this->factory->group->create( array(
+            'name' => 'Bonnie Lasses',
+            'description' => "That lad is unknown to me",
+        ) );
+
+        $groups = BP_Groups_Group::get( array(
+            'search_terms'   => "lad",
+            'search_columns' => array( 'description' ),
+        ) );
+
+        $found = wp_list_pluck( $groups['groups'], 'id' );
+
+        $this->assertEquals( array( $g3 ), $found );
+    }
+
+    /**
      * BP 1.8 will change the default 'type' param in favor of default
      * 'order' and 'orderby'. This is to make sure that existing plugins