Changeset 8605 for trunk/tests/phpunit/assets/group-extensions.php

Timestamp:

07/12/2014 01:26:36 AM (12 years ago)

Author:

boonebgorges

Message:

Overhaul access and visibility control for group tabs

Previously, access control to group tabs was handled in two ways:

• for BP_Group_Extension tabs, the 'enable_nav_item' and 'visibility' provided some control over access to plugin developers, though it was inconsistent, buggy, and difficult to implement properly
• for tabs provided by bp-groups, access to the tabs of non-public groups was controlled directly in the BP_Groups_Component::setup_globals() method

Aside from being unclear for developers, this technique for controlling access
was also inflexible. For non-public groups, tab access was hardcoded and
handled before BP_Group_Extension plugins even had a chance to load. As a
result, it was essentially impossible to add public tabs to non-public groups
(among other non-standard customizations).

The current changeset comprises a number of changes that make tab access more
consistent and flexible:

• Access control is moved to the new bp_groups_group_access_protection() function. This function has the necessary filters to customize access protection in arbitrary ways. And because it loads at 'bp_actions' - just before the page begins to render - all extensions have had a chance to load and register themselves with the desired access settings.
• The 'visibility' and 'enable_nav_item' properties of BP_Group_Extension are phased out in favor of 'access' and 'show_tab' params. 'access' controls who can visit the tab, while 'show_tab' controls who can see the item in the navigation. These new properties have intelligent defaults (based on the privacy level of the group), but can be overridden with a number of custom settings: 'admin', 'mod', 'member', 'loggedin', 'anyone', or 'noone'. Backward compatibility is maintained, so that existing BP_Group_Extension plugins that use enable_nav_item or visibility will continue to work as before.

Fixes #4785

Props boonebgorges, dcavins, imath

File:

• trunk/tests/phpunit/assets/group-extensions.php (modified) (1 diff)

trunk/tests/phpunit/assets/group-extensions.php

@@ -203 +203 @@
     }
 }
+
+class BPTest_Group_Extension_Inferred_Access_Settings_EnableNavItem_True extends BP_Group_Extension {
+    public function __construct() {
+        $class_name = get_class( $this );
+
+        $args = array(
+            'name' => $class_name,
+            'slug' => sanitize_title( $class_name ),
+            'enable_nav_item' => true,
+        );
+
+        parent::init( $args );
+    }
+}
+
+class BPTest_Group_Extension_Inferred_Access_Settings_EnableNavItem_False extends BP_Group_Extension {
+    public function __construct() {
+        $class_name = get_class( $this );
+
+        $args = array(
+            'name' => $class_name,
+            'slug' => sanitize_title( $class_name ),
+            'enable_nav_item' => false,
+        );
+
+        parent::init( $args );
+    }
+}
+class BPTest_Group_Extension_Access_Anyone extends BP_Group_Extension {
+    public function __construct() {
+        $class_name = get_class( $this );
+
+        $args = array(
+            'name' => $class_name,
+            'slug' => sanitize_title( $class_name ),
+            'access' => 'anyone',
+        );
+
+        parent::init( $args );
+    }
+}
+
+class BPTest_Group_Extension_Access_Loggedin extends BP_Group_Extension {
+    public function __construct() {
+        $class_name = get_class( $this );
+
+        $args = array(
+            'name' => $class_name,
+            'slug' => sanitize_title( $class_name ),
+            'access' => 'loggedin',
+        );
+
+        parent::init( $args );
+    }
+}
+
+class BPTest_Group_Extension_Access_Member extends BP_Group_Extension {
+    public function __construct() {
+        $class_name = get_class( $this );
+
+        $args = array(
+            'name' => $class_name,
+            'slug' => sanitize_title( $class_name ),
+            'access' => 'member',
+        );
+
+        parent::init( $args );
+    }
+}
+
+class BPTest_Group_Extension_Access_AdminMod extends BP_Group_Extension {
+    public function __construct() {
+        $class_name = get_class( $this );
+
+        $args = array(
+            'name' => $class_name,
+            'slug' => sanitize_title( $class_name ),
+            'access' => array(
+                'mod',
+                'admin',
+            ),
+        );
+
+        parent::init( $args );
+    }
+}
+
+class BPTest_Group_Extension_Access_Admin extends BP_Group_Extension {
+    public function __construct() {
+        $class_name = get_class( $this );
+
+        $args = array(
+            'name' => $class_name,
+            'slug' => sanitize_title( $class_name ),
+            'access' => 'admin',
+        );
+
+        parent::init( $args );
+    }
+}
+
+class BPTest_Group_Extension_Access_Noone extends BP_Group_Extension {
+    public function __construct() {
+        $class_name = get_class( $this );
+
+        $args = array(
+            'name' => $class_name,
+            'slug' => sanitize_title( $class_name ),
+            'access' => 'noone',
+        );
+
+        parent::init( $args );
+    }
+}
+
+class BPTest_Group_Extension_ShowTab_Anyone extends BP_Group_Extension {
+    public function __construct() {
+        $class_name = get_class( $this );
+
+        $args = array(
+            'name' => $class_name,
+            'slug' => sanitize_title( $class_name ),
+            'access' => 'admin',
+            'show_tab' => 'anyone',
+        );
+
+        parent::init( $args );
+    }
+}
+
+class BPTest_Group_Extension_ShowTab_Loggedin extends BP_Group_Extension {
+    public function __construct() {
+        $class_name = get_class( $this );
+
+        $args = array(
+            'name' => $class_name,
+            'slug' => sanitize_title( $class_name ),
+            'access' => 'admin',
+            'show_tab' => 'loggedin',
+        );
+
+        parent::init( $args );
+    }
+}
+
+class BPTest_Group_Extension_ShowTab_Member extends BP_Group_Extension {
+    public function __construct() {
+        $class_name = get_class( $this );
+
+        $args = array(
+            'name' => $class_name,
+            'slug' => sanitize_title( $class_name ),
+            'access' => 'admin',
+            'show_tab' => 'member',
+        );
+
+        parent::init( $args );
+    }
+}
+
+class BPTest_Group_Extension_ShowTab_AdminMod extends BP_Group_Extension {
+    public function __construct() {
+        $class_name = get_class( $this );
+
+        $args = array(
+            'name' => $class_name,
+            'slug' => sanitize_title( $class_name ),
+            'access' => 'admin',
+            'show_tab' => array(
+                'mod',
+                'admin',
+            ),
+        );
+
+        parent::init( $args );
+    }
+}
+
+class BPTest_Group_Extension_ShowTab_Admin extends BP_Group_Extension {
+    public function __construct() {
+        $class_name = get_class( $this );
+
+        $args = array(
+            'name' => $class_name,
+            'slug' => sanitize_title( $class_name ),
+            'access' => 'admin',
+            'show_tab' => 'admin',
+        );
+
+        parent::init( $args );
+    }
+}
+
+class BPTest_Group_Extension_ShowTab_Noone extends BP_Group_Extension {
+    public function __construct() {
+        $class_name = get_class( $this );
+
+        $args = array(
+            'name' => $class_name,
+            'slug' => sanitize_title( $class_name ),
+            'access' => 'noone',
+            'show_tab' => 'noone',
+        );
+
+        parent::init( $args );
+    }
+}