DeleteUserMetaModule::do_delete() - Code Metrics - Inspection of "330 fix/delete user meta add additional tests" - sudar/bulk-delete - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — dev/6.0.0 (#466)

by Rajan

created 2018-08-14 01:02 UTC

DeleteUserMetaModule::do_delete() B

↳ Parent: DeleteUserMetaModule

Complexity

Conditions	7
Paths	20

Size

Total Lines	36
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	20
CRAP Score	7

Importance

Changes

Metric	Value
cc	7
eloc	22
nc	20
nop	1
dl	0
loc	36
ccs	20
cts	20
cp	1
crap	7
rs	8.6346
c	0
b	0
f	0

<?php
namespace BulkWP\BulkDelete\Core\Metas\Modules;

use BulkWP\BulkDelete\Core\Metas\MetasModule;

defined( 'ABSPATH' ) || exit; // Exit if accessed directly.

/**
 * Delete User Meta.
 *
 * @since 6.0.0
 */
class DeleteUserMetaModule extends MetasModule {
	protected function initialize() {
		$this->field_slug    = 'um'; // Ideally it should be `meta_user`. But we are keeping it as um for backward compatibility.
		$this->meta_box_slug = 'bd-user-meta';
		$this->action        = 'delete_user_meta';
		$this->cron_hook     = 'do-bulk-delete-user-meta';
		$this->messages      = array(
			'box_label'  => __( 'Bulk Delete User Meta', 'bulk-delete' ),
			'scheduled'  => __( 'User meta fields from the users with the selected criteria are scheduled for deletion.', 'bulk-delete' ),
			'cron_label' => __( 'Delete User Meta`', 'bulk-delete' ),
		);
	}

	/**
	 * Render the Modules.
	 */
	public function render() {
		?>
		<!-- User Meta box start-->
		<fieldset class="options">
			<h4><?php _e( 'Select the user role whose user meta fields you want to delete', 'bulk-delete' ); ?></h4>

			<table class="optiontable">
				<?php $this->render_user_role_dropdown(); ?>
			</table>

			<h4><?php _e( 'Choose your user meta field settings', 'bulk-delete' ); ?></h4>
			<table class="optiontable">
				<tr>
					<td>
						<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value" value="false" type="radio" checked>
						<label for="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value"><?php echo __( 'Delete based on user meta key name only', 'bulk-delete' ); ?></label>
					</td>
				</tr>

				<tr>
					<td>
						<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value"
								value="true" type="radio" disabled>
						<label for="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value"><?php echo __( 'Delete based on user meta key name and value', 'bulk-delete' ); ?></label>
						<span class="bd-um-pro" style="color:red; vertical-align: middle;">
							<?php _e( 'Only available in Pro Addon', 'bulk-delete' ); ?>
							<a href="http://bulkwp.com/addons/bulk-delete-user-meta/?utm_source=wpadmin&utm_campaign=BulkDelete&utm_medium=buynow&utm_content=bd-m-u" target="_blank">Buy now</a>
						</span>
					</td>
				</tr>

				<tr>
					<td>
						<label for="smbd_<?php echo esc_attr( $this->field_slug ); ?>_key"><?php _e( 'User Meta Key ', 'bulk-delete' ); ?></label>
						<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_key" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_key" placeholder="<?php _e( 'Meta Key', 'bulk-delete' ); ?>">
					</td>
				</tr>
			</table>
		<?php
		/**
		 * Add more fields to the delete user meta field form.
		 * This hook can be used to add more fields to the delete user meta field form.
		 *
		 * @since 5.4
		 */
		do_action( 'bd_delete_user_meta_form' );
		?>
			<table class="optiontable">
				<tr>
					<td>
						<h4><?php _e( 'Choose your deletion options', 'bulk-delete' ); ?></h4>
					</td>
				</tr>

				<tr>
					<td>
						<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_limit" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_limit" value="true" type="checkbox">
						<?php _e( 'Only delete user meta field from first ', 'bulk-delete' ); ?>
						<input type="text" name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_limit_to" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_limit_to"
									disabled value="0" maxlength="4" size="4">
						<?php _e( 'users.', 'bulk-delete' ); ?>
						<?php _e( 'Use this option if there are more than 1000 users and the script times out.', 'bulk-delete' ); ?>
					</td>
				</tr>

				<tr>
					<td>
						<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron" value="false" type="radio" checked="checked"> <?php _e( 'Delete now', 'bulk-delete' ); ?>
						<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron" value="true" type="radio" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron" disabled>
						<?php _e( 'Schedule', 'bulk-delete' ); ?>
						<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_start" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_start" value="now" type="text" disabled>
						<?php _e( 'repeat ', 'bulk-delete' ); ?>
						<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_freq" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_freq" disabled>
							<option value="-1"><?php _e( "Don't repeat", 'bulk-delete' ); ?></option>
							<?php foreach ( wp_get_schedules() as $key => $value ) : ?>
								<option value="<?php echo esc_attr( $key ); ?>"><?php echo esc_html( $value['display'] ); ?></option>
							<?php endforeach; ?>
						</select>

						<span class="bd-um-pro" style="color:red">
							<?php _e( 'Only available in Pro Addon', 'bulk-delete' ); ?>
							<a href = "http://bulkwp.com/addons/bulk-delete-user-meta/?utm_source=wpadmin&utm_campaign=BulkDelete&utm_medium=buynow&utm_content=bd-m-u">Buy now</a>
						</span>
					</td>
				</tr>

				<tr>
					<td>
						<?php _e( 'Enter time in Y-m-d H:i:s format or enter now to use current time', 'bulk-delete' ); ?>
					</td>
				</tr>

			</table>
		</fieldset>

		<?php $this->render_submit_button(); ?>
		<!-- User Meta box end-->
		<?php
	}

	protected function convert_user_input_to_options( $request, $options ) {
		$options['selected_roles'] = esc_sql( bd_array_get( $request, 'smbd_' . $this->field_slug . '_roles' ) );

		$options['use_value']  = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_use_value', false );
		$options['meta_key']   = esc_sql( bd_array_get( $request, 'smbd_' . $this->field_slug . '_key', '' ) );
		$options['meta_value'] = esc_sql( bd_array_get( $request, 'smbd_' . $this->field_slug . '_value', '' ) );

		/**
		 * Delete user-meta delete options filter.
		 *
		 * This filter is for processing filtering options for deleting user meta.
		 *
		 * @since 5.4
		 */
		return apply_filters( 'bd_delete_user_meta_options', $options, $request );
	}

	protected function do_delete( $options ) {
		$count     = 0;
		$meta_key  = $options['meta_key'];
		$use_value = $options['use_value'];
		$limit_to  = $options['limit_to'];

		$args = array(
			'role__in' => $options['selected_roles'],
		);

		if ( $limit_to > 0 ) {
			$args['number'] = $limit_to;
		}

		if ( $use_value ) {
			$meta_value         = $options['meta_value'];
			$args['meta_query'] = apply_filters( 'bd_delete_user_meta_query', array(), $options );
		} else {
			$args['meta_key'] = $meta_key;
		}

		$users = get_users( $args );

		foreach ( $users as $user ) {
			if ( $use_value ) {
				if ( delete_user_meta( $user->ID, $meta_key, $meta_value ) ) {

					$count++;
				}
			} else {
				if ( delete_user_meta( $user->ID, $meta_key ) ) {
					$count++;
				}
			}
		}

		return $count;
	}

	public function filter_js_array( $js_array ) {
		$js_array['dt_iterators'][]                 = '_' . $this->field_slug;
		$js_array['validators']['delete_user_meta'] = 'noValidation';

		$js_array['pre_action_msg']['delete_user_meta'] = 'deleteUMWarning';
		$js_array['msg']['deleteUMWarning']             = __( 'Are you sure you want to delete all the user meta fields that match the selected filters?', 'bulk-delete' );

		return $js_array;
	}

	protected function get_success_message( $items_deleted ) {
		/* translators: 1 Number of posts deleted */
		return _n( 'Deleted user meta field from %d user', 'Deleted user meta field from %d users', $items_deleted, 'bulk-delete' );
	}
}


1		<?php
2		namespace BulkWP\BulkDelete\Core\Metas\Modules;
3
4		use BulkWP\BulkDelete\Core\Metas\MetasModule;
5
6	1	defined( 'ABSPATH' ) \|\| exit; // Exit if accessed directly.
7
8		/**
9		* Delete User Meta.
10		*
11		* @since 6.0.0
12		*/
13		class DeleteUserMetaModule extends MetasModule {
14	12	protected function initialize() {
15	12	$this->field_slug = 'um'; // Ideally it should be `meta_user`. But we are keeping it as um for backward compatibility.
16	12	$this->meta_box_slug = 'bd-user-meta';
17	12	$this->action = 'delete_user_meta';
18	12	$this->cron_hook = 'do-bulk-delete-user-meta';
19	12	$this->messages = array(
20	12	'box_label' => __( 'Bulk Delete User Meta', 'bulk-delete' ),
21	12	'scheduled' => __( 'User meta fields from the users with the selected criteria are scheduled for deletion.', 'bulk-delete' ),
22	12	'cron_label' => __( 'Delete User Meta`', 'bulk-delete' ),
23		);
24	12	}
25
26		/**
27		* Render the Modules.
28		*/
29		public function render() {
30		?>
31		<!-- User Meta box start-->
32		<fieldset class="options">
33		<h4><?php _e( 'Select the user role whose user meta fields you want to delete', 'bulk-delete' ); ?></h4>
34
35		<table class="optiontable">
36		<?php $this->render_user_role_dropdown(); ?>
37		</table>
38
39		<h4><?php _e( 'Choose your user meta field settings', 'bulk-delete' ); ?></h4>
40		<table class="optiontable">
41		<tr>
42		<td>
43		<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value" value="false" type="radio" checked>
44		<label for="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value"><?php echo __( 'Delete based on user meta key name only', 'bulk-delete' ); ?></label>
45		</td>
46		</tr>
47
48		<tr>
49		<td>
50		<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value"
51		value="true" type="radio" disabled>
52		<label for="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value"><?php echo __( 'Delete based on user meta key name and value', 'bulk-delete' ); ?></label>
53		<span class="bd-um-pro" style="color:red; vertical-align: middle;">
54		<?php _e( 'Only available in Pro Addon', 'bulk-delete' ); ?>
55		<a href="http://bulkwp.com/addons/bulk-delete-user-meta/?utm_source=wpadmin&utm_campaign=BulkDelete&utm_medium=buynow&utm_content=bd-m-u" target="_blank">Buy now</a>
56		</span>
57		</td>
58		</tr>
59
60		<tr>
61		<td>
62		<label for="smbd_<?php echo esc_attr( $this->field_slug ); ?>_key"><?php _e( 'User Meta Key ', 'bulk-delete' ); ?></label>
63		<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_key" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_key" placeholder="<?php _e( 'Meta Key', 'bulk-delete' ); ?>">
64		</td>
65		</tr>
66		</table>
67		<?php
68		/**
69		* Add more fields to the delete user meta field form.
70		* This hook can be used to add more fields to the delete user meta field form.
71		*
72		* @since 5.4
73		*/
74		do_action( 'bd_delete_user_meta_form' );
75		?>
76		<table class="optiontable">
77		<tr>
78		<td>
79		<h4><?php _e( 'Choose your deletion options', 'bulk-delete' ); ?></h4>
80		</td>
81		</tr>
82
83		<tr>
84		<td>
85		<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_limit" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_limit" value="true" type="checkbox">
86		<?php _e( 'Only delete user meta field from first ', 'bulk-delete' ); ?>
87		<input type="text" name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_limit_to" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_limit_to"
88		disabled value="0" maxlength="4" size="4">
89		<?php _e( 'users.', 'bulk-delete' ); ?>
90		<?php _e( 'Use this option if there are more than 1000 users and the script times out.', 'bulk-delete' ); ?>
91		</td>
92		</tr>
93
94		<tr>
95		<td>
96		<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron" value="false" type="radio" checked="checked"> <?php _e( 'Delete now', 'bulk-delete' ); ?>
97		<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron" value="true" type="radio" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron" disabled>
98		<?php _e( 'Schedule', 'bulk-delete' ); ?>
99		<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_start" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_start" value="now" type="text" disabled>
100		<?php _e( 'repeat ', 'bulk-delete' ); ?>
101		<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_freq" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_freq" disabled>
102		<option value="-1"><?php _e( "Don't repeat", 'bulk-delete' ); ?></option>
103		<?php foreach ( wp_get_schedules() as $key => $value ) : ?>
104		<option value="<?php echo esc_attr( $key ); ?>"><?php echo esc_html( $value['display'] ); ?></option>
105		<?php endforeach; ?>
106		</select>
107
108		<span class="bd-um-pro" style="color:red">
109		<?php _e( 'Only available in Pro Addon', 'bulk-delete' ); ?>
110		<a href = "http://bulkwp.com/addons/bulk-delete-user-meta/?utm_source=wpadmin&utm_campaign=BulkDelete&utm_medium=buynow&utm_content=bd-m-u">Buy now</a>
111		</span>
112		</td>
113		</tr>
114
115		<tr>
116		<td>
117		<?php _e( 'Enter time in Y-m-d H:i:s format or enter now to use current time', 'bulk-delete' ); ?>
118		</td>
119		</tr>
120
121		</table>
122		</fieldset>
123
124		<?php $this->render_submit_button(); ?>
125		<!-- User Meta box end-->
126		<?php
127		}
128
129		protected function convert_user_input_to_options( $request, $options ) {
130		$options['selected_roles'] = esc_sql( bd_array_get( $request, 'smbd_' . $this->field_slug . '_roles' ) );
131
132		$options['use_value'] = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_use_value', false );
133		$options['meta_key'] = esc_sql( bd_array_get( $request, 'smbd_' . $this->field_slug . '_key', '' ) );
134		$options['meta_value'] = esc_sql( bd_array_get( $request, 'smbd_' . $this->field_slug . '_value', '' ) );
135
136		/**
137		* Delete user-meta delete options filter.
138		*
139		* This filter is for processing filtering options for deleting user meta.
140		*
141		* @since 5.4
142		*/
143		return apply_filters( 'bd_delete_user_meta_options', $options, $request );
144		}
145
146	12	protected function do_delete( $options ) {
147	12	$count = 0;
148	12	$meta_key = $options['meta_key'];
149	12	$use_value = $options['use_value'];
150	12	$limit_to = $options['limit_to'];
151
152		$args = array(
153	12	'role__in' => $options['selected_roles'],
154		);
155
156	12	if ( $limit_to > 0 ) {
157	1	$args['number'] = $limit_to;
158		}
159
160	12	if ( $use_value ) {
161	1	$meta_value = $options['meta_value'];
162	1	$args['meta_query'] = apply_filters( 'bd_delete_user_meta_query', array(), $options );
163		} else {
164	11	$args['meta_key'] = $meta_key;
165		}
166
167	12	$users = get_users( $args );
168
169	12	foreach ( $users as $user ) {
170	10	if ( $use_value ) {
171	1	if ( delete_user_meta( $user->ID, $meta_key, $meta_value ) ) {
		0 ignored issues – show Comprehensibility Best Practice introduced 2018-08-14 01:12 UTC by Report Bug Copy Issue Report The variable `$meta_value` does not seem to be defined for all execution paths leading up to this point. Loading history...
172	1	$count++;
173		}
174		} else {
175	9	if ( delete_user_meta( $user->ID, $meta_key ) ) {
176	10	$count++;
177		}
178		}
179		}
180
181	12	return $count;
182		}
183
184		public function filter_js_array( $js_array ) {
185		$js_array['dt_iterators'][] = '_' . $this->field_slug;
186		$js_array['validators']['delete_user_meta'] = 'noValidation';
187
188		$js_array['pre_action_msg']['delete_user_meta'] = 'deleteUMWarning';
189		$js_array['msg']['deleteUMWarning'] = __( 'Are you sure you want to delete all the user meta fields that match the selected filters?', 'bulk-delete' );
190
191		return $js_array;
192		}
193
194		protected function get_success_message( $items_deleted ) {
195		/* translators: 1 Number of posts deleted */
196		return _n( 'Deleted user meta field from %d user', 'Deleted user meta field from %d users', $items_deleted, 'bulk-delete' );
197		}
198		}
199

sudar / bulk-delete

Pull Request — dev/6.0.0 (#466)

DeleteUserMetaModule::do_delete() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like