Changeset 10164

Timestamp:

10/02/2015 09:57:22 PM (9 years ago)

Author:

boonebgorges

Message:

Lazy-load visibility properties in BP_XProfile_Field.

Previously, populating a new BP_XProfile_Field object would result in two
queries: one to fetch the field row from the database, and one to populate the
field meta cache in order to set the 'allow_custom_visibility' and
'default_visibility' properties. It's not often the case that we need the
latter properties, which means that the cache-priming query is wasted.

This changeset addresses the shortcoming by loading the properties only when
they're requested:

• $allow_custom_visibility and $default_visibility are now protected properties of the object. This directs requests for them to the magic methods.
• Introduce __isset() and __get() to handle backward compatibility.
• Introduce public getter functions for each property.

See #6638.

Location:

trunk

Files:

• src/bp-xprofile/classes/class-bp-xprofile-field.php (modified) (6 diffs)
• tests/phpunit/testcases/xprofile/class-bp-xprofile-field.php (modified) (2 diffs)

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

@@ -124 +124 @@
      *
      * @since 1.9.0
-     *
+     * @since 2.4.0 Property marked protected. Now accessible by magic method or by `get_default_visibility()`.
+     *
+     * @access protected
      * @var string Default field data visibility.
      */
-    public $default_visibility = 'public';
+    protected $default_visibility;
 
     /**
@@ -133 +135 @@
      *
      * @since 2.3.0
-     *
++    * @since 2.4.0 Property marked protected. Now accessible by magic method or by `get_allow_custom_visibility()`.
+     *
+     * @access protected
      * @var string Members are allowed/disallowed to modify data visibility.
      */
-    public $allow_custom_visibility = 'allowed';
+    protected $allow_custom_visibility;
 
     /**
@@ -229 +233 @@
                 $this->data = $this->get_field_data( $user_id );
             }
-
-            // Get metadata for field.
-            $default_visibility       = bp_xprofile_get_meta( $id, 'field', 'default_visibility'      );
-            $allow_custom_visibility  = bp_xprofile_get_meta( $id, 'field', 'allow_custom_visibility' );
-
-            // Setup default visibility.
-            $this->default_visibility = ! empty( $default_visibility )
-                ? $default_visibility
-                : 'public';
-
-            // Allow members to customize visibilty.
-            $this->allow_custom_visibility = ( 'disabled' === $allow_custom_visibility )
-                ? 'disabled'
-                : 'allowed';
+        }
+    }
+
+    /**
+     * Magic getter.
+     *
+     * @since 2.4.0
+     *
+     * @param string $key Property name.
+     * @return mixed
+     */
+    public function __get( $key ) {
+        switch ( $key ) {
+            case 'default_visibility' :
+                return $this->get_default_visibility();
+                break;
+
+            case 'allow_custom_visibility' :
+                return $this->get_allow_custom_visibility();
+                break;
+        }
+    }
+
+    /**
+     * Magic issetter.
+     *
+     * @since 2.4.0
+     *
+     * @param string $key Property name.
+     * @return bool
+     */
+    public function __isset( $key ) {
+        switch ( $key ) {
+            // Backward compatibility for when these were public methods.
+            case 'allow_custom_visibility' :
+            case 'default_visibility' :
+                return true;
+                break;
         }
     }
@@ -693 +721 @@
     }
 
+    /**
+     * Get the field's default visibility setting.
+     *
+     * Lazy-loaded to reduce overhead.
+     *
+     * Defaults to 'public' if no visibility setting is found in the database.
+     *
+     * @since 2.4.0
+     *
+     * @return string
+     */
+    public function get_default_visibility() {
+        if ( ! isset( $this->default_visibility ) ) {
+            $this->default_visibility = bp_xprofile_get_meta( $this->id, 'field', 'default_visibility' );
+
+            if ( ! $this->default_visibility ) {
+                $this->default_visibility = 'public';
+            }
+        }
+
+        return $this->default_visibility;
+    }
+
+    /**
+     * Get whether the field's default visibility can be overridden by users.
+     *
+     * Lazy-loaded to reduce overhead.
+     *
+     * Defaults to 'allowed'.
+     *
+     * @since 4.4.0
+     *
+     * @return string 'disabled' or 'allowed'.
+     */
+    public function get_allow_custom_visibility() {
+        if ( ! isset( $this->allow_custom_visibility ) ) {
+            $allow_custom_visibility = bp_xprofile_get_meta( $this->id, 'field', 'allow_custom_visibility' );
+
+            if ( 'disabled' === $allow_custom_visibility ) {
+                $this->allow_custom_visibility = 'disabled';
+            } else {
+                $this->allow_custom_visibility = 'allowed';
+            }
+        }
+
+        return $this->allow_custom_visibility;
+    }
+
     /** Static Methods ********************************************************/
 
@@ -1254 +1330 @@
                         <?php foreach( bp_xprofile_get_visibility_levels() as $level ) : ?>
 
-                            <option value="<?php echo esc_attr( $level['id'] ); ?>" <?php selected( $this->default_visibility, $level['id'] ); ?>>
+                            <option value="<?php echo esc_attr( $level['id'] ); ?>" <?php selected( $this->get_default_visibility(), $level['id'] ); ?>>
                                 <?php echo esc_html( $level['label'] ); ?>
                             </option>
@@ -1266 +1342 @@
                     <ul>
                         <li>
-                            <input type="radio" id="allow-custom-visibility-allowed" name="allow-custom-visibility" value="allowed" <?php checked( $this->allow_custom_visibility, 'allowed' ); ?> />
+                            <input type="radio" id="allow-custom-visibility-allowed" name="allow-custom-visibility" value="allowed" <?php checked( $this->get_allow_custom_visibility(), 'allowed' ); ?> />
                             <label for="allow-custom-visibility-allowed"><?php esc_html_e( 'Allow members to override', 'buddypress' ); ?></label>
                         </li>
                         <li>
-                            <input type="radio" id="allow-custom-visibility-disabled" name="allow-custom-visibility" value="disabled" <?php checked( $this->allow_custom_visibility, 'disabled' ); ?> />
+                            <input type="radio" id="allow-custom-visibility-disabled" name="allow-custom-visibility" value="disabled" <?php checked( $this->get_allow_custom_visibility(), 'disabled' ); ?> />
                             <label for="allow-custom-visibility-disabled"><?php esc_html_e( 'Enforce field visibility', 'buddypress' ); ?></label>
                         </li>

trunk/tests/phpunit/testcases/xprofile/class-bp-xprofile-field.php

@@ -5 +5 @@
  */
 class BP_Tests_BP_XProfile_Field_TestCases extends BP_UnitTestCase {
-    
+
     /**
      * @group xprofile_field_save
@@ -121 +121 @@
         $this->assertSame( $new_field_id, $field->id );
     }
+
+    /**
+     * @ticket BP6638
+     */
+    public function test_default_visibility_should_be_lazy_loaded() {
+        global $wpdb;
+
+        $group = $this->factory->xprofile_group->create();
+        $field = $this->factory->xprofile_field->create( array(
+            'field_group_id' => $group,
+        ) );
+
+        bp_xprofile_update_meta( $field, 'field', 'default_visibility', 'loggedin' );
+
+        // Initial setup takes just one query.
+        $num_queries = $wpdb->num_queries;
+        $field_obj = new BP_XProfile_Field( $field );
+        $num_queries++;
+
+        $this->assertSame( $num_queries, $wpdb->num_queries );
+
+        // Fetching the default_visibility should cause another query.
+        $this->assertSame( 'loggedin', $field_obj->default_visibility );
+        $num_queries++;
+
+        $this->assertSame( $num_queries, $wpdb->num_queries );
+    }
+
+    /**
+     * @ticket BP6638
+     */
+    public function test_allow_custom_visibility_should_be_lazy_loaded() {
+        global $wpdb;
+
+        $group = $this->factory->xprofile_group->create();
+        $field = $this->factory->xprofile_field->create( array(
+            'field_group_id' => $group,
+        ) );
+
+        bp_xprofile_update_meta( $field, 'field', 'allow_custom_visibility', 'disabled' );
+
+        // Initial setup takes just one query.
+        $num_queries = $wpdb->num_queries;
+        $field_obj = new BP_XProfile_Field( $field );
+        $num_queries++;
+
+        $this->assertSame( $num_queries, $wpdb->num_queries );
+
+        // Fetching the allow_custom_visibility should cause another query.
+        $this->assertSame( 'disabled', $field_obj->allow_custom_visibility );
+        $num_queries++;
+
+        $this->assertSame( $num_queries, $wpdb->num_queries );
+    }
 }