<!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][7808] trunk: Refactor BP_XProfile_ProfileData::get_all_for_user() for performance</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">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/7808">7808</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-02-06 02:23:51 +0000 (Thu, 06 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Refactor BP_XProfile_ProfileData::get_all_for_user() for performance
Method has been refactored to avoid joins, especially against global tables.
Direct SQL queries have been removed in favor of using existing query methods,
which has the added benefit of allowing existing caching strategies to be
inherited automatically from those methods.
Adds unit tests for the method.
See <a href="http://buddypress.trac.wordpress.org/ticket/1332">#1332</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpxprofilebpxprofileclassesphp">trunk/bp-xprofile/bp-xprofile-classes.php</a></li>
<li><a href="#trunkteststestcasesxprofileclassbpxprofileprofiledataphp">trunk/tests/testcases/xprofile/class-bp-xprofile-profiledata.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpxprofilebpxprofileclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-xprofile/bp-xprofile-classes.php (7807 => 7808)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-xprofile/bp-xprofile-classes.php 2014-02-06 02:23:45 UTC (rev 7807)
+++ trunk/bp-xprofile/bp-xprofile-classes.php 2014-02-06 02:23:51 UTC (rev 7808)
</span><span class="lines">@@ -1278,29 +1278,45 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * BP_XProfile_ProfileData::get_all_for_user()
</del><ins>+ * Get all of the profile information for a specific user.
</ins><span class="cx"> *
</span><del>- * Get all of the profile information for a specific user.
</del><ins>+ * @param int $user_id ID of the user.
+ * @return array
</ins><span class="cx"> */
</span><span class="cx"> public static function get_all_for_user( $user_id ) {
</span><span class="cx"> global $wpdb, $bp;
</span><span class="cx">
</span><del>- $results = $wpdb->get_results( $wpdb->prepare( "SELECT g.id as field_group_id, g.name as field_group_name, f.id as field_id, f.name as field_name, f.type as field_type, d.value as field_data, u.user_login, u.user_nicename, u.user_email FROM {$bp->profile->table_name_groups} g LEFT JOIN {$bp->profile->table_name_fields} f ON g.id = f.group_id INNER JOIN {$bp->profile->table_name_data} d ON f.id = d.field_id LEFT JOIN {$wpdb->users} u ON d.user_id = u.ID WHERE d.user_id = %d AND d.value != ''", $user_id ) );
</del><ins>+ $groups = BP_XProfile_Group::get( array(
+ 'user_id' => $user_id,
+ 'hide_empty_groups' => true,
+ 'hide_empty_fields' => true,
+ 'fetch_fields' => true,
+ 'fetch_field_data' => true,
+ ) );
+
</ins><span class="cx"> $profile_data = array();
</span><span class="cx">
</span><del>- if ( !empty( $results ) ) {
- $profile_data['user_login'] = $results[0]->user_login;
- $profile_data['user_nicename'] = $results[0]->user_nicename;
- $profile_data['user_email'] = $results[0]->user_email;
</del><ins>+ if ( ! empty( $groups ) ) {
+ $user = new WP_User( $user_id );
</ins><span class="cx">
</span><del>- foreach( (array) $results as $field ) {
- $profile_data[$field->field_name] = array(
- 'field_group_id' => $field->field_group_id,
- 'field_group_name' => $field->field_group_name,
- 'field_id' => $field->field_id,
- 'field_type' => $field->field_type,
- 'field_data' => $field->field_data
- );
</del><ins>+ $profile_data['user_login'] = $user->user_login;
+ $profile_data['user_nicename'] = $user->user_nicename;
+ $profile_data['user_email'] = $user->user_email;
+
+ foreach ( (array) $groups as $group ) {
+ if ( empty( $group->fields ) ) {
+ continue;
+ }
+
+ foreach ( (array) $group->fields as $field ) {
+ $profile_data[ $field->name ] = array(
+ 'field_group_id' => $group->id,
+ 'field_group_name' => $group->name,
+ 'field_id' => $field->id,
+ 'field_type' => $field->type,
+ 'field_data' => $field->data->value,
+ );
+ }
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre></div>
<a id="trunkteststestcasesxprofileclassbpxprofileprofiledataphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/xprofile/class-bp-xprofile-profiledata.php (7807 => 7808)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/xprofile/class-bp-xprofile-profiledata.php 2014-02-06 02:23:45 UTC (rev 7807)
+++ trunk/tests/testcases/xprofile/class-bp-xprofile-profiledata.php 2014-02-06 02:23:51 UTC (rev 7808)
</span><span class="lines">@@ -263,4 +263,147 @@
</span><span class="cx"> $this->assertEquals( $expected, BP_XProfile_ProfileData::get_value_byid( $f->id, array( $u1, $u2 ) ) );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * @group get_all_for_user
+ */
+ public function test_get_all_for_user_uncached() {
+ $u = $this->create_user();
+ $g1 = $this->factory->xprofile_group->create();
+ $g2 = $this->factory->xprofile_group->create();
+ $f1 = $this->factory->xprofile_field->create( array(
+ 'type' => 'textbox',
+ 'field_group_id' => $g1->id,
+ ) );
+ $f2 = $this->factory->xprofile_field->create( array(
+ 'type' => 'radio',
+ 'field_group_id' => $g2->id,
+ ) );
+
+ $time = bp_core_current_time();
+
+ // Get the fullname field - hackish
+ $f0_id = xprofile_get_field_id_from_name( bp_xprofile_fullname_field_name() );
+ $f0 = new BP_XProfile_Field( $f0_id );
+ $g0 = new BP_XProfile_Group( $f0->group_id );
+ $d0 = new BP_XProfile_ProfileData( $f0->id, $u );
+
+ $d1 = new BP_XProfile_ProfileData();
+ $d1->user_id = $u;
+ $d1->field_id = $f1->id;
+ $d1->value = 'foo';
+ $d1->last_updated = $time;
+ $d1->save();
+
+ $d2 = new BP_XProfile_ProfileData();
+ $d2->user_id = $u;
+ $d2->field_id = $f2->id;
+ $d2->value = 'bar';
+ $d2->last_updated = $time;
+ $d2->save();
+
+ // Ensure it's deleted from cache
+ wp_cache_delete( $f1->id, 'bp_xprofile_data_' . $u );
+ wp_cache_delete( $f2->id, 'bp_xprofile_data_' . $u );
+
+ $u_obj = new WP_User( $u );
+
+ $expected = array(
+ 'user_login' => $u_obj->user_login,
+ 'user_nicename' => $u_obj->user_nicename,
+ 'user_email' => $u_obj->user_email,
+ $f0->name => array(
+ 'field_group_id' => $g0->id,
+ 'field_group_name' => $g0->name,
+ 'field_id' => $f0->id,
+ 'field_type' => $f0->type,
+ 'field_data' => $d0->value,
+ ),
+ $f1->name => array(
+ 'field_group_id' => $g1->id,
+ 'field_group_name' => $g1->name,
+ 'field_id' => $f1->id,
+ 'field_type' => $f1->type,
+ 'field_data' => $d1->value,
+ ),
+ $f2->name => array(
+ 'field_group_id' => $g2->id,
+ 'field_group_name' => $g2->name,
+ 'field_id' => $f2->id,
+ 'field_type' => $f2->type,
+ 'field_data' => $d2->value,
+ ),
+ );
+
+ $this->assertEquals( $expected, BP_XProfile_ProfileData::get_all_for_user( $u ) );
+ }
+
+ /**
+ * @group get_all_for_user
+ */
+ public function test_get_all_for_user_cached() {
+ $u = $this->create_user();
+ $g1 = $this->factory->xprofile_group->create();
+ $g2 = $this->factory->xprofile_group->create();
+ $f1 = $this->factory->xprofile_field->create( array(
+ 'type' => 'textbox',
+ 'field_group_id' => $g1->id,
+ ) );
+ $f2 = $this->factory->xprofile_field->create( array(
+ 'type' => 'radio',
+ 'field_group_id' => $g2->id,
+ ) );
+
+ $time = bp_core_current_time();
+
+ $g0 = new BP_XProfile_Group( 1 );
+ $f0 = new BP_XProfile_Field( 1 );
+ $d0 = new BP_XProfile_ProfileData( 1, $u );
+
+ $d1 = new stdClass;
+ $d1->user_id = $u;
+ $d1->field_id = $f1->id;
+ $d1->value = 'foo';
+ $d1->last_updated = $time;
+
+ $d2 = new stdClass;
+ $d2->user_id = $u;
+ $d2->field_id = $f2->id;
+ $d2->value = 'bar';
+ $d2->last_updated = $time;
+
+ wp_cache_set( $f1->id, $d1, 'bp_xprofile_data_' . $u );
+ wp_cache_set( $f2->id, $d2, 'bp_xprofile_data_' . $u );
+
+ $u_obj = new WP_User( $u );
+
+ $expected = array(
+ 'user_login' => $u_obj->user_login,
+ 'user_nicename' => $u_obj->user_nicename,
+ 'user_email' => $u_obj->user_email,
+ $f0->name => array(
+ 'field_group_id' => $g0->id,
+ 'field_group_name' => $g0->name,
+ 'field_id' => $f0->id,
+ 'field_type' => $f0->type,
+ 'field_data' => $d0->value,
+ ),
+ $f1->name => array(
+ 'field_group_id' => $g1->id,
+ 'field_group_name' => $g1->name,
+ 'field_id' => $f1->id,
+ 'field_type' => $f1->type,
+ 'field_data' => $d1->value,
+ ),
+ $f2->name => array(
+ 'field_group_id' => $g2->id,
+ 'field_group_name' => $g2->name,
+ 'field_id' => $f2->id,
+ 'field_type' => $f2->type,
+ 'field_data' => $d2->value,
+ ),
+ );
+
+ $this->assertEquals( $expected, BP_XProfile_ProfileData::get_all_for_user( $u ) );
+ }
+
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>