DeleteUserMetaModule::initialize() - 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 Sudar

created 2018-09-19 07:03 UTC

DeleteUserMetaModule::initialize() A

↳ Parent: DeleteUserMetaModule

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	8
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	9
ccs	9
cts	9
cp	1
crap	1
rs	10

<?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>
						<label>
							<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' ); ?>
						</label>
						<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>
						<label>
						<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron" value="false" type="radio" checked="checked"> 
						<?php _e( 'Delete now', 'bulk-delete' ); ?>
						</label>
						<label>
						<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' ); ?>
						</label>
						<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']      = sanitize_text_field( 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	5	protected function initialize() {
15	5	$this->field_slug = 'um'; // Ideally it should be `meta_user`. But we are keeping it as um for backward compatibility.
16	5	$this->meta_box_slug = 'bd-user-meta';
17	5	$this->action = 'delete_user_meta';
18	5	$this->cron_hook = 'do-bulk-delete-user-meta';
19	5	$this->messages = array(
20	5	'box_label' => __( 'Bulk Delete User Meta', 'bulk-delete' ),
21	5	'scheduled' => __( 'User meta fields from the users with the selected criteria are scheduled for deletion.', 'bulk-delete' ),
22	5	'cron_label' => __( 'Delete User Meta`', 'bulk-delete' ),
23		);
24	5	}
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		<label>
86		<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">
87		<?php _e( 'Only delete user meta field from first ', 'bulk-delete' ); ?>
88		</label>
89		<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"
90		disabled value="0" maxlength="4" size="4">
91		<?php _e( 'users.', 'bulk-delete' ); ?>
92		<?php _e( 'Use this option if there are more than 1000 users and the script times out.', 'bulk-delete' ); ?>
93		</td>
94		</tr>
95
96		<tr>
97		<td>
98		<label>
99		<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron" value="false" type="radio" checked="checked">
100		<?php _e( 'Delete now', 'bulk-delete' ); ?>
101		</label>
102		<label>
103		<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>
104		<?php _e( 'Schedule', 'bulk-delete' ); ?>
105		</label>
106		<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>
107		<?php _e( 'repeat ', 'bulk-delete' ); ?>
108		<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_freq" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_freq" disabled>
109		<option value="-1"><?php _e( "Don't repeat", 'bulk-delete' ); ?></option>
110		<?php foreach ( wp_get_schedules() as $key => $value ) : ?>
111		<option value="<?php echo esc_attr( $key ); ?>"><?php echo esc_html( $value['display'] ); ?></option>
112		<?php endforeach; ?>
113		</select>
114
115		<span class="bd-um-pro" style="color:red">
116		<?php _e( 'Only available in Pro Addon', 'bulk-delete' ); ?>
117		<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>
118		</span>
119		</td>
120		</tr>
121
122		<tr>
123		<td>
124		<?php _e( 'Enter time in Y-m-d H:i:s format or enter now to use current time', 'bulk-delete' ); ?>
125		</td>
126		</tr>
127
128		</table>
129		</fieldset>
130
131		<?php $this->render_submit_button(); ?>
132		<!-- User Meta box end-->
133		<?php
134		}
135
136		protected function convert_user_input_to_options( $request, $options ) {
137		$options['selected_roles'] = esc_sql( bd_array_get( $request, 'smbd_' . $this->field_slug . '_roles' ) );
138		$options['use_value'] = sanitize_text_field( bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_use_value', false ) );
139		$options['meta_key'] = esc_sql( bd_array_get( $request, 'smbd_' . $this->field_slug . '_key', '' ) );
140		$options['meta_value'] = esc_sql( bd_array_get( $request, 'smbd_' . $this->field_slug . '_value', '' ) );
141
142		/**
143		* Delete user-meta delete options filter.
144		*
145		* This filter is for processing filtering options for deleting user meta.
146		*
147		* @since 5.4
148		*/
149		return apply_filters( 'bd_delete_user_meta_options', $options, $request );
150		}
151
152	5	protected function do_delete( $options ) {
153	5	$count = 0;
154	5	$meta_key = $options['meta_key'];
155	5	$use_value = $options['use_value'];
156	5	$limit_to = $options['limit_to'];
157
158		$args = array(
159	5	'role__in' => $options['selected_roles'],
160		);
161
162	5	if ( $limit_to > 0 ) {
163	1	$args['number'] = $limit_to;
164		}
165
166	5	if ( $use_value ) {
167		$meta_value = $options['meta_value'];
168		$args['meta_query'] = apply_filters( 'bd_delete_user_meta_query', array(), $options );
169	5	} else {
170		$args['meta_key'] = $meta_key;
171		}
172	5
173		$users = get_users( $args );
174	5
175	5	foreach ( $users as $user ) {
176	5	if ( $use_value ) {
177		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...
178		$count++;
179		}
180	5	} else {
181		if ( delete_user_meta( $user->ID, $meta_key ) ) {
182		$count++;
183		}
184		}
185		}
186
187		return $count;
188		}
189
190		public function filter_js_array( $js_array ) {
191		$js_array['dt_iterators'][] = '_' . $this->field_slug;
192		$js_array['validators']['delete_user_meta'] = 'noValidation';
193
194		$js_array['pre_action_msg']['delete_user_meta'] = 'deleteUMWarning';
195		$js_array['msg']['deleteUMWarning'] = __( 'Are you sure you want to delete all the user meta fields that match the selected filters?', 'bulk-delete' );
196
197		return $js_array;
198		}
199
200		protected function get_success_message( $items_deleted ) {
201		/* translators: 1 Number of posts deleted */
202		return _n( 'Deleted user meta field from %d user', 'Deleted user meta field from %d users', $items_deleted, 'bulk-delete' );
203		}
204		}
205

sudar / bulk-delete

Pull Request — dev/6.0.0 (#466)

DeleteUserMetaModule::initialize() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like