Changeset 10198 for trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php

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.

File:

• trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php (modified) (1 diff)

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;;
     }