Changeset 7914 for trunk/bp-xprofile/bp-xprofile-classes.php

Timestamp:

02/17/2014 07:42:03 PM (11 years ago)

Author:

boonebgorges

Message:

Introduce metadata pre-fetching for xprofile objects

XProfile objects (groups, fields, and data) are generally fetched in a nested
way, as within the context of a bp_has_profile() loop. Thus, it makes sense to
pre-fetch xprofile metadata within a bp_has_profile() loop in a nested way as
well. This changeset introduces bp_xprofile_update_meta_cache(), which is able
to fetch all uncached metadata for nested meta types with a single database
query.

This changeset also introduces an 'update_meta_cache' parameter to the
bp_has_profile() stack. This param allows developers to disable the pre-
fetching introduced here. Defaults to true.

See #5398

File:

• trunk/bp-xprofile/bp-xprofile-classes.php (modified) (6 diffs)

trunk/bp-xprofile/bp-xprofile-classes.php

@@ -118 +118 @@
      *      'exclude_groups' - Comma-separated list of groups to exclude
      *      'exclude_fields' - Comma-separated list of fields to exclude
+     *      'update_meta_cache' - Whether to pre-fetch xprofilemeta
+     *         for all retrieved groups, fields, and data
      *
      * @return array $groups
@@ -133 +135 @@
             'fetch_visibility_level' => false,
             'exclude_groups'         => false,
-            'exclude_fields'         => false
+            'exclude_fields'         => false,
+            'update_meta_cache'      => true,
         );
 
         $r = wp_parse_args( $args, $defaults );
         extract( $r, EXTR_SKIP );
+
+        // Keep track of object IDs for cache-priming
+        $object_ids = array(
+            'group' => array(),
+            'field' => array(),
+            'data'  => array(),
+        );
+
         $where_sql = '';
 
@@ -162 +173 @@
         }
 
+        // Store for meta cache priming
+        $object_ids['group'] = $group_ids;
+
         $group_ids = implode( ',', (array) $group_ids );
 
@@ -183 +197 @@
         // Fetch the fields
         $fields = $wpdb->get_results( "SELECT id, name, description, type, group_id, is_required FROM {$bp->profile->table_name_fields} WHERE group_id IN ( {$group_ids} ) AND parent_id = 0 {$exclude_fields_sql} ORDER BY field_order" );
+
+        // Store field IDs for meta cache priming
+        $object_ids['field'] = wp_list_pluck( $fields, 'id' );
 
         if ( empty( $fields ) )
@@ -241 +258 @@
                             $fields[$field_key]->data->id    = $data->id;
                         }
+
+                        // Store for meta cache priming
+                        $object_ids['data'][] = $data->id;
                     }
                 }
@@ -272 +292 @@
             // Reset indexes
             $groups = array_values( $groups );
+        }
+
+        // Prime the meta cache, if necessary
+        if ( $update_meta_cache ) {
+            bp_xprofile_update_meta_cache( $object_ids );
         }