BD_Meta_Box_Module::process_delete() - Code Metrics - Inspection of "Merge branch 'dev/6.0.0' into 312-fix/delete-post-..." - sudar/bulk-delete - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 312-fix/delete-post-meta-modul... ( fbbe37...602413 )

by Sudar

created 2018-05-24 05:16 UTC

BD_Meta_Box_Module::process_delete() A

↳ Parent: BD_Meta_Box_Module

Complexity

Conditions	3
Paths	3

Size

Total Lines	23
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	3
Bugs	2	Features	0

Metric	Value
cc	3
eloc	17
nc	3
nop	1
dl	0
loc	23
ccs	0
cts	20
cp	0
crap	12
rs	9.0856
c	3
b	2
f	0

<?php
/**
 * Base class for a Bulk Delete Meta Box Module.
 *
 * @since 5.5
 *
 * @author Sudar
 *
 * @package BulkDelete\Base
 */
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.
 *
 * @since 5.5
 * @abstract
 */
abstract class BD_Meta_Box_Module {
	/**
	 * @var string Item Type. Possible values 'posts', 'pages', 'users' etc.
	 */
	protected $item_type = 'posts';

	/**
	 * @var string The screen where this meta box would be shown.
	 */
	protected $screen;

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

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

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

	/**
	 * @var string Hook in which this meta box should be shown.
	 */
	protected $meta_box_hook;

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

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

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

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

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

	/**
	 * Initialize and setup variables.
	 *
	 * @since 5.5
	 * @abstract
	 *
	 * @return void
	 */
	abstract public function render();

	/**
	 * Process the deletion.
	 *
	 * @since 5.5
	 * @abstract
	 *
	 * @return void
	 */
	abstract public function process();

	/**
	 * Perform the deletion.
	 *
	 * @since 5.5
	 * @abstract
	 *
	 * @param mixed $delete_options
	 *
	 * @return int Number of users deleted
	 */
	abstract public function delete( $delete_options );

	/**
	 * Use `factory()` method to create instance of this class.
	 * Don't create instances directly.
	 *
	 * @since 5.5
	 * @see factory()
	 */
	public function __construct() {
		$this->setup();
	}

	/**
	 * Setup the module.
	 *
	 * @since 5.5
	 */
	protected function setup() {
		$this->initialize();
		$this->setup_hooks();
	}

	/**
	 * Setup hooks.
	 *
	 * @since 5.5
	 */
	protected function setup_hooks() {
		add_action( $this->meta_box_hook, array( $this, 'setup_metabox' ), 10, 2 );
		add_action( 'bd_' . $this->delete_action, array( $this, 'process' ) );
		add_filter( 'bd_javascript_array', array( $this, 'filter_js_array' ) );
	}

	/**
	 * Setup the meta box.
	 *
	 * @since 5.5
	 *
	 * @param mixed $screen
	 * @param mixed $page_slug
	 */
	public function setup_metabox( $screen, $page_slug ) {
		$this->screen    = $screen;
		$this->page_slug = $page_slug;

		add_meta_box( $this->meta_box_slug, $this->messages['box_label'], array( $this, 'render_box' ), $this->screen, 'advanced' );
	}

	/**
	 * Render the meta box.
	 *
	 * @since 5.5
	 */
	public function render_box() {
		if ( $this->is_hidden() ) {
			printf( __( '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.
	 *
	 * @since 5.5
	 *
	 * @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 );
	}

	/**
	 * Get the user meta field that stores the status of the hidden meta boxes.
	 *
	 * @since 5.5
	 *
	 * @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.
	 *
	 * @since 5.5
	 *
	 * @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.
	 *
	 * @since 5.5
	 */
	protected function render_filtering_table_header() {
		bd_render_filtering_table_header();
	}

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

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

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

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

	/**
	 * Render submit button.
	 *
	 * @since 5.5
	 */
	protected function render_submit_button() {
		bd_render_submit_button( $this->delete_action );
	}

	/**
	 * Helper function for processing deletion.
	 * Setups up cron and invokes the actual delete method.
	 *
	 * @since 5.5
	 *
	 * @param mixed $delete_options
	 */
	protected function process_delete( $delete_options ) {
		if ( bd_array_get_bool( $_POST, 'smbd_' . $this->field_slug . '_cron', false ) ) {
			$freq = $_POST[ 'smbd_' . $this->field_slug . '_cron_freq' ];
			$time = strtotime( $_POST[ 'smbd_' . $this->field_slug . '_cron_start' ] ) - ( get_option( 'gmt_offset' ) * 60 * 60 );

			if ( -1 == $freq ) {
				wp_schedule_single_event( $time, $this->cron_hook, array( $delete_options ) );
			} else {
				wp_schedule_event( $time, $freq , $this->cron_hook, array( $delete_options ) );
			}

			$msg = $this->messages['scheduled'] . ' ' .
				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 );
		} else {
			$deleted_count = $this->delete( $delete_options );
			$msg           = sprintf( _n( $this->messages['deleted_single'], $this->messages['deleted_plural'] , $deleted_count, 'bulk-delete' ), $deleted_count );
		}

		add_settings_error(
			$this->page_slug,
			'deleted-' . $this->item_type,
			$msg,
			'updated'
		);
	}

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

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


1			<?php
2			/**
3			* Base class for a Bulk Delete Meta Box Module.
4			*
5			* @since 5.5
6			*
7			* @author Sudar
8			*
9			* @package BulkDelete\Base
10			*/
11			defined( 'ABSPATH' ) \|\| exit; // Exit if accessed directly
12
13			/**
14			* Encapsulates the Bulk Delete Meta box Module Logic.
15			* All Bulk Delete Meta box Modules should extend this class.
16			*
17			* @since 5.5
18			* @abstract
19			*/
20			abstract class BD_Meta_Box_Module {
21			/**
22			* @var string Item Type. Possible values 'posts', 'pages', 'users' etc.
23			*/
24			protected $item_type = 'posts';
25
26			/**
27			* @var string The screen where this meta box would be shown.
28			*/
29			protected $screen;
30
31			/**
32			* @var string Slug of the page where this module will be shown.
33			*/
34			protected $page_slug;
35
36			/**
37			* @var string Slug for the form fields.
38			*/
39			protected $field_slug;
40
41			/**
42			* @var string Slug of the meta box.
43			*/
44			protected $meta_box_slug;
45
46			/**
47			* @var string Hook in which this meta box should be shown.
48			*/
49			protected $meta_box_hook;
50
51			/**
52			* @var string Action in which the delete operation should be performed.
53			*/
54			protected $delete_action;
55
56			/**
57			* @var string Hook for scheduler.
58			*/
59			protected $cron_hook;
60
61			/**
62			* @var string Url of the scheduler addon.
63			*/
64			protected $scheduler_url;
65
66			/**
67			* @var array Messages shown to the user.
68			*/
69			protected $messages = array();
70
71			/**
72			* Initialize and setup variables.
73			*
74			* @since 5.5
75			* @abstract
76			*
77			* @return void
78			*/
79			abstract protected function initialize();
80
81			/**
82			* Initialize and setup variables.
83			*
84			* @since 5.5
85			* @abstract
86			*
87			* @return void
88			*/
89			abstract public function render();
90
91			/**
92			* Process the deletion.
93			*
94			* @since 5.5
95			* @abstract
96			*
97			* @return void
98			*/
99			abstract public function process();
100
101			/**
102			* Perform the deletion.
103			*
104			* @since 5.5
105			* @abstract
106			*
107			* @param mixed $delete_options
108			*
109			* @return int Number of users deleted
110			*/
111			abstract public function delete( $delete_options );
112
113			/**
114			* Use `factory()` method to create instance of this class.
115			* Don't create instances directly.
116			*
117			* @since 5.5
118			* @see factory()
119			*/
120			public function __construct() {
121			$this->setup();
122			}
123
124			/**
125			* Setup the module.
126			*
127			* @since 5.5
128			*/
129			protected function setup() {
130			$this->initialize();
131			$this->setup_hooks();
132			}
133
134			/**
135			* Setup hooks.
136			*
137			* @since 5.5
138			*/
139			protected function setup_hooks() {
140			add_action( $this->meta_box_hook, array( $this, 'setup_metabox' ), 10, 2 );
141			add_action( 'bd_' . $this->delete_action, array( $this, 'process' ) );
142			add_filter( 'bd_javascript_array', array( $this, 'filter_js_array' ) );
143			}
144
145			/**
146			* Setup the meta box.
147			*
148			* @since 5.5
149			*
150			* @param mixed $screen
151			* @param mixed $page_slug
152			*/
153			public function setup_metabox( $screen, $page_slug ) {
154			$this->screen = $screen;
155			$this->page_slug = $page_slug;
156
157			add_meta_box( $this->meta_box_slug, $this->messages['box_label'], array( $this, 'render_box' ), $this->screen, 'advanced' );
158			}
159
160			/**
161			* Render the meta box.
162			*
163			* @since 5.5
164			*/
165			public function render_box() {
166			if ( $this->is_hidden() ) {
167			printf( __( '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 );
168
169			return;
170			}
171
172			$this->render();
173			}
174
175			/**
176			* Is the current meta box hidden by user.
177			*
178			* @since 5.5
179			*
180			* @return bool True, if hidden. False, otherwise.
181			*/
182			protected function is_hidden() {
183			$current_user = wp_get_current_user();
184			$user_meta_field = $this->get_hidden_box_user_meta_field();
185			$hidden_boxes = get_user_meta( $current_user->ID, $user_meta_field, true );
186
187			return is_array( $hidden_boxes ) && in_array( $this->meta_box_slug, $hidden_boxes );
188			}
189
190			/**
191			* Get the user meta field that stores the status of the hidden meta boxes.
192			*
193			* @since 5.5
194			*
195			* @return string Name of the User Meta field.
196			*/
197			protected function get_hidden_box_user_meta_field() {
198			if ( 'posts' == $this->item_type ) {
199			return 'metaboxhidden_toplevel_page_bulk-delete-posts';
200			} else {
201			return 'metaboxhidden_bulk-wp_page_' . $this->page_slug;
202			}
203			}
204
205			/**
206			* Filter the js array.
207			* This function will be overridden by the child classes.
208			*
209			* @since 5.5
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			* @since 5.5
223			*/
224			protected function render_filtering_table_header() {
225			bd_render_filtering_table_header();
226			}
227
228			/**
229			* Render restrict settings.
230			*
231			* @since 5.5
232			*/
233			protected function render_restrict_settings() {
234			bd_render_restrict_settings( $this->field_slug, $this->item_type );
235			}
236
237			/**
238			* Render delete settings.
239			*
240			* @since 5.5
241			*/
242			protected function render_delete_settings() {
243			bd_render_delete_settings( $this->field_slug );
244			}
245
246			/**
247			* Render limit settings.
248			*
249			* @since 5.5
250			*/
251			protected function render_limit_settings() {
252			bd_render_limit_settings( $this->field_slug, $this->item_type );
253			}
254
255			/**
256			* Render cron settings.
257			*
258			* @since 5.5
259			*/
260			protected function render_cron_settings() {
261			bd_render_cron_settings( $this->field_slug, $this->scheduler_url );
262			}
263
264			/**
265			* Render submit button.
266			*
267			* @since 5.5
268			*/
269			protected function render_submit_button() {
270			bd_render_submit_button( $this->delete_action );
271			}
272
273			/**
274			* Helper function for processing deletion.
275			* Setups up cron and invokes the actual delete method.
276			*
277			* @since 5.5
278			*
279			* @param mixed $delete_options
280			*/
281			protected function process_delete( $delete_options ) {
282			if ( bd_array_get_bool( $_POST, 'smbd_' . $this->field_slug . '_cron', false ) ) {
283			$freq = $_POST[ 'smbd_' . $this->field_slug . '_cron_freq' ];
284			$time = strtotime( $_POST[ 'smbd_' . $this->field_slug . '_cron_start' ] ) - ( get_option( 'gmt_offset' ) * 60 * 60 );
285
286			if ( -1 == $freq ) {
287			wp_schedule_single_event( $time, $this->cron_hook, array( $delete_options ) );
288			} else {
289			wp_schedule_event( $time, $freq , $this->cron_hook, array( $delete_options ) );
290			}
291
292			$msg = $this->messages['scheduled'] . ' ' .
293			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 );
294			} else {
295			$deleted_count = $this->delete( $delete_options );
296			$msg = sprintf( _n( $this->messages['deleted_single'], $this->messages['deleted_plural'] , $deleted_count, 'bulk-delete' ), $deleted_count );
297			}
298
299			add_settings_error(
300			$this->page_slug,
301			'deleted-' . $this->item_type,
302			$msg,
303			'updated'
304			);
305			}
306
307			/**
308			* Getter for cron_hook.
309			*
310			* @since 5.5
311			*
312			* @return string Cron Hook name.
313			*/
314			public function get_cron_hook() {
315			return $this->cron_hook;
316			}
317
318			/**
319			* Getter for field slug.
320			*
321			* @since 5.5
322			*
323			* @return string Field Slug.
324			*/
325			public function get_field_slug() {
326			return $this->field_slug;
327			}
328			}
329

sudar / bulk-delete

Push — 312-fix/delete-post-meta-modul... ( fbbe37...602413 )

BD_Meta_Box_Module::process_delete() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like