Changeset 5598

Timestamp:

12/24/2011 06:01:22 PM (15 years ago)

Author:

johnjamesjacoby

Message:

When deleting a field, do not delete the field data by default. Fixes #3888. In memory of jimgroom's lost data.

Location:

trunk/bp-xprofile

Files:

• bp-xprofile-admin.php (modified) (2 diffs)
• bp-xprofile-classes.php (modified) (2 diffs)

trunk/bp-xprofile/bp-xprofile-admin.php

@@ -313 +313 @@
 }
 
-/**************************************************************************
- xprofile_admin_delete_field()
-
- Handles the deletion of a profile field [or option].
-**************************************************************************/
-function xprofile_admin_delete_field( $field_id, $type = 'field' ) {
+/**
+ * Handles the deletion of a profile field (or field option)
+ *
+ * @since BuddyPress (1.0)
+ * @global string $message The feedback message to show
+ * @global $type The type of feedback message to show
+ * @param int $field_id The field to delete
+ * @param string $field_type The type of field being deleted
+ * @param bool $delete_data Should the field data be deleted too?
+ */
+function xprofile_admin_delete_field( $field_id, $field_type = 'field', $delete_data = false ) {
         global $message, $type;
 
-        if ( 'field' == $type )
-                $type = __('field', 'buddypress');
-        else
-                $type = __('option', 'buddypress');
+        // Switch type to 'option' if type is not 'field'
+        // @todo trust this param
+        $field_type  = ( 'field' == $field_type ) ? __( 'field', 'buddypress' ) : __( 'option', 'buddypress' );
 
         $field = new BP_XProfile_Field( $field_id );
 
-        if ( !$field->delete() ) {
-                $message = sprintf( __('There was an error deleting the %s. Please try again', 'buddypress' ), $type );
-                $type = 'error';
+        if ( !$field->delete( (bool) $delete_data ) ) {
+                $message = sprintf( __( 'There was an error deleting the %s. Please try again', 'buddypress' ), $field_type );
+                $type    = 'error';
         } else {
-                $message = sprintf( __('The %s was deleted successfully!', 'buddypress' ), $type );
-                $type = 'success';
+                $message = sprintf( __( 'The %s was deleted successfully!', 'buddypress' ), $field_type );
+                $type    = 'success';
 
                 do_action( 'xprofile_fields_deleted_field', $field );
@@ -460 +464 @@
 
 <?php } ?>
+
+<?php if ( $field->description ) : ?>
+
+                                                                <p class="description"><?php echo esc_attr( $field->description ); ?></p>
+
+<?php endif; ?>
+
                                                                 <div class="actions">
-                                                                        <?php if ( !$field->can_delete ) : ?>&nbsp;<?php else : ?><a class="submit-delete deletion ajax-option-delete" href="admin.php?page=bp-profile-setup&amp;field_id=<?php echo esc_attr( $field->id ); ?>&amp;mode=delete_field"><?php _e( 'Delete', 'buddypress' ); ?></a><?php endif; ?>
                                                                         <a class="button edit" href="admin.php?page=bp-profile-setup&amp;group_id=<?php echo esc_attr( $admin_group->id ); ?>&amp;field_id=<?php echo esc_attr( $field->id ); ?>&amp;mode=edit_field"><?php _e( 'Edit', 'buddypress' ); ?></a>
+
+                                                                        <?php if ( $field->can_delete ) : ?>
+
+                                                                                <a class="submit-delete deletion" href="admin.php?page=bp-profile-setup&amp;field_id=<?php echo esc_attr( $field->id ); ?>&amp;mode=delete_field"><?php _e( 'Delete', 'buddypress' ); ?></a>
+
+                                                                        <?php endif; ?>
                                                                 </div>
-
-<?php if ( $field->description ) : ?>
-
-                                                                <p class="description"><?php echo esc_attr( $field->description ); ?></p>
-
-<?php endif; ?>
-
                                                         </div>
                                                 </fieldset>

trunk/bp-xprofile/bp-xprofile-classes.php

@@ -374 +374 @@
         }
 
-        function delete() {
-                global $wpdb, $bp;
-
-                if ( !$this->id ||
-                        /* Prevent deletion by url when can_delete is false. */
-                        !$this->can_delete ||
-                        /* Prevent deletion of option 1 since this invalidates fields with options. */
-                        ( $this->parent_id && $this->option_order == 1 ) )
+        function delete( $delete_data = false ) {
+                global $wpdb, $bp;
+
+                // Prevent deletion if no ID is present
+                // Prevent deletion by url when can_delete is false.
+                // Prevent deletion of option 1 since this invalidates fields with options.
+                if ( !$this->id || !$this->can_delete || ( $this->parent_id && $this->option_order == 1 ) )
                         return false;
 
@@ -387 +386 @@
                         return false;
 
-                /* delete the data in the DB for this field */
-                BP_XProfile_ProfileData::delete_for_field( $this->id );
+                // delete the data in the DB for this field
+                if ( true === $delete_data )
+                        BP_XProfile_ProfileData::delete_for_field( $this->id );
 
                 return true;