<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][11383] trunk: BP_Groups_Group::get(): Add search_column parameter.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/11383">11383</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/11383","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dcavins</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-01-14 01:32:34 +0000 (Sat, 14 Jan 2017)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="http://buddypress.trac.wordpress.org/ticket/7418">#7418</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpgroupsbpgroupsfunctionsphp">trunk/src/bp-groups/bp-groups-functions.php</a></li>
<li><a href="#trunksrcbpgroupsclassesclassbpgroupsgroupphp">trunk/src/bp-groups/classes/class-bp-groups-group.php</a></li>
<li><a href="#trunksrcbpgroupsclassesclassbpgroupstemplatephp">trunk/src/bp-groups/classes/class-bp-groups-template.php</a></li>
<li><a href="#trunktestsphpunittestcasesgroupsclassbpgroupsgroupphp">trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpgroupsbpgroupsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/bp-groups-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/bp-groups-functions.php 2017-01-12 08:30:51 UTC (rev 11382)
+++ trunk/src/bp-groups/bp-groups-functions.php 2017-01-14 01:32:34 UTC (rev 11383)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -709,6 +709,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'exclude' => false, // Do not include these specific groups (group_ids).
</span><span class="cx" style="display: block; padding: 0 10px"> 'parent_id' => null, // Get groups that are children of the specified group(s).
</span><span class="cx" style="display: block; padding: 0 10px"> 'search_terms' => false, // Limit to groups that match these search terms.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'search_columns' => array(), // Select which columns to search.
</ins><span class="cx" style="display: block; padding: 0 10px"> 'group_type' => '', // Array or comma-separated list of group types to limit results to.
</span><span class="cx" style="display: block; padding: 0 10px"> 'group_type__in' => '', // Array or comma-separated list of group types to limit results to.
</span><span class="cx" style="display: block; padding: 0 10px"> 'group_type__not_in' => '', // Array or comma-separated list of group types that will be excluded from results.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -729,6 +730,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'exclude' => $r['exclude'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'parent_id' => $r['parent_id'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'search_terms' => $r['search_terms'],
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'search_columns' => $r['search_columns'],
</ins><span class="cx" style="display: block; padding: 0 10px"> 'group_type' => $r['group_type'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'group_type__in' => $r['group_type__in'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'group_type__not_in' => $r['group_type__not_in'],
</span></span></pre></div>
<a id="trunksrcbpgroupsclassesclassbpgroupsgroupphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/classes/class-bp-groups-group.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/classes/class-bp-groups-group.php 2017-01-12 08:30:51 UTC (rev 11382)
+++ trunk/src/bp-groups/classes/class-bp-groups-group.php 2017-01-14 01:32:34 UTC (rev 11383)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -882,8 +882,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Default: null (no limit).
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $user_id Optional. If provided, results will be limited to groups
</span><span class="cx" style="display: block; padding: 0 10px"> * of which the specified user is a member. Default: null.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $search_terms Optional. If provided, only groups whose names or descriptions
- * match the search terms will be returned. Default: false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type array|string $group_type Array or comma-separated list of group types to limit results to.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array|string $group_type__in Array or comma-separated list of group types to limit results to.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array|string $group_type__not_in Array or comma-separated list of group types that will be
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -939,6 +945,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'page' => null,
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_id' => 0,
</span><span class="cx" style="display: block; padding: 0 10px"> 'search_terms' => false,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'search_columns' => array(),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'group_type' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'group_type__in' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'group_type__not_in' => '',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -973,11 +980,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $where_conditions['hidden'] = "g.status != 'hidden'";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 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 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $search = '';
+ if ( isset( $r['search_terms'] ) ) {
+ $search = trim( $r['search_terms'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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) . ')';
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $meta_query_sql = self::get_meta_query_sql( $r['meta_query'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $meta_query_sql['join'] ) ) {
</span></span></pre></div>
<a id="trunksrcbpgroupsclassesclassbpgroupstemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/classes/class-bp-groups-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/classes/class-bp-groups-template.php 2017-01-12 08:30:51 UTC (rev 11382)
+++ trunk/src/bp-groups/classes/class-bp-groups-template.php 2017-01-14 01:32:34 UTC (rev 11383)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -166,6 +166,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'exclude' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'parent_id' => null,
</span><span class="cx" style="display: block; padding: 0 10px"> 'search_terms' => '',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'search_columns' => array(),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'group_type' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'group_type__in' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'group_type__not_in' => '',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -217,6 +218,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'page' => $this->pag_page,
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_id' => $user_id,
</span><span class="cx" style="display: block; padding: 0 10px"> 'search_terms' => $search_terms,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'search_columns' => $search_columns,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'meta_query' => $meta_query,
</span><span class="cx" style="display: block; padding: 0 10px"> 'group_type' => $group_type,
</span><span class="cx" style="display: block; padding: 0 10px"> 'group_type__in' => $group_type__in,
</span></span></pre></div>
<a id="trunktestsphpunittestcasesgroupsclassbpgroupsgroupphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php 2017-01-12 08:30:51 UTC (rev 11382)
+++ trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php 2017-01-14 01:32:34 UTC (rev 11383)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -306,6 +306,149 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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 );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * BP 1.8 will change the default 'type' param in favor of default
</span><span class="cx" style="display: block; padding: 0 10px"> * 'order' and 'orderby'. This is to make sure that existing plugins
</span><span class="cx" style="display: block; padding: 0 10px"> * will work appropriately
</span></span></pre>
</div>
</div>
</body>
</html>