BaseMetabox::get_cron_hook() - Code Metrics - Inspection of "Allow PSR-2 based filenames" - sudar/bulk-delete - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 137-feature/refactor-post-modu... ( 580e59 )

by Sudar

created 2018-03-20 05:28 UTC

BaseMetabox::get_cron_hook() A

↳ Parent: BaseMetabox

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
namespace BulkWP\BulkDelete\Core\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.7.0
 */
abstract class BaseMetabox {

	/**
	 * Item Type. Possible values 'posts', 'pages', 'users' etc.
	 *
	 * @var string
	 */
	protected $item_type = 'posts';

	/**
	 * 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 Metabox.
	 *
	 * @return void
	 */
	abstract public function render();

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

	/**
	 * Perform the deletion.
	 *
	 * @param array $delete_options Array of Delete options.
	 *
	 * @return int Number of items that were deleted.
	 */
	abstract public function delete( $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 Metabox.
	 */
	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->convert_user_input_to_options( $request );

		if ( $this->is_scheduled( $request ) ) {
			$msg = $this->schedule_deletion( $request, $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 Metabox action.
	 */
	public function get_action() {
		return $this->action;
	}

	/**
	 * Is the current deletion request a scheduled request?
	 *
	 * @param array $request Request object.
	 *
	 * @return bool True if it is a scheduled request, False otherwise.
	 */
	protected function is_scheduled( $request ) {
		return bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_cron', false );
	}

	/**
	 * Schedule Deletion of items.
	 *
	 * @param array $request Request array.
	 * @param array $options Deletion option.
	 *
	 * @return string Message.
	 */
	protected function schedule_deletion( $request, $options ) {
		$freq = $request[ 'smbd_' . $this->field_slug . '_cron_freq' ];
		$time = strtotime( $request[ 'smbd_' . $this->field_slug . '_cron_start' ] ) - ( get_option( 'gmt_offset' ) * 60 * 60 );

		if ( -1 === $freq ) {
			wp_schedule_single_event( $time, $this->cron_hook, array( $options ) );
		} else {
			wp_schedule_event( $time, $freq, $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

		);
	}
}


1		<?php
2		namespace BulkWP\BulkDelete\Core\Base;
3
4	1	defined( 'ABSPATH' ) \|\| exit; // Exit if accessed directly.
5
6		/**
7		* Encapsulates the Bulk Delete Meta box Module Logic.
8		*
9		* All Bulk Delete Meta box Modules should extend this class.
10		*
11		* @since 5.7.0
12		*/
13		abstract class BaseMetabox {
14
15		/**
16		* Item Type. Possible values 'posts', 'pages', 'users' etc.
17		*
18		* @var string
19		*/
20		protected $item_type = 'posts';
21
22		/**
23		* The hook suffix of the screen where this meta box would be shown.
24		*
25		* @var string
26		*/
27		protected $page_hook_suffix;
28
29		/**
30		* Slug of the page where this module will be shown.
31		*
32		* @var string
33		*/
34		protected $page_slug;
35
36		/**
37		* Slug for the form fields.
38		*
39		* @var string
40		*/
41		protected $field_slug;
42
43		/**
44		* Slug of the meta box.
45		*
46		* @var string
47		*/
48		protected $meta_box_slug;
49
50		/**
51		* Action in which the delete operation should be performed.
52		*
53		* @var string
54		*/
55		protected $action;
56
57		/**
58		* Hook for scheduler.
59		*
60		* @var string
61		*/
62		protected $cron_hook;
63
64		/**
65		* Url of the scheduler addon.
66		*
67		* @var string
68		*/
69		protected $scheduler_url;
70
71		/**
72		* Messages shown to the user.
73		*
74		* @var array
75		*/
76		protected $messages = array(
77		'box_label' => '',
78		);
79
80		/**
81		* Initialize and setup variables.
82		*
83		* @return void
84		*/
85		abstract protected function initialize();
86
87		/**
88		* Render the Metabox.
89		*
90		* @return void
91		*/
92		abstract public function render();
93
94		/**
95		* Process user input and create metabox options.
96		*
97		* @param array $request Request array.
98		*
99		* @return array User options.
100		*/
101		abstract protected function convert_user_input_to_options( $request );
102
103		/**
104		* Perform the deletion.
105		*
106		* @param array $delete_options Array of Delete options.
107		*
108		* @return int Number of items that were deleted.
109		*/
110		abstract public function delete( $delete_options );
111
112		/**
113		* Get Success Message.
114		*
115		* @param int $items_deleted Number of items that were deleted.
116		*
117		* @return string Success message.
118		*/
119		abstract protected function get_success_message( $items_deleted );
120
121		/**
122		* Create new instances of Metabox.
123		*/
124		public function __construct() {
125		$this->initialize();
126		}
127
128		/**
129		* Register.
130		*
131		* @param string $hook_suffix Page Hook Suffix.
132		* @param string $page_slug Page slug.
133		*/
134		public function register( $hook_suffix, $page_slug ) {
135		$this->page_hook_suffix = $hook_suffix;
136		$this->page_slug = $page_slug;
137
138		add_action( "add_meta_boxes_{$this->page_hook_suffix}", array( $this, 'setup_metabox' ) );
139
140		add_action( 'bd_' . $this->action, array( $this, 'process' ) );
141		add_filter( 'bd_javascript_array', array( $this, 'filter_js_array' ) );
142		}
143
144		/**
145		* Setup the meta box.
146		*/
147		public function setup_metabox() {
148		add_meta_box(
149		$this->meta_box_slug,
150		$this->messages['box_label'],
151		array( $this, 'render_box' ),
152		$this->page_hook_suffix,
153		'advanced'
154		);
155		}
156
157		/**
158		* Render the meta box.
159		*/
160		public function render_box() {
161		if ( $this->is_hidden() ) {
162		printf(
163		/* translators: 1 module url */
164		__( 'This section just got enabled. Kindly <a href = "%1$s">refresh</a> the page to fully enable it.', 'bulk-delete' ),
165		'admin.php?page=' . $this->page_slug
166		);
167
168		return;
169		}
170
171		$this->render();
172		}
173
174		/**
175		* Is the current meta box hidden by user.
176		*
177		* @return bool True, if hidden. False, otherwise.
178		*/
179		protected function is_hidden() {
180		$current_user = wp_get_current_user();
181		$user_meta_field = $this->get_hidden_box_user_meta_field();
182		$hidden_boxes = get_user_meta( $current_user->ID, $user_meta_field, true );
183
184		return is_array( $hidden_boxes ) && in_array( $this->meta_box_slug, $hidden_boxes, true );
185		}
186
187		/**
188		* Get the user meta field that stores the status of the hidden meta boxes.
189		*
190		* @return string Name of the User Meta field.
191		*/
192		protected function get_hidden_box_user_meta_field() {
193		if ( 'posts' === $this->item_type ) {
194		return 'metaboxhidden_toplevel_page_bulk-delete-posts';
195		} else {
196		return 'metaboxhidden_bulk-wp_page_' . $this->page_slug;
197		}
198		}
199
200		/**
201		* Filter the js array.
202		*
203		* This function will be overridden by the child classes.
204		*
205		* @param array $js_array JavaScript Array.
206		*
207		* @return array Modified JavaScript Array
208		*/
209		public function filter_js_array( $js_array ) {
210		return $js_array;
211		}
212
213		/**
214		* Render filtering table header.
215		*/
216		protected function render_filtering_table_header() {
217		bd_render_filtering_table_header();
218		}
219
220		/**
221		* Render restrict settings.
222		*/
223		protected function render_restrict_settings() {
224		bd_render_restrict_settings( $this->field_slug, $this->item_type );
225		}
226
227		/**
228		* Render delete settings.
229		*/
230		protected function render_delete_settings() {
231		bd_render_delete_settings( $this->field_slug );
232		}
233
234		/**
235		* Render limit settings.
236		*/
237		protected function render_limit_settings() {
238		bd_render_limit_settings( $this->field_slug, $this->item_type );
239		}
240
241		/**
242		* Render cron settings.
243		*/
244		protected function render_cron_settings() {
245		bd_render_cron_settings( $this->field_slug, $this->scheduler_url );
246		}
247
248		/**
249		* Render submit button.
250		*/
251		protected function render_submit_button() {
252		bd_render_submit_button( $this->action );
253		}
254
255		/**
256		* Helper function for processing deletion.
257		* Setups up cron and invokes the actual delete method.
258		*
259		* @param array $request Request array.
260		*/
261		public function process( $request ) {
262		$options = $this->convert_user_input_to_options( $request );
263
264		if ( $this->is_scheduled( $request ) ) {
265		$msg = $this->schedule_deletion( $request, $options );
266		} else {
267		$items_deleted = $this->delete( $options );
268		$msg = sprintf( $this->get_success_message( $items_deleted ), $items_deleted );
269		}
270
271		add_settings_error(
272		$this->page_slug,
273		$this->action,
274		$msg,
275		'updated'
276		);
277		}
278
279		/**
280		* Getter for cron_hook.
281		*
282		* @return string Cron Hook name.
283		*/
284		public function get_cron_hook() {
285		return $this->cron_hook;
286		}
287
288		/**
289		* Getter for field slug.
290		*
291		* @return string Field Slug.
292		*/
293		public function get_field_slug() {
294		return $this->field_slug;
295		}
296
297		/**
298		* Getter for action.
299		*
300		* @return string Metabox action.
301		*/
302		public function get_action() {
303		return $this->action;
304		}
305
306		/**
307		* Is the current deletion request a scheduled request?
308		*
309		* @param array $request Request object.
310		*
311		* @return bool True if it is a scheduled request, False otherwise.
312		*/
313		protected function is_scheduled( $request ) {
314		return bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_cron', false );
315		}
316
317		/**
318		* Schedule Deletion of items.
319		*
320		* @param array $request Request array.
321		* @param array $options Deletion option.
322		*
323		* @return string Message.
324		*/
325		protected function schedule_deletion( $request, $options ) {
326		$freq = $request[ 'smbd_' . $this->field_slug . '_cron_freq' ];
327		$time = strtotime( $request[ 'smbd_' . $this->field_slug . '_cron_start' ] ) - ( get_option( 'gmt_offset' ) * 60 * 60 );
328
329		if ( -1 === $freq ) {
330		wp_schedule_single_event( $time, $this->cron_hook, array( $options ) );
331		} else {
332		wp_schedule_event( $time, $freq, $this->cron_hook, array( $options ) );
333		}
334
335		return $this->messages['scheduled'] . ' ' . $this->get_task_list_link();
336		}
337
338		/**
339		* Get the link to the page that lists all the scheduled tasks.
340		*
341		* @return string Link to scheduled tasks page.
342		*/
343		protected function get_task_list_link() {
344		return sprintf(
345		__( 'See the full list of <a href = "%s">scheduled tasks</a>', 'bulk-delete' ),
346		get_bloginfo( 'wpurl' ) . '/wp-admin/admin.php?page=' . Bulk_Delete::CRON_PAGE_SLUG
		0 ignored issues – show Bug introduced 2018-03-20 05:36 UTC by Report Bug Copy Issue Report The type `BulkWP\BulkDelete\Core\Base\Bulk_Delete` was not found. Did you mean `Bulk_Delete`? If so, make sure to prefix the type with `\`. Loading history...
347		);
348		}
349		}
350

sudar / bulk-delete

Push — 137-feature/refactor-post-modu... ( 580e59 )

BaseMetabox::get_cron_hook() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like