Changeset 11316

Timestamp:

12/21/2016 02:42:05 AM (10 years ago)

Author:

boonebgorges

Message:

XProfile: More consistent cache behavior when fetching user data.

• Inside of a profile group loop (BP_XProfile_Group::get()), don't fetch user data when pulling up BP_XProfile_Field objects. In the absence of finer-grained information about users, fetching a field object grabs the data associated with the logged-in user. But in many cases, the logged-in user is irrelevant to the fields being looped over, so there's no benefit to pulling up this data. (When necessary - fetch_data - the data is queried separately, later in the get() method.)
• When caching database misses for a data query (because the specifed user doesn't have anything filled in for the given field), store the field_id and user_id properties on the cached object. This ensures that values are properly associated with their fields when being displayed.

These changes resolve an issue where cached data for the logged-in user
can be shown erroneously on another user's profile, when the other user
doesn't have a value for a given field.

Props m_uysl, r-a-y.
See #6091. Fixes #7401.

Location:

trunk/src/bp-xprofile

Files:

• bp-xprofile-functions.php (modified) (2 diffs)
• classes/class-bp-xprofile-field.php (modified) (2 diffs)
• classes/class-bp-xprofile-group.php (modified) (1 diff)
• classes/class-bp-xprofile-profiledata.php (modified) (2 diffs)

trunk/src/bp-xprofile/bp-xprofile-functions.php

@@ -283 +283 @@
  *
  * @since 1.1.0
- *
- * @param int|object $field ID of the field or object representing field data.
+ * @since 2.8.0 Added `$user_id` and `$get_data` parameters.
+ *
+ * @param int|object $field    ID of the field or object representing field data.
+ * @param int        $user_id  Optional. ID of the user associated with the field.
+ *                             Ignored if `$get_data` is false. If `$get_data` is
+ *                             true, but no `$user_id` is provided, defaults to
+ *                             logged-in user ID.
+ * @param bool       $get_data Whether to fetch data for the specified `$user_id`.
  * @return BP_XProfile_Field|null Field object if found, otherwise null.
  */
-function xprofile_get_field( $field ) {
+function xprofile_get_field( $field, $user_id = null, $get_data = true ) {
         if ( $field instanceof BP_XProfile_Field ) {
                 $_field = $field;
@@ -294 +300 @@
                 $_field->fill_data( $field );
         } else {
-                $_field = BP_XProfile_Field::get_instance( $field );
+                $_field = BP_XProfile_Field::get_instance( $field, $user_id, $get_data );
         }
 

trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php

@@ -228 +228 @@
          *
          * @since 2.4.0
+         * @since 2.8.0 Added `$user_id` and `$get_data` parameters.
          *
          * @static
          *
-         * @param int $field_id ID of the field.
+         * @param int  $field_id ID of the field.
+         * @param int  $user_id  Optional. ID of the user associated with the field.
+         *                       Ignored if `$get_data` is false. If `$get_data` is
+         *                       true, but no `$user_id` is provided, defaults to
+         *                       logged-in user ID.
+         * @param bool $get_data Whether to fetch data for the specified `$user_id`.
          * @return BP_XProfile_Field|false Field object if found, otherwise false.
          */
-        public static function get_instance( $field_id ) {
+        public static function get_instance( $field_id, $user_id = null, $get_data = true ) {
                 global $wpdb;
 
@@ -242 +248 @@
                 }
 
-                return new self( $field_id );
+                return new self( $field_id, $user_id, $get_data );
         }
 

trunk/src/bp-xprofile/classes/class-bp-xprofile-group.php

@@ -397 +397 @@
                 $fields = array();
                 foreach ( $field_ids as $field_id ) {
-                        $fields[] = xprofile_get_field( $field_id );
+                        $fields[] = xprofile_get_field( $field_id, null, false );
                 }
 

trunk/src/bp-xprofile/classes/class-bp-xprofile-profiledata.php

@@ -324 +324 @@
                                         $d               = new stdClass;
                                         $d->id           = '';
-                                        $d->user_id      = '';
+                                        $d->user_id      = $user_id;
                                         $d->field_id     = $field_id;
                                         $d->value        = '';
@@ -490 +490 @@
                                         $d->id           = '';
                                         $d->user_id      = $id;
-                                        $d->field_id     = '';
+                                        $d->field_id     = $field_id;
                                         $d->value        = '';
                                         $d->last_updated = '';