Changeset 11089 for trunk/src/bp-groups/classes/class-bp-groups-group.php

Timestamp:

09/13/2016 05:35:42 AM (8 years ago)

Author:

boonebgorges

Message:

Groups: Remove 'populate_extras' flag from BP_Groups_Group.

populate_extras was originally designed to reduce the number of
additional queries performed when setting up a group, by making those
queries optional in cases where the additional data was not needed.
Now, all of these properties are adequately cached, and lazy-loaded
so that they're only fetched when requested.

See #5451.

File:

• trunk/src/bp-groups/classes/class-bp-groups-group.php (modified) (9 diffs)

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

@@ -114 +114 @@
      * @var bool
      */
-    public $is_member;
+    protected $is_member;
 
     /**
@@ -122 +122 @@
      * @var bool
      */
-    public $is_invited;
+    protected $is_invited;
 
     /**
@@ -130 +130 @@
      * @var bool
      */
-    public $is_pending;
+    protected $is_pending;
 
     /**
@@ -146 +146 @@
      * @var bool
      */
-    public $user_has_access;
+    protected $user_has_access;
 
     /**
@@ -165 +165 @@
      * @param array    $args {
      *     Array of optional arguments.
-     *     @type bool $populate_extras Whether to fetch "extra" data about the group
-     *                                 (group admins/mods, access for the current user).
-     *                                 Default: false.
+     *     @type bool $populate_extras Deprecated.
      * }
      */
     public function __construct( $id = null, $args = array() ) {
-        $this->args = wp_parse_args( $args, array(
-            'populate_extras' => false,
-        ) );
-
         if ( !empty( $id ) ) {
             $this->id = (int) $id;
@@ -217 +211 @@
         $this->enable_forum = (int) $group->enable_forum;
         $this->date_created = $group->date_created;
-
-        // Are we getting extra group data?
-        if ( ! empty( $this->args['populate_extras'] ) ) {
-
-            // Set user-specific data.
-            $user_id          = bp_loggedin_user_id();
-            $this->is_member  = groups_is_user_member( $user_id, $this->id );
-            $this->is_invited = groups_check_user_has_invite( $user_id, $this->id );
-            $this->is_pending = groups_check_for_membership_request( $user_id, $this->id );
-
-            // If this is a private or hidden group, does the current user have access?
-            if ( ( 'private' === $this->status ) || ( 'hidden' === $this->status ) ) {
-
-                // Assume user does not have access to hidden/private groups.
-                $this->user_has_access = false;
-
-                // Group members or community moderators have access.
-                if ( ( $this->is_member && is_user_logged_in() ) || bp_current_user_can( 'bp_moderate' ) ) {
-                    $this->user_has_access = true;
-                }
-            } else {
-                $this->user_has_access = true;
-            }
-        }
     }
 
@@ -425 +395 @@
                 return $this->get_mods();
 
+            case 'is_member' :
+                return $this->get_is_member();
+
+            case 'is_invited' :
+                return groups_check_user_has_invite( bp_loggedin_user_id(), $this->id );
+
+            case 'is_pending' :
+                return groups_check_for_membership_request( bp_loggedin_user_id(), $this->id );
+
+            case 'user_has_access' :
+                return $this->get_user_has_access();
+
             default :
             break;
@@ -445 +427 @@
             case 'last_activity' :
             case 'total_member_count' :
+            case 'admins' :
+            case 'mods' :
                 return true;
 
             default :
                 return false;
+        }
+    }
+
+    /**
+     * Magic setter.
+     *
+     * Used to maintain backward compatibility for properties that are now
+     * accessible only via magic method.
+     *
+     * @since 2.7.0
+     *
+     * @param string $key Property name.
+     */
+    public function __set( $key, $value ) {
+        switch ( $key ) {
+            case 'user_has_access' :
+                return $this->user_has_access = (bool) $value;
         }
     }
@@ -529 +530 @@
         $this->admins = $admin_objects;
         $this->mods   = $mod_objects;
+    }
+
+    /**
+     * Checks whether the logged-in user is a member of the group.
+     *
+     * @since 2.7.0
+     *
+     * @return bool
+     */
+    protected function get_is_member() {
+        if ( isset( $this->is_member ) ) {
+            return $this->is_member;
+        }
+
+        $this->is_member = groups_is_user_member( bp_loggedin_user_id(), $this->id );
+        return $this->is_member;
+    }
+
+    /**
+     * Checks whether the logged-in user has access to the group.
+     *
+     * @since 2.7.0
+     *
+     * @return bool
+     */
+    protected function get_user_has_access() {
+        if ( isset( $this->user_has_access ) ) {
+            return $this->user_has_access;
+        }
+
+        if ( ( 'private' === $this->status ) || ( 'hidden' === $this->status ) ) {
+
+            // Assume user does not have access to hidden/private groups.
+            $this->user_has_access = false;
+
+            // Group members or community moderators have access.
+            if ( ( is_user_logged_in() && $this->get_is_member() ) || bp_current_user_can( 'bp_moderate' ) ) {
+                $this->user_has_access = true;
+            }
+        } else {
+            $this->user_has_access = true;
+        }
+
+        return $this->user_has_access;
     }