Changeset 7836

Timestamp:

02/10/2014 04:29:06 PM (11 years ago)

Author:

boonebgorges

Message:

Introduce xprofile_get_field_visibility_level()

This is a simple function for grabbing the visibility level attached to a given
field by a specific user, sensitive to admin-provided defaults and override
settings.

See #4636

Location:

trunk

Files:

• bp-xprofile/bp-xprofile-functions.php (modified) (1 diff)
• tests/testcases/xprofile/functions.php (modified) (1 diff)

trunk/bp-xprofile/bp-xprofile-functions.php

@@ -288 +288 @@
 }
 
+/**
+ * Get the visibility level for a field.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param int $field_id The ID of the xprofile field.
+ * @param int $user_id The ID of the user to whom the data belongs.
+ * @return string
+ */
+function xprofile_get_field_visibility_level( $field_id = 0, $user_id = 0 ) {
+    $current_level = '';
+
+    if ( empty( $field_id ) || empty( $user_id ) ) {
+        return $current_level;
+    }
+
+    $current_levels = bp_get_user_meta( $user_id, 'bp_xprofile_visibility_levels', true );
+    $current_level  = isset( $current_levels[ $field_id ] ) ? $current_levels[ $field_id ] : '';
+
+    // Use the user's stored level, unless custom visibility is disabled
+    $field = new BP_XProfile_Field( $field_id );
+    if ( isset( $field->allow_custom_visibility ) && 'disabled' === $field->allow_custom_visibility ) {
+        $current_level = $field->default_visibility;
+    }
+
+    // If we're still empty, it means that overrides are permitted, but the
+    // user has not provided a value. Use the default value.
+    if ( empty( $current_level ) ) {
+        $current_level = $field->default_visibility;
+    }
+
+    return $current_level;
+}
+
 function xprofile_delete_field_data( $field, $user_id ) {
     if ( is_numeric( $field ) )

trunk/tests/testcases/xprofile/functions.php

@@ -93 +93 @@
         $this->assertFalse( wp_cache_get( 'fullname_field_id', 'bp_xprofile' ) );
     }
+
+    /**
+     * @group xprofile_get_field_visibility_level
+     */
+    public function test_bp_xprofile_get_field_visibility_level_missing_params() {
+        $this->assertSame( '', xprofile_get_field_visibility_level( 0, 1 ) );
+        $this->assertSame( '', xprofile_get_field_visibility_level( 1, 0 ) );
+    }
+
+    /**
+     * @group xprofile_get_field_visibility_level
+     */
+    public function test_bp_xprofile_get_field_visibility_level_user_set() {
+        $u = $this->create_user();
+        $g = $this->factory->xprofile_group->create();
+        $f = $this->factory->xprofile_field->create( array(
+            'field_group_id' => $g->id,
+            'type' => 'textbox',
+        ) );
+
+        bp_xprofile_update_meta( $f->id, 'field', 'default_visibility', 'adminsonly' );
+        bp_xprofile_update_meta( $f->id, 'field', 'allow_custom_visibility', 'allowed' );
+
+        xprofile_set_field_visibility_level( $f->id, $u, 'loggedin' );
+
+        $this->assertSame( 'loggedin', xprofile_get_field_visibility_level( $f->id, $u ) );
+    }
+
+    /**
+     * @group xprofile_get_field_visibility_level
+     */
+    public function test_bp_xprofile_get_field_visibility_level_user_unset() {
+        $u = $this->create_user();
+        $g = $this->factory->xprofile_group->create();
+        $f = $this->factory->xprofile_field->create( array(
+            'field_group_id' => $g->id,
+            'type' => 'textbox',
+        ) );
+
+        bp_xprofile_update_meta( $f->id, 'field', 'default_visibility', 'adminsonly' );
+        bp_xprofile_update_meta( $f->id, 'field', 'allow_custom_visibility', 'allowed' );
+
+        $this->assertSame( 'adminsonly', xprofile_get_field_visibility_level( $f->id, $u ) );
+
+    }
+
+    /**
+     * @group xprofile_get_field_visibility_level
+     */
+    public function test_bp_xprofile_get_field_visibility_level_admin_override() {
+        $u = $this->create_user();
+        $g = $this->factory->xprofile_group->create();
+        $f = $this->factory->xprofile_field->create( array(
+            'field_group_id' => $g->id,
+            'type' => 'textbox',
+        ) );
+
+        bp_xprofile_update_meta( $f->id, 'field', 'default_visibility', 'adminsonly' );
+        bp_xprofile_update_meta( $f->id, 'field', 'allow_custom_visibility', 'disabled' );
+
+        xprofile_set_field_visibility_level( $f->id, $u, 'loggedin' );
+
+        $this->assertSame( 'adminsonly', xprofile_get_field_visibility_level( $f->id, $u ) );
+    }
 }