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

Timestamp:

04/28/2017 02:36:15 PM (8 years ago)

Author:

dcavins

Message:

Add $is_visible and $is_user_member properties to BP_Groups_Group object.

During single group setup in the BP_Groups_Component, we're doing
some checks that duplicate logic that is, or should be, handled in
BP_Groups_Group. Then, BP_Groups_Component can rely on
BP_Groups_Group to provide the details via recently added magic
methods.

Note: $is_user_member is an alias of $is_member for backward
compatibility.

Fixes #7494.

File:

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

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

@@ -127 +127 @@
 
     /**
+     * Is the current user a member of this group?
+     * Alias of $is_member for backward compatibility.
+     *
+     * @since 2.9.0
+     * @var bool
+     */
+    protected $is_user_member;
+
+    /**
      * Does the current user have an outstanding invitation to this group?
      *
@@ -157 +166 @@
      */
     protected $user_has_access;
+
+    /**
+     * Can the current user know that this group exists?
+     *
+     * @since 2.9.0
+     * @var bool
+     */
+    protected $is_visible;
 
     /**
@@ -417 +434 @@
 
             case 'is_member' :
+            case 'is_user_member' :
                 return $this->get_is_member();
 
@@ -427 +445 @@
             case 'user_has_access' :
                 return $this->get_user_has_access();
+
+            case 'is_visible' :
+                return $this->is_visible();
 
             default :
@@ -449 +470 @@
             case 'is_invited' :
             case 'is_member' :
+            case 'is_user_member' :
             case 'is_pending' :
             case 'last_activity' :
@@ -454 +476 @@
             case 'total_member_count' :
             case 'user_has_access' :
+            case 'is_visible' :
             case 'forum_id' :
                 return true;
@@ -606 +629 @@
 
         return $this->user_has_access;
+    }
+
+    /**
+     * Checks whether the current user can know the group exists.
+     *
+     * @since 2.9.0
+     *
+     * @return bool
+     */
+    protected function is_visible() {
+        if ( isset( $this->is_visible ) ) {
+            return $this->is_visible;
+        }
+
+        if ( 'hidden' === $this->status ) {
+
+            // Assume user can not know about hidden groups.
+            $this->is_visible = false;
+
+            // Group members or community moderators have access.
+            if ( ( is_user_logged_in() && $this->get_is_member() ) || bp_current_user_can( 'bp_moderate' ) ) {
+                $this->is_visible = true;
+            }
+        } else {
+            $this->is_visible = true;
+        }
+
+        return $this->is_visible;
     }