Changeset 11378

Timestamp:

01/06/2017 03:56:09 AM (9 years ago)

Author:

boonebgorges

Message:

Lazy-load user property in BP_Groups_Member.

The user property is a BP_Core_User object, but is rarely
used by BP core. Only loading it when needed can save database
queries in certain cases, such as when a user is being promoted
or demoted within a group.

Props r-a-y.
Fixes #7382.

Location:

trunk

Files:

• src/bp-groups/classes/class-bp-groups-member.php (modified) (2 diffs)
• tests/phpunit/testcases/groups/class-bp-groups-member.php (modified) (1 diff)

trunk/src/bp-groups/classes/class-bp-groups-member.php

@@ -130 +130 @@
      * @var WP_User
      */
-    var $user;
+    protected $user;
 
     /**
@@ -198 +198 @@
             $this->comments      = $member->comments;
             $this->invite_sent   = (int) $member->invite_sent;
-
+        }
+    }
+
+    /**
+     * Magic getter.
+     *
+     * @since 2.8.0
+     *
+     * @param string $key Key.
+     * @return mixed
+     */
+    public function __get( $key ) {
+        switch ( $key ) {
+            case 'user' :
+                return $this->get_user_object( $this->user_id );
+        }
+    }
+
+    /**
+     * Magic issetter.
+     *
+     * @since 2.8.0
+     *
+     * @param string $key Key.
+     * @return mixed
+     */
+    public function __isset( $key ) {
+        switch ( $key ) {
+            case 'user' :
+                return true;
+
+            default :
+                return isset( $this->{$key} );
+        }
+    }
+
+    /**
+     * Get the user object corresponding to this membership.
+     *
+     * Used for lazyloading the protected `user` property.
+     *
+     * @since 2.8.0
+     *
+     * @return BP_Core_User
+     */
+    protected function get_user_object() {
+        if ( empty( $this->user ) ) {
             $this->user = new BP_Core_User( $this->user_id );
         }
+
+        return $this->user;
     }
 

trunk/tests/phpunit/testcases/groups/class-bp-groups-member.php

@@ -1301 +1301 @@
         $this->assertEqualSets( array( $m0, $m1 ), wp_list_pluck( $found, 'id' ) );
     }
+
+    /**
+     * @ticket BP7382
+     */
+    public function test_user_property_should_be_accessible() {
+        $user = $this->factory->user->create();
+        $group = $this->factory->group->create();
+
+        $this->add_user_to_group( $user, $group );
+
+        $membership = new BP_Groups_Member( $user, $group );
+
+        $user_obj = $membership->user;
+
+        $this->assertInstanceOf( 'BP_Core_User', $user_obj );
+        $this->assertEquals( $user, $user_obj->id );
+    }
 }