Passed
Pull Request — dev/6.0.0 (#492)
by Sudar
1347:59 queued 1343:31
created

DeleteUsersByUserRoleModule::get_success_message()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 1
dl 0
loc 3
ccs 0
cts 2
cp 0
crap 2
rs 10
c 0
b 0
f 0
1
<?php
2
3
namespace BulkWP\BulkDelete\Core\Users\Modules;
4
5
use BulkWP\BulkDelete\Core\Users\UsersModule;
6
7 1
defined( 'ABSPATH' ) || exit; // Exit if accessed directly.
8
9
/**
10
 * Bulk Delete Users by User Role Module.
11
 *
12
 * @since 5.5
13
 * @since 6.0.0 Renamed to DeleteUsersByUserRoleModule
14
 */
15
class DeleteUsersByUserRoleModule extends UsersModule {
16
	/**
17
	 * Initialize and setup variables.
18
	 *
19
	 * @since 5.5
20
	 */
21 4
	protected function initialize() {
22 4
		$this->item_type     = 'users';
23 4
		$this->field_slug    = 'u_role';
24 4
		$this->meta_box_slug = 'bd_users_by_role';
25 4
		$this->action        = 'delete_users_by_role';
26 4
		$this->cron_hook     = 'do-bulk-delete-users-by-role';
27 4
		$this->scheduler_url = 'https://bulkwp.com/addons/scheduler-for-deleting-users-by-role/?utm_source=wpadmin&utm_campaign=BulkDelete&utm_medium=buynow&utm_content=bd-u-ur';
28 4
		$this->messages      = array(
29 4
			'box_label'  => __( 'By User Role', 'bulk-delete' ),
30 4
			'scheduled'  => __( 'Users from the selected user role are scheduled for deletion.', 'bulk-delete' ),
31 4
			'cron_label' => __( 'Delete Users by User Role', 'bulk-delete' ),
32
		);
33 4
	}
34
35
	/**
36
	 * Render delete users box.
37
	 *
38
	 * @since 5.5
39
	 */
40
	public function render() {
41
		?>
42
		<h4><?php _e( 'Select the user roles from which you want to delete users', 'bulk-delete' ); ?></h4>
43
44
		<fieldset class="options">
45
			<table class="optiontable">
46
				<?php $this->render_user_role_dropdown(); ?>
47
			</table>
48
49
			<table class="optiontable">
50
				<?php
51
					$this->render_filtering_table_header();
52
					$this->render_user_login_restrict_settings();
53
					$this->render_user_with_no_posts_settings();
54
					$this->render_limit_settings();
55
					$this->render_cron_settings();
56
				?>
57
			</table>
58
		</fieldset>
59
		<?php
60
		$this->render_submit_button();
61
	}
62
63
	protected function convert_user_input_to_options( $request, $options ) {
64
		$options['selected_roles'] = bd_array_get( $request, 'smbd_' . $this->field_slug . '_roles', array() );
65
66
		return $options;
67
	}
68
69
	/**
70
	 * Build query params for WP_User_Query by using delete options.
71
	 *
72
	 * Return an empty query array to short-circuit deletion.
73
	 *
74
	 * @since 6.0.0
75
	 *
76
	 * @param array $options Delete options.
77
	 *
78
	 * @return array Query.
79
	 */
80 4
	protected function build_query( $options ) {
81
		$query = array(
82 4
			'role__in' => $options['selected_roles'],
83 4
			'number'   => $options['limit_to'],
84
		);
85
86 4
		$date_query = $this->get_date_query( $options );
87
88 4
		if ( ! empty( $date_query ) ) {
89 2
			$query['date_query'] = $date_query;
90
		}
91
92 4
		return $query;
93
	}
94
95
	/**
96
	 * Filter JS Array and add validation hooks.
97
	 *
98
	 * @since 5.5
99
	 *
100
	 * @param array $js_array JavaScript Array.
101
	 *
102
	 * @return array Modified JavaScript Array
103
	 */
104
	public function filter_js_array( $js_array ) {
105
		$js_array['dt_iterators'][]              = '_' . $this->field_slug;
106
		$js_array['validators'][ $this->action ] = 'validateUserRole';
107
108
		$js_array['pre_action_msg'][ $this->action ] = 'deleteUsersWarning';
109
		$js_array['msg']['deleteUsersWarning']       = __( 'Are you sure you want to delete all the users from the selected user role?', 'bulk-delete' );
110
111
		$js_array['error_msg'][ $this->action ] = 'selectOneUserRole';
112
		$js_array['msg']['selectOneUserRole']   = __( 'Select at least one user role from which users should be deleted', 'bulk-delete' );
113
114
		return $js_array;
115
	}
116
117
	protected function get_success_message( $items_deleted ) {
118
		/* translators: 1 Number of users deleted */
119
		return _n( 'Deleted %d user from the selected roles', 'Deleted %d users from the selected roles', $items_deleted, 'bulk-delete' );
120
	}
121
}
122