BaseModule::render_delete_settings() - Code Metrics - Inspection of "Merge branch 'dev/6.0.0' into 220-add-custom-post-..." - sudar/bulk-delete - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 220-add-custom-post-status ( 2f682e...9beb73 )

by Sudar

created 2018-05-04 07:48 UTC

BaseModule::render_delete_settings() A

↳ Parent: BaseModule

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	2
rs	10
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'  => '',
		'cron_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 );

	/**
	 * 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 );
		$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' ] ) );

			$cron_options['cron_label'] = $this->get_cron_label();
		}

		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;
	}

	/**
	 * Get the human readable label for the Schedule job.
	 *
	 * @return string Human readable label for schedule job.
	 */
	protected function get_cron_label() {
		return $this->messages['cron_label'];
	}
}


1			<?php
2
3			namespace BulkWP\BulkDelete\Core\Base;
4
5			use BulkWP\BulkDelete\Core\Base\Mixin\Renderer;
6
7			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			'cron_label' => '',
83			);
84
85			/**
86			* Initialize and setup variables.
87			*
88			* @return void
89			*/
90			abstract protected function initialize();
91
92			/**
93			* Render the Modules.
94			*
95			* @return void
96			*/
97			abstract public function render();
98
99			/**
100			* Process user input and create metabox options.
101			*
102			* @param array $request Request array.
103			* @param array $options User options.
104			*
105			* @return array User options.
106			*/
107			abstract protected function convert_user_input_to_options( $request, $options );
108
109			/**
110			* Perform the deletion.
111			*
112			* @param array $options Array of Delete options.
113			*
114			* @return int Number of items that were deleted.
115			*/
116			abstract public function delete( $options );
117
118			/**
119			* Get Success Message.
120			*
121			* @param int $items_deleted Number of items that were deleted.
122			*
123			* @return string Success message.
124			*/
125			abstract protected function get_success_message( $items_deleted );
126
127			/**
128			* Create new instances of Modules.
129			*/
130			public function __construct() {
131			$this->initialize();
132			}
133
134			/**
135			* Register.
136			*
137			* @param string $hook_suffix Page Hook Suffix.
138			* @param string $page_slug Page slug.
139			*/
140			public function register( $hook_suffix, $page_slug ) {
141			$this->page_hook_suffix = $hook_suffix;
142			$this->page_slug = $page_slug;
143
144			add_action( "add_meta_boxes_{$this->page_hook_suffix}", array( $this, 'setup_metabox' ) );
145
146			add_action( 'bd_' . $this->action, array( $this, 'process' ) );
147			add_filter( 'bd_javascript_array', array( $this, 'filter_js_array' ) );
148			}
149
150			/**
151			* Setup the meta box.
152			*/
153			public function setup_metabox() {
154			add_meta_box(
155			$this->meta_box_slug,
156			$this->messages['box_label'],
157			array( $this, 'render_box' ),
158			$this->page_hook_suffix,
159			'advanced'
160			);
161			}
162
163			/**
164			* Render the meta box.
165			*/
166			public function render_box() {
167			if ( $this->is_hidden() ) {
168			printf(
169			/* translators: 1 module url */
170			__( 'This section just got enabled. Kindly <a href = "%1$s">refresh</a> the page to fully enable it.', 'bulk-delete' ),
171			'admin.php?page=' . $this->page_slug
172			);
173
174			return;
175			}
176
177			$this->render();
178			}
179
180			/**
181			* Is the current meta box hidden by user.
182			*
183			* @return bool True, if hidden. False, otherwise.
184			*/
185			protected function is_hidden() {
186			$current_user = wp_get_current_user();
187			$user_meta_field = $this->get_hidden_box_user_meta_field();
188			$hidden_boxes = get_user_meta( $current_user->ID, $user_meta_field, true );
189
190			return is_array( $hidden_boxes ) && in_array( $this->meta_box_slug, $hidden_boxes, true );
191			}
192
193			/**
194			* Get the user meta field that stores the status of the hidden meta boxes.
195			*
196			* @return string Name of the User Meta field.
197			*/
198			protected function get_hidden_box_user_meta_field() {
199			if ( 'posts' === $this->item_type ) {
200			return 'metaboxhidden_toplevel_page_bulk-delete-posts';
201			} else {
202			return 'metaboxhidden_bulk-wp_page_' . $this->page_slug;
203			}
204			}
205
206			/**
207			* Filter the js array.
208			*
209			* This function will be overridden by the child classes.
210			*
211			* @param array $js_array JavaScript Array.
212			*
213			* @return array Modified JavaScript Array
214			*/
215			public function filter_js_array( $js_array ) {
216			return $js_array;
217			}
218
219			/**
220			* Render filtering table header.
221			*/
222			protected function render_filtering_table_header() {
223			bd_render_filtering_table_header();
224			}
225
226			/**
227			* Render restrict settings.
228			*/
229			protected function render_restrict_settings() {
230			bd_render_restrict_settings( $this->field_slug, $this->item_type );
231			}
232
233			/**
234			* Render delete settings.
235			*/
236			protected function render_delete_settings() {
237			bd_render_delete_settings( $this->field_slug );
238			}
239
240			/**
241			* Render limit settings.
242			*/
243			protected function render_limit_settings() {
244			bd_render_limit_settings( $this->field_slug, $this->item_type );
245			}
246
247			/**
248			* Render cron settings.
249			*/
250			protected function render_cron_settings() {
251			bd_render_cron_settings( $this->field_slug, $this->scheduler_url );
252			}
253
254			/**
255			* Render submit button.
256			*/
257			protected function render_submit_button() {
258			bd_render_submit_button( $this->action );
259			}
260
261			/**
262			* Helper function for processing deletion.
263			* Setups up cron and invokes the actual delete method.
264			*
265			* @param array $request Request array.
266			*/
267			public function process( $request ) {
268			$options = $this->parse_common_filters( $request );
269			$options = $this->convert_user_input_to_options( $request, $options );
270			$cron_options = $this->parse_cron_filters( $request );
271
272			if ( $this->is_scheduled( $cron_options ) ) {
273			$msg = $this->schedule_deletion( $cron_options, $options );
274			} else {
275			$items_deleted = $this->delete( $options );
276			$msg = sprintf( $this->get_success_message( $items_deleted ), $items_deleted );
277			}
278
279			add_settings_error(
280			$this->page_slug,
281			$this->action,
282			$msg,
283			'updated'
284			);
285			}
286
287			/**
288			* Getter for cron_hook.
289			*
290			* @return string Cron Hook name.
291			*/
292			public function get_cron_hook() {
293			return $this->cron_hook;
294			}
295
296			/**
297			* Getter for field slug.
298			*
299			* @return string Field Slug.
300			*/
301			public function get_field_slug() {
302			return $this->field_slug;
303			}
304
305			/**
306			* Getter for action.
307			*
308			* @return string Modules action.
309			*/
310			public function get_action() {
311			return $this->action;
312			}
313
314			/**
315			* Is the current deletion request a scheduled request?
316			*
317			* @param array $cron_options Request object.
318			*
319			* @return bool True if it is a scheduled request, False otherwise.
320			*/
321			protected function is_scheduled( $cron_options ) {
322			return $cron_options['is_scheduled'];
323			}
324
325			/**
326			* Schedule Deletion of items.
327			*
328			* @param array $cron_options Cron options.
329			* @param array $options Deletion option.
330			*
331			* @return string Message.
332			*/
333			protected function schedule_deletion( $cron_options, $options ) {
334			if ( '-1' === $cron_options['frequency'] ) {
335			wp_schedule_single_event( $cron_options['start_time'], $this->cron_hook, array( $options ) );
336			} else {
337			wp_schedule_event( $cron_options['start_time'], $cron_options['frequency'], $this->cron_hook, array( $options ) );
338			}
339
340			return $this->messages['scheduled'] . ' ' . $this->get_task_list_link();
341			}
342
343			/**
344			* Get the link to the page that lists all the scheduled tasks.
345			*
346			* @return string Link to scheduled tasks page.
347			*/
348			protected function get_task_list_link() {
349			return sprintf(
350			__( 'See the full list of <a href = "%s">scheduled tasks</a>', 'bulk-delete' ),
351			get_bloginfo( 'wpurl' ) . '/wp-admin/admin.php?page=' . \Bulk_Delete::CRON_PAGE_SLUG
352			);
353			}
354
355			/**
356			* Handle common filters.
357			*
358			* @param array $request Request array.
359			*
360			* @return array User options.
361			*/
362			protected function parse_common_filters( $request ) {
363			$options = array();
364
365			$options['restrict'] = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_restrict', false );
366			$options['limit_to'] = absint( bd_array_get( $request, 'smbd_' . $this->field_slug . '_limit_to', 0 ) );
367			$options['force_delete'] = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_force_delete', false );
368
369			$options['date_op'] = bd_array_get( $request, 'smbd_' . $this->field_slug . '_op' );
370			$options['days'] = absint( bd_array_get( $request, 'smbd_' . $this->field_slug . '_days' ) );
371
372			return $options;
373			}
374
375			/**
376			* Parse request and create cron options.
377			*
378			* @param array $request Request array.
379			*
380			* @return array Parsed cron option.
381			*/
382			protected function parse_cron_filters( $request ) {
383			$cron_options = array(
384			'is_scheduled' => false,
385			);
386
387			$scheduled = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_cron', false );
388
389			if ( $scheduled ) {
390			$cron_options['is_scheduled'] = true;
391			$cron_options['frequency'] = sanitize_text_field( $request[ 'smbd_' . $this->field_slug . '_cron_freq' ] );
392			$cron_options['start_time'] = bd_get_gmt_offseted_time( sanitize_text_field( $request[ 'smbd_' . $this->field_slug . '_cron_start' ] ) );
393
394			$cron_options['cron_label'] = $this->get_cron_label();
395			}
396
397			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			/**
433			* Get the human readable label for the Schedule job.
434			*
435			* @return string Human readable label for schedule job.
436			*/
437			protected function get_cron_label() {
438			return $this->messages['cron_label'];
439			}
440			}
441

sudar / bulk-delete

Push — 220-add-custom-post-status ( 2f682e...9beb73 )

BaseModule::render_delete_settings() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like