Changeset 10198

Timestamp:

10/07/2015 02:30:31 PM (9 years ago)

Author:

boonebgorges

Message:

Introduce cache support for xprofile fields.

xprofile_get_field() will now look in the cache before returning a
BP_XProfile_Field object (via the new BP_XProfile_Field::get_instance()),
and will populate the cache if necessary. It's strongly recommended to use
xprofile_get_field() when fetching individual existing fields, instead of
creating new BP_XProfile_Field objects directly.

BP_XProfile_Group::get() now leverages the field cache too. Instead of a
SELECT * query, it fetches a list of matching field IDs SELECT id, and
populates the full field objects from the cache, if available. The fields
property of BP_XProfile_Group objects is now an array of BP_XProfile_Field
objects, not stdClass. See #6358.

Props boonebgorges, r-a-y.
See #6638.

Location:

trunk

Files:

• src/bp-xprofile/bp-xprofile-cache.php (modified) (1 diff)
• src/bp-xprofile/bp-xprofile-functions.php (modified) (1 diff)
• src/bp-xprofile/bp-xprofile-loader.php (modified) (1 diff)
• src/bp-xprofile/classes/class-bp-xprofile-field.php (modified) (1 diff)
• src/bp-xprofile/classes/class-bp-xprofile-group.php (modified) (1 diff)
• tests/phpunit/testcases/xprofile/cache.php (modified) (1 diff)
• tests/phpunit/testcases/xprofile/functions.php (modified) (1 diff)

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

@@ -284 +284 @@
 add_action( 'update_option_bp-xprofile-fullname-field-name', 'xprofile_clear_fullname_field_id_cache' );
 
+/**
+ * Clear a field's caches.
+ *
+ * @since 2.4.0
+ *
+ * @param int|BP_XProfile_Field A field ID or a field object.
+ * @param bool False on failure.
+ */
+function bp_xprofile_clear_field_cache( $field ) {
+    if ( is_numeric( $field ) ) {
+        $field_id = (int) $field;
+    } elseif ( $field instanceof BP_XProfile_Field ) {
+        $field_id = (int) $field->id;
+    }
+
+    if ( ! isset( $field_id ) ) {
+        return false;
+    }
+
+    wp_cache_delete( $field_id, 'bp_xprofile_fields' );
+    wp_cache_delete( $field_id, 'xprofile_meta' );
+}
+add_action( 'xprofile_field_after_save', 'bp_xprofile_clear_field_cache' );
+
 // List actions to clear super cached pages on, if super cache is installed.
 add_action( 'xprofile_updated_profile', 'bp_core_clear_cache' );

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

@@ -276 +276 @@
 }
 
-function xprofile_get_field( $field_id ) {
-    return new BP_XProfile_Field( $field_id );
+/**
+ * Get a profile field object.
+ *
+ * @param int|object $field ID of the field or object representing field data.
+ * @return BP_XProfile_Field|null Field object if found, otherwise null.
+ */
+function xprofile_get_field( $field ) {
+    if ( $field instanceof BP_XProfile_Field ) {
+        $_field = $field;
+    } elseif ( is_object( $field ) ) {
+        $_field = new BP_XProfile_Field();
+        $_field->fill_data( $field );
+    } else {
+        $_field = BP_XProfile_Field::get_instance( $field );
+    }
+
+    if ( ! $_field ) {
+        return null;
+    }
+
+    return $_field;
 }
 

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

@@ -394 +394 @@
             'bp_xprofile',
             'bp_xprofile_data',
+            'bp_xprofile_fields',
             'bp_xprofile_groups',
             'xprofile_meta'

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

@@ -212 +212 @@
         $field = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$bp->profile->table_name_fields} WHERE id = %d", $id ) );
 
-        if ( ! empty( $field ) ) {
-            $this->id                = $field->id;
-            $this->group_id          = $field->group_id;
-            $this->parent_id         = $field->parent_id;
-            $this->type              = $field->type;
-            $this->name              = stripslashes( $field->name );
-            $this->description       = stripslashes( $field->description );
-            $this->is_required       = $field->is_required;
-            $this->can_delete        = $field->can_delete;
-            $this->field_order       = $field->field_order;
-            $this->option_order      = $field->option_order;
-            $this->order_by          = $field->order_by;
-            $this->is_default_option = $field->is_default_option;
-
-            // Create the field type and store a reference back to this object.
-            $this->type_obj            = bp_xprofile_create_field_type( $field->type );
-            $this->type_obj->field_obj = $this;
-
-            if ( ! empty( $get_data ) && ! empty( $user_id ) ) {
-                $this->data = $this->get_field_data( $user_id );
-            }
-        }
+        $this->fill_data( $field );
+
+        if ( ! empty( $get_data ) && ! empty( $user_id ) ) {
+            $this->data = $this->get_field_data( $user_id );
+        }
+    }
+
+    /**
+     * Retrieve a `BP_XProfile_Field` instance.
+     *
+     * @static
+     *
+     * @param int $field_id ID of the field.
+     * @return BP_XProfile_Field|false Field object if found, otherwise false.
+     */
+    public static function get_instance( $field_id ) {
+        global $wpdb;
+
+        $field_id = (int) $field_id;
+        if ( ! $field_id ) {
+            return false;
+        }
+
+        $field = wp_cache_get( $field_id, 'bp_xprofile_fields' );
+        if ( false === $field ) {
+            $bp = buddypress();
+
+            $field = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$bp->profile->table_name_fields} WHERE id = %d", $field_id ) );
+
+            wp_cache_add( $field->id, $field, 'bp_xprofile_fields' );
+
+            if ( ! $field ) {
+                return false;
+            }
+        }
+
+        $_field = new BP_XProfile_Field();
+        $_field->fill_data( $field );
+
+        return $_field;
+    }
+
+    /**
+     * Fill object vars based on data passed to the method.
+     *
+     * @since 2.4.0
+     *
+     * @param array|object $args Array or object representing the `BP_XProfile_Field` properties.
+     *                           Generally, this is a row from the fields database table.
+     */
+    public function fill_data( $args ) {
+        if ( is_object( $args ) ) {
+            $args = (array) $args;
+        }
+
+        foreach ( $args as $k => $v ) {
+            if ( 'name' === $k || 'description' === $k ) {
+                $v = stripslashes( $v );
+            }
+            $this->{$k} = $v;
+        }
+
+        // Create the field type and store a reference back to this object.
+        $this->type_obj            = bp_xprofile_create_field_type( $this->type );
+        $this->type_obj->field_obj = $this;;
     }
 

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

@@ -370 +370 @@
 
         // 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_in} ) AND parent_id = 0 {$exclude_fields_sql} {$in_sql} ORDER BY field_order" );
-
-        $field_ids = wp_list_pluck( $fields, 'id' );
+        $field_ids = $wpdb->get_col( "SELECT id FROM {$bp->profile->table_name_fields} WHERE group_id IN ( {$group_ids_in} ) AND parent_id = 0 {$exclude_fields_sql} {$in_sql} ORDER BY field_order" );
+
+        // Bail if no fields.
+        if ( empty( $field_ids ) ) {
+            return $groups;
+        }
+
+        $field_ids = array_map( 'intval', $field_ids );
+
+        // Prime the field cache.
+        $uncached_field_ids = bp_get_non_cached_ids( $field_ids, 'bp_xprofile_fields' );
+        if ( ! empty( $uncached_field_ids ) ) {
+            $_uncached_field_ids = implode( ',', array_map( 'intval', $uncached_field_ids ) );
+            $uncached_fields = $wpdb->get_results( "SELECT * FROM {$bp->profile->table_name_fields} WHERE id IN ({$_uncached_field_ids})" );
+            foreach ( $uncached_fields as $uncached_field ) {
+                $fid = intval( $uncached_field->id );
+                wp_cache_set( $fid, $uncached_field, 'bp_xprofile_fields' );
+            }
+        }
+
+        // Pull field objects from the cache.
+        $fields = array();
+        foreach ( $field_ids as $field_id ) {
+            $fields[] = xprofile_get_field( $field_id );
+        }
 
         // Store field IDs for meta cache priming.
         $object_ids['field'] = $field_ids;
-
-        // Bail if no fields.
-        if ( empty( $fields ) ) {
-            return $groups;
-        }
 
         // Maybe fetch field data.

trunk/tests/phpunit/testcases/xprofile/cache.php

@@ -145 +145 @@
         $this->assertFalse( wp_cache_get( $d->id, 'xprofile_data_meta' ) );
     }
+
+    /**
+     * @ticket BP6638
+     */
+    public function test_field_cache_should_be_invalidated_on_save() {
+        $g = $this->factory->xprofile_group->create();
+        $f = $this->factory->xprofile_field->create( array(
+            'field_group_id' => $g,
+            'name' => 'Foo',
+        ) );
+
+        $field = xprofile_get_field( $f );
+        $this->assertSame( 'Foo', $field->name );
+
+        $field->name = 'Bar';
+        $this->assertNotEmpty( $field->save() );
+
+        $field_2 = xprofile_get_field( $f );
+        $this->assertSame( 'Bar', $field_2->name );
+    }
 }

trunk/tests/phpunit/testcases/xprofile/functions.php

@@ -869 +869 @@
         $this->assertEquals( array( 1, $g1, $g3, $g2 ), wp_list_pluck( $field_groups, 'id' ) );
     }
+
+    /**
+     * @ticket BP6638
+     */
+    public function test_xprofile_get_field_should_return_bp_xprofile_field_object() {
+        global $wpdb;
+
+        $g = $this->factory->xprofile_group->create();
+        $f = $this->factory->xprofile_field->create( array(
+            'field_group_id' => $g,
+            'type' => 'selectbox',
+            'name' => 'Foo',
+        ) );
+
+        $field = xprofile_get_field( $f );
+
+        $this->assertTrue( $field instanceof BP_XProfile_Field );
+    }
+
+    /**
+     * @ticket BP6638
+     * @group cache
+     */
+    public function test_xprofile_get_field_should_prime_field_cache() {
+        global $wpdb;
+
+        $g = $this->factory->xprofile_group->create();
+        $f = $this->factory->xprofile_field->create( array(
+            'field_group_id' => $g,
+            'type' => 'selectbox',
+            'name' => 'Foo',
+        ) );
+
+        $num_queries = $wpdb->num_queries;
+
+        // Prime the cache.
+        $field_1 = xprofile_get_field( $f );
+        $num_queries++;
+        $this->assertSame( $num_queries, $wpdb->num_queries );
+
+        // No more queries.
+        $field_2 = xprofile_get_field( $f );
+        $this->assertEquals( $field_1, $field_2 );
+        $this->assertSame( $num_queries, $wpdb->num_queries );
+    }
 }