BaseModule::process() - Code Metrics - Inspection of "Change `Type` to `Action`" - sudar/bulk-delete - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — dev/6.0.0 (#277)

by Rajan

created 2018-04-26 02:42 UTC

BaseModule::process() A

↳ Parent: BaseModule

Complexity

Conditions	2
Paths	2

Size

Total Lines	18
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	2.0014

Importance

Changes

Metric	Value
cc	2
eloc	14
nc	2
nop	1
dl	0
loc	18
ccs	13
cts	14
cp	0.9286
crap	2.0014
rs	9.4285
c	0
b	0
f	0

<?php

namespace BulkWP\BulkDelete\Core\Base;

use BulkWP\BulkDelete\Core\Base\Mixin\Renderer;

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

/**
 * Encapsulates the Bulk Delete Meta box Module Logic.
 *
 * All Bulk Delete Meta box Modules should extend this class.
 * This class extends Renderer Mixin class since Bulk Delete still supports PHP 5.3.
 * Once PHP 5.3 support is dropped, Renderer will be implemented as a Trait and this class will `use` it.
 *
 * @since 6.0.0
 */
abstract class BaseModule extends Renderer {
	/**
	 * Item Type. Possible values 'posts', 'pages', 'users' etc.
	 *
	 * @var string
	 */
	protected $item_type;

	/**
	 * The hook suffix of the screen where this meta box would be shown.
	 *
	 * @var string
	 */
	protected $page_hook_suffix;

	/**
	 * Slug of the page where this module will be shown.
	 *
	 * @var string
	 */
	protected $page_slug;

	/**
	 * Slug for the form fields.
	 *
	 * @var string
	 */
	protected $field_slug;

	/**
	 * Slug of the meta box.
	 *
	 * @var string
	 */
	protected $meta_box_slug;

	/**
	 * Action in which the delete operation should be performed.
	 *
	 * @var string
	 */
	protected $action;

	/**
	 * Hook for scheduler.
	 *
	 * @var string
	 */
	protected $cron_hook;

	/**
	 * Url of the scheduler addon.
	 *
	 * @var string
	 */
	protected $scheduler_url;

	/**
	 * Messages shown to the user.
	 *
	 * @var array
	 */
	protected $messages = array(
		'box_label' => '',
	);

	/**
	 * Initialize and setup variables.
	 *
	 * @return void
	 */
	abstract protected function initialize();

	/**
	 * Render the Modules.
	 *
	 * @return void
	 */
	abstract public function render();

	/**
	 * Process user input and create metabox options.
	 *
	 * @param array $request Request array.
	 * @param array $options User options.
	 *
	 * @return array User options.
	 */
	abstract protected function convert_user_input_to_options( $request, $options );

	/**
	 * Perform the deletion.
	 *
	 * @param array $options Array of Delete options.
	 *
	 * @return int Number of items that were deleted.
	 */
	abstract public function delete( $options );

	/**
	 * Get Success Message.
	 *
	 * @param int $items_deleted Number of items that were deleted.
	 *
	 * @return string Success message.
	 */
	abstract protected function get_success_message( $items_deleted );

	abstract protected function get_cron_action_name();

	/**
	 * Create new instances of Modules.
	 */
	public function __construct() {
		$this->initialize();
	}

	/**
	 * Register.
	 *
	 * @param string $hook_suffix Page Hook Suffix.
	 * @param string $page_slug   Page slug.
	 */
	public function register( $hook_suffix, $page_slug ) {
		$this->page_hook_suffix = $hook_suffix;
		$this->page_slug        = $page_slug;

		add_action( "add_meta_boxes_{$this->page_hook_suffix}", array( $this, 'setup_metabox' ) );

		add_action( 'bd_' . $this->action, array( $this, 'process' ) );
		add_filter( 'bd_javascript_array', array( $this, 'filter_js_array' ) );
	}

	/**
	 * Setup the meta box.
	 */
	public function setup_metabox() {
		add_meta_box(
			$this->meta_box_slug,
			$this->messages['box_label'],
			array( $this, 'render_box' ),
			$this->page_hook_suffix,
			'advanced'
		);
	}

	/**
	 * Render the meta box.
	 */
	public function render_box() {
		if ( $this->is_hidden() ) {
			printf(
				/* translators: 1 module url */
				__( 'This section just got enabled. Kindly <a href = "%1$s">refresh</a> the page to fully enable it.', 'bulk-delete' ),
				'admin.php?page=' . $this->page_slug
			);

			return;
		}

		$this->render();
	}

	/**
	 * Is the current meta box hidden by user.
	 *
	 * @return bool True, if hidden. False, otherwise.
	 */
	protected function is_hidden() {
		$current_user    = wp_get_current_user();
		$user_meta_field = $this->get_hidden_box_user_meta_field();
		$hidden_boxes    = get_user_meta( $current_user->ID, $user_meta_field, true );

		return is_array( $hidden_boxes ) && in_array( $this->meta_box_slug, $hidden_boxes, true );
	}

	/**
	 * Get the user meta field that stores the status of the hidden meta boxes.
	 *
	 * @return string Name of the User Meta field.
	 */
	protected function get_hidden_box_user_meta_field() {
		if ( 'posts' === $this->item_type ) {
			return 'metaboxhidden_toplevel_page_bulk-delete-posts';
		} else {
			return 'metaboxhidden_bulk-wp_page_' . $this->page_slug;
		}
	}

	/**
	 * Filter the js array.
	 *
	 * This function will be overridden by the child classes.
	 *
	 * @param array $js_array JavaScript Array.
	 *
	 * @return array Modified JavaScript Array
	 */
	public function filter_js_array( $js_array ) {
		return $js_array;
	}

	/**
	 * Render filtering table header.
	 */
	protected function render_filtering_table_header() {
		bd_render_filtering_table_header();
	}

	/**
	 * Render restrict settings.
	 */
	protected function render_restrict_settings() {
		bd_render_restrict_settings( $this->field_slug, $this->item_type );
	}

	/**
	 * Render delete settings.
	 */
	protected function render_delete_settings() {
		bd_render_delete_settings( $this->field_slug );
	}

	/**
	 * Render limit settings.
	 */
	protected function render_limit_settings() {
		bd_render_limit_settings( $this->field_slug, $this->item_type );
	}

	/**
	 * Render cron settings.
	 */
	protected function render_cron_settings() {
		bd_render_cron_settings( $this->field_slug, $this->scheduler_url );
	}

	/**
	 * Render submit button.
	 */
	protected function render_submit_button() {
		bd_render_submit_button( $this->action );
	}

	/**
	 * Helper function for processing deletion.
	 * Setups up cron and invokes the actual delete method.
	 *
	 * @param array $request Request array.
	 */
	public function process( $request ) {
		$options              = $this->parse_common_filters( $request );
		$options              = $this->convert_user_input_to_options( $request, $options );
		$options['cron_name'] = $this->get_cron_action_name();
		$cron_options         = $this->parse_cron_filters( $request );

		if ( $this->is_scheduled( $cron_options ) ) {
			$msg = $this->schedule_deletion( $cron_options, $options );
		} else {
			$items_deleted = $this->delete( $options );
			$msg           = sprintf( $this->get_success_message( $items_deleted ), $items_deleted );
		}

		add_settings_error(
			$this->page_slug,
			$this->action,
			$msg,
			'updated'
		);
	}

	/**
	 * Getter for cron_hook.
	 *
	 * @return string Cron Hook name.
	 */
	public function get_cron_hook() {
		return $this->cron_hook;
	}

	/**
	 * Getter for field slug.
	 *
	 * @return string Field Slug.
	 */
	public function get_field_slug() {
		return $this->field_slug;
	}

	/**
	 * Getter for action.
	 *
	 * @return string Modules action.
	 */
	public function get_action() {
		return $this->action;
	}

	/**
	 * Is the current deletion request a scheduled request?
	 *
	 * @param array $cron_options Request object.
	 *
	 * @return bool True if it is a scheduled request, False otherwise.
	 */
	protected function is_scheduled( $cron_options ) {
		return $cron_options['is_scheduled'];
	}

	/**
	 * Schedule Deletion of items.
	 *
	 * @param array $cron_options Cron options.
	 * @param array $options      Deletion option.
	 *
	 * @return string Message.
	 */
	protected function schedule_deletion( $cron_options, $options ) {
		if ( '-1' === $cron_options['frequency'] ) {
			wp_schedule_single_event( $cron_options['start_time'], $this->cron_hook, array( $options ) );
		} else {
			wp_schedule_event( $cron_options['start_time'], $cron_options['frequency'], $this->cron_hook, array( $options ) );
		}

		return $this->messages['scheduled'] . ' ' . $this->get_task_list_link();
	}

	/**
	 * Get the link to the page that lists all the scheduled tasks.
	 *
	 * @return string Link to scheduled tasks page.
	 */
	protected function get_task_list_link() {
		return sprintf(
			__( 'See the full list of <a href = "%s">scheduled tasks</a>', 'bulk-delete' ),
			get_bloginfo( 'wpurl' ) . '/wp-admin/admin.php?page=' . \Bulk_Delete::CRON_PAGE_SLUG
		);
	}

	/**
	 * Handle common filters.
	 *
	 * @param array $request Request array.
	 *
	 * @return array User options.
	 */
	protected function parse_common_filters( $request ) {
		$options = array();

		$options['restrict']     = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_restrict', false );
		$options['limit_to']     = absint( bd_array_get( $request, 'smbd_' . $this->field_slug . '_limit_to', 0 ) );
		$options['force_delete'] = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_force_delete', false );

		$options['date_op'] = bd_array_get( $request, 'smbd_' . $this->field_slug . '_op' );
		$options['days']    = absint( bd_array_get( $request, 'smbd_' . $this->field_slug . '_days' ) );

		return $options;
	}

	/**
	 * Parse request and create cron options.
	 *
	 * @param array $request Request array.
	 *
	 * @return array Parsed cron option.
	 */
	protected function parse_cron_filters( $request ) {
		$cron_options = array(
			'is_scheduled' => false,
		);

		$scheduled = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_cron', false );

		if ( $scheduled ) {
			$cron_options['is_scheduled'] = true;
			$cron_options['frequency']    = sanitize_text_field( $request[ 'smbd_' . $this->field_slug . '_cron_freq' ] );
			$cron_options['start_time']   = bd_get_gmt_offseted_time( sanitize_text_field( $request[ 'smbd_' . $this->field_slug . '_cron_start' ] ) );
		}

		return $cron_options;
	}

	/**
	 * Get the threshold after which enhanced select should be used.
	 *
	 * @return int Threshold.
	 */
	protected function get_enhanced_select_threshold() {
		/**
		 * Filter the enhanced select threshold.
		 *
		 * @since 6.0.0
		 *
		 * @param int Threshold.
		 */
		return apply_filters( 'bd_enhanced_select_threshold', 1000 );
	}

	/**
	 * Get the class name for select2 dropdown based on the number of items present.
	 *
	 * @param int    $count      The number of items present.
	 * @param string $class_name Primary class name.
	 *
	 * @return string Class name.
	 */
	protected function enable_ajax_if_needed_to_dropdown_class_name( $count, $class_name ) {
		if ( $count >= $this->get_enhanced_select_threshold() ) {
			$class_name .= '-ajax';
		}

		return $class_name;
	}
}


1		<?php
2
3		namespace BulkWP\BulkDelete\Core\Base;
4
5		use BulkWP\BulkDelete\Core\Base\Mixin\Renderer;
6
7	1	defined( 'ABSPATH' ) \|\| exit; // Exit if accessed directly.
8
9		/**
10		* Encapsulates the Bulk Delete Meta box Module Logic.
11		*
12		* All Bulk Delete Meta box Modules should extend this class.
13		* This class extends Renderer Mixin class since Bulk Delete still supports PHP 5.3.
14		* Once PHP 5.3 support is dropped, Renderer will be implemented as a Trait and this class will `use` it.
15		*
16		* @since 6.0.0
17		*/
18		abstract class BaseModule extends Renderer {
19		/**
20		* Item Type. Possible values 'posts', 'pages', 'users' etc.
21		*
22		* @var string
23		*/
24		protected $item_type;
25
26		/**
27		* The hook suffix of the screen where this meta box would be shown.
28		*
29		* @var string
30		*/
31		protected $page_hook_suffix;
32
33		/**
34		* Slug of the page where this module will be shown.
35		*
36		* @var string
37		*/
38		protected $page_slug;
39
40		/**
41		* Slug for the form fields.
42		*
43		* @var string
44		*/
45		protected $field_slug;
46
47		/**
48		* Slug of the meta box.
49		*
50		* @var string
51		*/
52		protected $meta_box_slug;
53
54		/**
55		* Action in which the delete operation should be performed.
56		*
57		* @var string
58		*/
59		protected $action;
60
61		/**
62		* Hook for scheduler.
63		*
64		* @var string
65		*/
66		protected $cron_hook;
67
68		/**
69		* Url of the scheduler addon.
70		*
71		* @var string
72		*/
73		protected $scheduler_url;
74
75		/**
76		* Messages shown to the user.
77		*
78		* @var array
79		*/
80		protected $messages = array(
81		'box_label' => '',
82		);
83
84		/**
85		* Initialize and setup variables.
86		*
87		* @return void
88		*/
89		abstract protected function initialize();
90
91		/**
92		* Render the Modules.
93		*
94		* @return void
95		*/
96		abstract public function render();
97
98		/**
99		* Process user input and create metabox options.
100		*
101		* @param array $request Request array.
102		* @param array $options User options.
103		*
104		* @return array User options.
105		*/
106		abstract protected function convert_user_input_to_options( $request, $options );
107
108		/**
109		* Perform the deletion.
110		*
111		* @param array $options Array of Delete options.
112		*
113		* @return int Number of items that were deleted.
114		*/
115		abstract public function delete( $options );
116
117		/**
118		* Get Success Message.
119		*
120		* @param int $items_deleted Number of items that were deleted.
121		*
122		* @return string Success message.
123		*/
124		abstract protected function get_success_message( $items_deleted );
125
126		abstract protected function get_cron_action_name();
127
128		/**
129		* Create new instances of Modules.
130		*/
131	103	public function __construct() {
132	103	$this->initialize();
133	103	}
134
135		/**
136		* Register.
137		*
138		* @param string $hook_suffix Page Hook Suffix.
139		* @param string $page_slug Page slug.
140		*/
141		public function register( $hook_suffix, $page_slug ) {
142		$this->page_hook_suffix = $hook_suffix;
143		$this->page_slug = $page_slug;
144
145		add_action( "add_meta_boxes_{$this->page_hook_suffix}", array( $this, 'setup_metabox' ) );
146
147		add_action( 'bd_' . $this->action, array( $this, 'process' ) );
148		add_filter( 'bd_javascript_array', array( $this, 'filter_js_array' ) );
149		}
150
151		/**
152		* Setup the meta box.
153		*/
154		public function setup_metabox() {
155		add_meta_box(
156		$this->meta_box_slug,
157		$this->messages['box_label'],
158		array( $this, 'render_box' ),
159		$this->page_hook_suffix,
160		'advanced'
161		);
162		}
163
164		/**
165		* Render the meta box.
166		*/
167	1	public function render_box() {
168	1	if ( $this->is_hidden() ) {
169		printf(
170		/* translators: 1 module url */
171		__( 'This section just got enabled. Kindly <a href = "%1$s">refresh</a> the page to fully enable it.', 'bulk-delete' ),
172		'admin.php?page=' . $this->page_slug
173		);
174
175		return;
176		}
177
178	1	$this->render();
179	1	}
180
181		/**
182		* Is the current meta box hidden by user.
183		*
184		* @return bool True, if hidden. False, otherwise.
185		*/
186	1	protected function is_hidden() {
187	1	$current_user = wp_get_current_user();
188	1	$user_meta_field = $this->get_hidden_box_user_meta_field();
189	1	$hidden_boxes = get_user_meta( $current_user->ID, $user_meta_field, true );
190
191	1	return is_array( $hidden_boxes ) && in_array( $this->meta_box_slug, $hidden_boxes, true );
192		}
193
194		/**
195		* Get the user meta field that stores the status of the hidden meta boxes.
196		*
197		* @return string Name of the User Meta field.
198		*/
199	1	protected function get_hidden_box_user_meta_field() {
200	1	if ( 'posts' === $this->item_type ) {
201		return 'metaboxhidden_toplevel_page_bulk-delete-posts';
202		} else {
203	1	return 'metaboxhidden_bulk-wp_page_' . $this->page_slug;
204		}
205		}
206
207		/**
208		* Filter the js array.
209		*
210		* This function will be overridden by the child classes.
211		*
212		* @param array $js_array JavaScript Array.
213		*
214		* @return array Modified JavaScript Array
215		*/
216		public function filter_js_array( $js_array ) {
217		return $js_array;
218		}
219
220		/**
221		* Render filtering table header.
222		*/
223		protected function render_filtering_table_header() {
224		bd_render_filtering_table_header();
225		}
226
227		/**
228		* Render restrict settings.
229		*/
230		protected function render_restrict_settings() {
231		bd_render_restrict_settings( $this->field_slug, $this->item_type );
232		}
233
234		/**
235		* Render delete settings.
236		*/
237		protected function render_delete_settings() {
238		bd_render_delete_settings( $this->field_slug );
239		}
240
241		/**
242		* Render limit settings.
243		*/
244		protected function render_limit_settings() {
245		bd_render_limit_settings( $this->field_slug, $this->item_type );
246		}
247
248		/**
249		* Render cron settings.
250		*/
251		protected function render_cron_settings() {
252		bd_render_cron_settings( $this->field_slug, $this->scheduler_url );
253		}
254
255		/**
256		* Render submit button.
257		*/
258		protected function render_submit_button() {
259		bd_render_submit_button( $this->action );
260		}
261
262		/**
263		* Helper function for processing deletion.
264		* Setups up cron and invokes the actual delete method.
265		*
266		* @param array $request Request array.
267		*/
268	1	public function process( $request ) {
269	1	$options = $this->parse_common_filters( $request );
270	1	$options = $this->convert_user_input_to_options( $request, $options );
271	1	$options['cron_name'] = $this->get_cron_action_name();
272	1	$cron_options = $this->parse_cron_filters( $request );
273
274	1	if ( $this->is_scheduled( $cron_options ) ) {
275		$msg = $this->schedule_deletion( $cron_options, $options );
276		} else {
277	1	$items_deleted = $this->delete( $options );
278	1	$msg = sprintf( $this->get_success_message( $items_deleted ), $items_deleted );
279		}
280
281	1	add_settings_error(
282	1	$this->page_slug,
283	1	$this->action,
284	1	$msg,
285	1	'updated'
286		);
287	1	}
288
289		/**
290		* Getter for cron_hook.
291		*
292		* @return string Cron Hook name.
293		*/
294		public function get_cron_hook() {
295		return $this->cron_hook;
296		}
297
298		/**
299		* Getter for field slug.
300		*
301		* @return string Field Slug.
302		*/
303		public function get_field_slug() {
304		return $this->field_slug;
305		}
306
307		/**
308		* Getter for action.
309		*
310		* @return string Modules action.
311		*/
312	36	public function get_action() {
313	36	return $this->action;
314		}
315
316		/**
317		* Is the current deletion request a scheduled request?
318		*
319		* @param array $cron_options Request object.
320		*
321		* @return bool True if it is a scheduled request, False otherwise.
322		*/
323	3	protected function is_scheduled( $cron_options ) {
324	3	return $cron_options['is_scheduled'];
325		}
326
327		/**
328		* Schedule Deletion of items.
329		*
330		* @param array $cron_options Cron options.
331		* @param array $options Deletion option.
332		*
333		* @return string Message.
334		*/
335	32	protected function schedule_deletion( $cron_options, $options ) {
336	32	if ( '-1' === $cron_options['frequency'] ) {
337	8	wp_schedule_single_event( $cron_options['start_time'], $this->cron_hook, array( $options ) );
338		} else {
339	24	wp_schedule_event( $cron_options['start_time'], $cron_options['frequency'], $this->cron_hook, array( $options ) );
340		}
341
342	32	return $this->messages['scheduled'] . ' ' . $this->get_task_list_link();
343		}
344
345		/**
346		* Get the link to the page that lists all the scheduled tasks.
347		*
348		* @return string Link to scheduled tasks page.
349		*/
350	32	protected function get_task_list_link() {
351	32	return sprintf(
352	32	__( 'See the full list of <a href = "%s">scheduled tasks</a>', 'bulk-delete' ),
353	32	get_bloginfo( 'wpurl' ) . '/wp-admin/admin.php?page=' . \Bulk_Delete::CRON_PAGE_SLUG
354		);
355		}
356
357		/**
358		* Handle common filters.
359		*
360		* @param array $request Request array.
361		*
362		* @return array User options.
363		*/
364	1	protected function parse_common_filters( $request ) {
365	1	$options = array();
366
367	1	$options['restrict'] = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_restrict', false );
368	1	$options['limit_to'] = absint( bd_array_get( $request, 'smbd_' . $this->field_slug . '_limit_to', 0 ) );
369	1	$options['force_delete'] = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_force_delete', false );
370
371	1	$options['date_op'] = bd_array_get( $request, 'smbd_' . $this->field_slug . '_op' );
372	1	$options['days'] = absint( bd_array_get( $request, 'smbd_' . $this->field_slug . '_days' ) );
373
374	1	return $options;
375		}
376
377		/**
378		* Parse request and create cron options.
379		*
380		* @param array $request Request array.
381		*
382		* @return array Parsed cron option.
383		*/
384	31	protected function parse_cron_filters( $request ) {
385		$cron_options = array(
386	31	'is_scheduled' => false,
387		);
388
389	31	$scheduled = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_cron', false );
390
391	31	if ( $scheduled ) {
392	28	$cron_options['is_scheduled'] = true;
393	28	$cron_options['frequency'] = sanitize_text_field( $request[ 'smbd_' . $this->field_slug . '_cron_freq' ] );
394	28	$cron_options['start_time'] = bd_get_gmt_offseted_time( sanitize_text_field( $request[ 'smbd_' . $this->field_slug . '_cron_start' ] ) );
395		}
396
397	31	return $cron_options;
398		}
399
400		/**
401		* Get the threshold after which enhanced select should be used.
402		*
403		* @return int Threshold.
404		*/
405		protected function get_enhanced_select_threshold() {
406		/**
407		* Filter the enhanced select threshold.
408		*
409		* @since 6.0.0
410		*
411		* @param int Threshold.
412		*/
413		return apply_filters( 'bd_enhanced_select_threshold', 1000 );
414		}
415
416		/**
417		* Get the class name for select2 dropdown based on the number of items present.
418		*
419		* @param int $count The number of items present.
420		* @param string $class_name Primary class name.
421		*
422		* @return string Class name.
423		*/
424		protected function enable_ajax_if_needed_to_dropdown_class_name( $count, $class_name ) {
425		if ( $count >= $this->get_enhanced_select_threshold() ) {
426		$class_name .= '-ajax';
427		}
428
429		return $class_name;
430		}
431		}
432

sudar / bulk-delete

Pull Request — dev/6.0.0 (#277)

BaseModule::process() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like