<!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][7806] trunk: Implement persistent caching in BP_XProfile_ProfileData::get_value_byid()</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/7806">7806</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-02-06 01:39:48 +0000 (Thu, 06 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Implement persistent caching in BP_XProfile_ProfileData::get_value_byid()
This change should mean significant performance improvements, as the method
is used a number of places throughout BuddyPress:
- bp_get_the_profile_field_options() (to check/select the saved values)
- xprofile_get_field_data()
- when swapping out blog commenter names with BP display names
Introduces 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 (7805 => 7806)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-xprofile/bp-xprofile-classes.php 2014-02-05 22:53:30 UTC (rev 7805)
+++ trunk/bp-xprofile/bp-xprofile-classes.php 2014-02-06 01:39:48 UTC (rev 7806)
</span><span class="lines">@@ -1333,20 +1333,61 @@
</span><span class="cx"> return $fielddata_id;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Get profile field values by field ID and user IDs.
+ *
+ * Supports multiple user IDs.
+ *
+ * @param int $field_id ID of the field.
+ * @param int|array $user_ids ID or IDs of user(s).
+ * @return string|array Single value if a single user is queried,
+ * otherwise an array of results.
+ */
</ins><span class="cx"> public static function get_value_byid( $field_id, $user_ids = null ) {
</span><span class="cx"> global $wpdb, $bp;
</span><span class="cx">
</span><del>- if ( empty( $user_ids ) )
</del><ins>+ if ( empty( $user_ids ) ) {
</ins><span class="cx"> $user_ids = bp_displayed_user_id();
</span><ins>+ }
</ins><span class="cx">
</span><del>- if ( is_array( $user_ids ) ) {
- $user_ids = implode( ',', wp_parse_id_list( $user_ids ) );
- $data = $wpdb->get_results( $wpdb->prepare( "SELECT user_id, value FROM {$bp->profile->table_name_data} WHERE field_id = %d AND user_id IN ({$user_ids})", $field_id ) );
</del><ins>+ $is_single = false;
+ if ( ! is_array( $user_ids ) ) {
+ $user_ids = array( $user_ids );
+ $is_single = true;
+ }
+
+ // Assemble uncached IDs
+ $uncached_ids = array();
+ foreach ( $user_ids as $user_id ) {
+ if ( false === wp_cache_get( $field_id, 'bp_xprofile_data_' . $user_id ) ) {
+ $uncached_ids[] = $user_id;
+ }
+ }
+
+ // Prime caches
+ if ( ! empty( $uncached_ids ) ) {
+ $uncached_ids_sql = implode( ',', $uncached_ids );
+ $queried_data = $wpdb->get_results( $wpdb->prepare( "SELECT id, user_id, field_id, value, last_updated FROM {$bp->profile->table_name_data} WHERE field_id = %d AND user_id IN ({$uncached_ids_sql})", $field_id ) );
+
+ foreach ( $queried_data as $d ) {
+ wp_cache_set( $field_id, $d, 'bp_xprofile_data_' . $d->user_id );
+ }
+ }
+
+ // Now that the cache is primed with all data, fetch it
+ $data = array();
+ foreach ( $user_ids as $user_id ) {
+ $data[] = wp_cache_get( $field_id, 'bp_xprofile_data_' . $user_id );
+ }
+
+ // If a single ID was passed, just return the value
+ if ( $is_single ) {
+ return $data[0]->value;
+
+ // Otherwise return the whole array
</ins><span class="cx"> } else {
</span><del>- $data = $wpdb->get_var( $wpdb->prepare( "SELECT value FROM {$bp->profile->table_name_data} WHERE field_id = %d AND user_id = %d", $field_id, $user_ids ) );
</del><ins>+ return $data;
</ins><span class="cx"> }
</span><del>-
- return $data;
</del><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> public static function get_value_byfieldname( $fields, $user_id = null ) {
</span></span></pre></div>
<a id="trunkteststestcasesxprofileclassbpxprofileprofiledataphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/xprofile/class-bp-xprofile-profiledata.php (7805 => 7806)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/xprofile/class-bp-xprofile-profiledata.php 2014-02-05 22:53:30 UTC (rev 7805)
+++ trunk/tests/testcases/xprofile/class-bp-xprofile-profiledata.php 2014-02-06 01:39:48 UTC (rev 7806)
</span><span class="lines">@@ -117,4 +117,150 @@
</span><span class="cx">
</span><span class="cx"> $this->assertSame( 5, BP_XProfile_ProfileData::get_fielddataid_byid( $f->id, $u ) );
</span><span class="cx"> }
</span><ins>+
+ /**
+ * @group get_value_byid
+ */
+ public function test_get_value_byid_singleuser_uncached() {
+ $u = $this->create_user();
+ $g = $this->factory->xprofile_group->create();
+ $f = $this->factory->xprofile_field->create( array(
+ 'type' => 'textbox',
+ 'field_group_id' => $g->id,
+ ) );
+
+ $d = new BP_XProfile_ProfileData();
+ $d->user_id = $u;
+ $d->field_id = $f->id;
+ $d->value = 'foo';
+ $d->save();
+
+ // Ensure it's deleted from cache
+ wp_cache_delete( $f->id, 'bp_xprofile_data_' . $u );
+
+ $this->assertSame( 'foo', BP_XProfile_ProfileData::get_value_byid( $f->id, $u ) );
+ }
+
+ /**
+ * @group get_value_byid
+ */
+ public function test_get_value_byid_multipleusers_uncached() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $g = $this->factory->xprofile_group->create();
+ $f = $this->factory->xprofile_field->create( array(
+ 'type' => 'textbox',
+ 'field_group_id' => $g->id,
+ ) );
+
+ $time = bp_core_current_time();
+
+ $d1 = new BP_XProfile_ProfileData();
+ $d1->user_id = $u1;
+ $d1->field_id = $f->id;
+ $d1->value = 'foo';
+ $d1->last_updated = $time;
+ $d1->save();
+
+ $d2 = new BP_XProfile_ProfileData();
+ $d2->user_id = $u2;
+ $d2->field_id = $f->id;
+ $d2->value = 'bar';
+ $d2->last_updated = $time;
+ $d2->save();
+
+ // Ensure it's deleted from cache
+ wp_cache_delete( $f->id, 'bp_xprofile_data_' . $u1 );
+ wp_cache_delete( $f->id, 'bp_xprofile_data_' . $u2 );
+
+ $eu1 = new stdClass;
+ $eu1->user_id = $u1;
+ $eu1->value = 'foo';
+ $eu1->id = $d1->id;
+ $eu1->field_id = $f->id;
+ $eu1->last_updated = $time;
+
+ $eu2 = new stdClass;
+ $eu2->user_id = $u2;
+ $eu2->value = 'bar';
+ $eu2->id = $d2->id;
+ $eu2->field_id = $f->id;
+ $eu2->last_updated = $time;
+
+ $expected = array( $eu1, $eu2 );
+
+ $this->assertEquals( $expected, BP_XProfile_ProfileData::get_value_byid( $f->id, array( $u1, $u2 ) ) );
+ }
+
+ /**
+ * @group get_value_byid
+ */
+ public function test_get_value_byid_singleuser_cached() {
+ $u = $this->create_user();
+ $g = $this->factory->xprofile_group->create();
+ $f = $this->factory->xprofile_field->create( array(
+ 'type' => 'textbox',
+ 'field_group_id' => $g->id,
+ ) );
+
+ $time = bp_core_current_time();
+
+ // Fake the cache
+ $d = new stdClass;
+ $d->value = 'foo';
+ $d->field_id = $f->id;
+ wp_cache_set( $f->id, $d, 'bp_xprofile_data_' . $u );
+
+ $this->assertSame( 'foo', BP_XProfile_ProfileData::get_value_byid( $f->id, $u ) );
+ }
+
+ /**
+ * @group get_value_byid
+ */
+ public function test_get_value_byid_multipleusers_cached() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $g = $this->factory->xprofile_group->create();
+ $f = $this->factory->xprofile_field->create( array(
+ 'type' => 'textbox',
+ 'field_group_id' => $g->id,
+ ) );
+
+ // Fake the cache
+ $d1 = new stdClass;
+ $d1->id = 10;
+ $d1->user_id = $u1;
+ $d1->field_id = $f->id;
+ $d1->value = 'foo';
+ $d1->last_updated = $time;
+
+ $d2 = new stdClass;
+ $d1->id = 21;
+ $d2->user_id = $u2;
+ $d2->field_id = $f->id;
+ $d2->value = 'bar';
+ $d2->last_updated = $time;
+
+ wp_cache_set( $f->id, $d1, 'bp_xprofile_data_' . $u1 );
+ wp_cache_set( $f->id, $d2, 'bp_xprofile_data_' . $u2 );
+
+ $eu1 = new stdClass;
+ $eu1->id = 10;
+ $eu1->user_id = $u1;
+ $eu1->field_id = $f->id;
+ $eu1->value = 'foo';
+ $eu1->last_updated = $time;
+
+ $eu2 = new stdClass;
+ $eu1->id = 21;
+ $eu2->user_id = $u2;
+ $eu2->field_id = $f->id;
+ $eu2->value = 'bar';
+ $eu2->last_updated = $time;
+
+ $expected = array( $eu1, $eu2 );
+
+ $this->assertEquals( $expected, BP_XProfile_ProfileData::get_value_byid( $f->id, array( $u1, $u2 ) ) );
+ }
+
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>