Changeset 10022 for trunk/src/bp-xprofile/classes/class-bp-xprofile-group.php

Timestamp:

07/21/2015 02:00:38 PM (11 years ago)

Author:

boonebgorges

Message:

Allow xProfile fields to be restricted to users belonging to one or more member types.

A new metabox on the profile field edit panel allows the administrator to
select the member types to which the field is applicable. Admins can also
choose to have a field apply to users who do not belong to any member type.
Information about a field's member type associations is displayed on the
Users > Profile Fields page, alongside each field name.

During registration, the only fields that are displayed are those that are
unrestricted - that is, those available to all users, regardless of member type
(or lack thereof).

This changeset introduces a number of new methods on BP_XProfile_Field that
developers should use to manipulate member type information:
get_member_types(), set_member_types(), and the static
get_fields_for_member_type(). In addition to member types that have been
explicitly registered, 'null' is a pseudo-type representing users who do not
belong to a member type.

This changeset introduces a blacklist of illegal member type names. By default,
the blacklist includes 'any', 'null', and '_none'. Use the
'bp_member_type_illegal_names' filter to add names to the blacklist.

Props Offereins, boonebgorges, tanner m, imath.
See #5192.

File:

• trunk/src/bp-xprofile/classes/class-bp-xprofile-group.php (modified) (4 diffs)

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

@@ -233 +233 @@
      *      @type int   $user_id           Required if you want to load a specific user's data.
      *                                     Default: displayed user's ID.
+     *      @type array|string $member_type Limit fields by those restricted to a given member type, or array of
+     *                                      member types. If `$user_id` is provided, the value of `$member_type`
+     *                                      will be overridden by the member types of the provided user. The
+     *                                      special value of 'any' will return only those fields that are
+     *                                      unrestricted by member type - i.e., those applicable to any type.
      *      @type bool  $hide_empty_groups True to hide groups that don't have any fields. Default: false.
      *  @type bool  $hide_empty_fields True to hide fields where the user has not provided data. Default: false.
@@ -252 +257 @@
             'profile_group_id'       => false,
             'user_id'                => bp_displayed_user_id(),
+            'member_type'            => false,
             'hide_empty_groups'      => false,
             'hide_empty_fields'      => false,
@@ -319 +325 @@
         $exclude_fields_cs  = implode( ',', $exclude_fields_cs );
 
-        // Setup IN query for field IDs
+        // Set up NOT IN query for excluded field IDs.
         if ( ! empty( $exclude_fields_cs ) ) {
             $exclude_fields_sql = "AND id NOT IN ({$exclude_fields_cs})";
@@ -326 +332 @@
         }
 
+        // Set up IN query for included field IDs.
+        $include_field_ids = array();
+
+        // Member-type restrictions.
+        if ( bp_get_member_types() ) {
+            if ( $r['user_id'] || false !== $r['member_type'] ) {
+                $member_types = $r['member_type'];
+                if ( $r['user_id'] ) {
+                    $member_types = bp_get_member_type( $r['user_id'], false );
+                    if ( empty( $member_types ) ) {
+                        $member_types = array( 'null' );
+                    }
+                }
+
+                $member_types_fields = BP_XProfile_Field::get_fields_for_member_type( $member_types );
+                $include_field_ids += array_keys( $member_types_fields );
+            }
+        }
+
+        $in_sql = '';
+        if ( ! empty( $include_field_ids ) ) {
+            $include_field_ids_cs = implode( ',', array_map( 'intval', $include_field_ids ) );
+            $in_sql = " AND id IN ({$include_field_ids_cs}) ";
+        }
+
         // Fetch the fields
-        $fields    = $wpdb->get_results( "SELECT id, name, description, type, group_id, is_required FROM {$bp->profile->table_name_fields} WHERE group_id IN ( {$group_ids_in} ) AND parent_id = 0 {$exclude_fields_sql} ORDER BY field_order" );
+        $fields = $wpdb->get_results( "SELECT id, name, description, type, group_id, is_required FROM {$bp->profile->table_name_fields} WHERE group_id IN ( {$group_ids_in} ) AND parent_id = 0 {$exclude_fields_sql} {$in_sql} ORDER BY field_order" );
+
         $field_ids = wp_list_pluck( $fields, 'id' );