<!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][9693] trunk/src/bp-xprofile/bp-xprofile-cache.php: XProfile: Improvements to `bp_xprofile_update_meta_cache()`:</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/9693">9693</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/9693","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnjamesjacoby</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-04-03 22:11:15 +0000 (Fri, 03 Apr 2015)</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'>XProfile: Improvements to `bp_xprofile_update_meta_cache()`:
* Cleaner logic for deciding whether a query is necessary
* Bail if: no query necessary, no where conditions, no uncached data, no data retrieved
* Avoid possible debug notice if `$where_sql` was never defined
* Fewer indentations and less needless execution via improved sanity checks
See <a href="http://buddypress.trac.wordpress.org/ticket/6347">#6347</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpxprofilebpxprofilecachephp">trunk/src/bp-xprofile/bp-xprofile-cache.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpxprofilebpxprofilecachephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-xprofile/bp-xprofile-cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/bp-xprofile-cache.php 2015-04-03 21:36:15 UTC (rev 9692)
+++ trunk/src/bp-xprofile/bp-xprofile-cache.php 2015-04-03 22:11:15 UTC (rev 9693)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -55,88 +55,122 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_xprofile_update_meta_cache( $object_ids = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Bail if no objects
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $object_ids ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">- // $object_ids is a multi-dimensional array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $bp = buddypress();
+
+ // Define the array where uncached object IDs will be stored
</ins><span class="cx" style="display: block; padding: 0 10px"> $uncached_object_ids = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'group' => array(),
- 'field' => array(),
- 'data' => array(),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'group',
+ 'field',
+ 'data'
</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">+ // Define the cache groups for the 3 types of XProfile metadata
</ins><span class="cx" style="display: block; padding: 0 10px"> $cache_groups = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'group' => 'xprofile_group_meta',
</span><span class="cx" style="display: block; padding: 0 10px"> 'field' => 'xprofile_field_meta',
</span><span class="cx" style="display: block; padding: 0 10px"> 'data' => 'xprofile_data_meta',
</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">+ // No reason to query yet
</ins><span class="cx" style="display: block; padding: 0 10px"> $do_query = false;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $uncached_object_ids as $object_type => $uncached_object_type_ids ) {
- if ( ! empty( $object_ids[ $object_type ] ) ) {
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Sanitize $object_ids passed to the function
- $object_type_ids = wp_parse_id_list( $object_ids[ $object_type ] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Loop through object types and look for uncached data
+ foreach ( $uncached_object_ids as $object_type ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Get non-cached IDs for each object type
- $uncached_object_ids[ $object_type ] = bp_get_non_cached_ids( $object_type_ids, $cache_groups[ $object_type ] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Skip if empty object type
+ if ( empty( $object_ids[ $object_type ] ) ) {
+ continue;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Set the flag to do the meta query
- if ( ! empty( $uncached_object_ids[ $object_type ] ) && ! $do_query ) {
- $do_query = true;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Sanitize $object_ids passed to the function
+ $object_type_ids = wp_parse_id_list( $object_ids[ $object_type ] );
+
+ // Get non-cached IDs for each object type
+ $uncached_object_ids[ $object_type ] = bp_get_non_cached_ids( $object_type_ids, $cache_groups[ $object_type ] );
+
+ // Set the flag to do the meta query
+ if ( ! empty( $uncached_object_ids[ $object_type ] ) && ( false === $do_query ) ) {
+ $do_query = true;
</ins><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If there are uncached items, go ahead with the query
- if ( true === $do_query ) {
- $where = array();
- foreach ( $uncached_object_ids as $otype => $oids ) {
- if ( empty( $oids ) ) {
- continue;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Bail if no uncached items
+ if ( false === $do_query ) {
+ return;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $oids_sql = implode( ',', wp_parse_id_list( $oids ) );
- $where[] = $wpdb->prepare( "( object_type = %s AND object_id IN ({$oids_sql}) )", $otype );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Setup where conditions for query
+ $where_sql = '';
+ $where_conditions = array();
+
+ // Loop through uncached objects and prepare to query for them
+ foreach ( $uncached_object_ids as $otype => $oids ) {
+
+ // Skip empty object IDs
+ if ( empty( $oids ) ) {
+ continue;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $where_sql = implode( " OR ", $where );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Compile WHERE query conditions for uncached metadata
+ $oids_sql = implode( ',', wp_parse_id_list( $oids ) );
+ $where_conditions[] = $wpdb->prepare( "( object_type = %s AND object_id IN ({$oids_sql}) )", $otype );
</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">+ // Bail if no where conditions
+ if ( empty( $where_conditions ) ) {
+ return;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $bp = buddypress();
- $cache = array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Setup the WHERE query part
+ $where_sql = implode( " OR ", $where_conditions );
+
+ // Attempt to query meta values
</ins><span class="cx" style="display: block; padding: 0 10px"> $meta_list = $wpdb->get_results( "SELECT object_id, object_type, meta_key, meta_value FROM {$bp->profile->table_name_meta} WHERE {$where_sql}" );
</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( $meta_list ) ) {
- foreach ( $meta_list as $meta ) {
- $oid = $meta->object_id;
- $otype = $meta->object_type;
- $okey = $meta->meta_key;
- $ovalue = $meta->meta_value;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Bail if no results found
+ if ( empty( $meta_list ) || is_wp_error( $meta_list ) ) {
+ return;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Force subkeys to be array type
- if ( ! isset( $cache[ $otype ][ $oid ] ) || ! is_array( $cache[ $otype ][ $oid ] ) ) {
- $cache[ $otype ][ $oid ] = array();
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Setup empty cache array
+ $cache = array();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! isset( $cache[ $otype ][ $oid ][ $okey ] ) || ! is_array( $cache[ $otype ][ $oid ][ $okey ] ) ) {
- $cache[ $otype ][ $oid ][ $okey ] = array();
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Loop through metas
+ foreach ( $meta_list as $meta ) {
+ $oid = $meta->object_id;
+ $otype = $meta->object_type;
+ $okey = $meta->meta_key;
+ $ovalue = $meta->meta_value;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Add to the cache array
- $cache[ $otype ][ $oid ][ $okey ][] = maybe_unserialize( $ovalue );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Force subkeys to be array type
+ if ( ! isset( $cache[ $otype ][ $oid ] ) || ! is_array( $cache[ $otype ][ $oid ] ) ) {
+ $cache[ $otype ][ $oid ] = array();
</ins><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">- foreach ( $cache as $object_type => $object_caches ) {
- $cache_group = $cache_groups[ $object_type ];
- foreach ( $object_caches as $object_id => $object_cache ) {
- wp_cache_set( $object_id, $object_cache, $cache_group );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! isset( $cache[ $otype ][ $oid ][ $okey ] ) || ! is_array( $cache[ $otype ][ $oid ][ $okey ] ) ) {
+ $cache[ $otype ][ $oid ][ $okey ] = array();
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Add to the cache array
+ $cache[ $otype ][ $oid ][ $okey ][] = maybe_unserialize( $ovalue );
</ins><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">- return;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Loop through data and cache to the appropriate object
+ foreach ( $cache as $object_type => $object_caches ) {
+
+ // Determine the cache group for this data
+ $cache_group = $cache_groups[ $object_type ];
+
+ // Loop through objects and cache appropriately
+ foreach ( $object_caches as $object_id => $object_cache ) {
+ wp_cache_set( $object_id, $object_cache, $cache_group );
+ }
+ }
</ins><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></span></pre>
</div>
</div>
</body>
</html>