BaseModule::get_cron_label() - Code Metrics - Inspection of "Handle legacy cron hooks in modules" - sudar/bulk-delete - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — dev/6.1.0 ( 7f0ec5...6298db )

by Sudar

created 2020-06-14 06:01 UTC

BaseModule::get_cron_label() A

↳ Parent: BaseModule

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	2
ccs	2
cts	2
cp	1
crap	1
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 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;

	/**
	 * List of legacy cron hooks that this module should support.
	 *
	 * Legacy cron hooks usually come from older version of the add-on(s).
	 *
	 * @since 6.1.0
	 *
	 * @var array
	 */
	protected $legacy_cron_hooks = [];

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

	/**
	 * Messages shown to the user.
	 *
	 * @var array
	 */
	protected $messages = array(
		'box_label'         => '',
		'cron_label'        => '',
		'validation_error'  => '',
		'confirm_deletion'  => '',
		'confirm_scheduled' => '',
		'scheduled'         => '',
		'nothing_to_delete' => '',
		'deleted_one'       => '',
		'deleted_multiple'  => '',
	);

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

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

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

	/**
	 * 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 protected function do_delete( $options );

	/**
	 * 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_filter( 'bd_javascript_array', array( $this, 'filter_js_array' ) );

		if ( ! empty( $this->action ) ) {
			add_action( 'bd_' . $this->action, array( $this, 'process' ) );
		}
	}

	/**
	 * Setup the meta box.
	 */
	public function setup_metabox() {
		if ( array_key_exists( 'box_label', $this->messages ) ) {
			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=' . esc_attr( $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.
	 *
	 * Use `append_to_js_array` function to append any module specific js options.
	 *
	 * @see $this->append_to_js_array
	 *
	 * @param array $js_array JavaScript Array.
	 *
	 * @return array Modified JavaScript Array
	 */
	public function filter_js_array( $js_array ) {
		$js_array['dt_iterators'][] = '_' . $this->field_slug;

		$js_array['pre_delete_msg'][ $this->action ] = $this->action . '_confirm_deletion';
		$js_array['error_msg'][ $this->action ]      = $this->action . '_error';

		$js_array['msg'][ $this->action . '_confirm_deletion' ] = __( 'Are you sure you want to delete all the posts based on the selected option?', 'bulk-delete' );
		$js_array['msg'][ $this->action . '_error' ]            = __( 'Please select posts from at least one option', 'bulk-delete' );

		if ( ! empty( $this->messages['confirm_deletion'] ) ) {
			$js_array['msg'][ $this->action . '_confirm_deletion' ] = $this->messages['confirm_deletion'];
		}

		if ( ! empty( $this->messages['confirm_scheduled'] ) ) {
			$js_array['pre_schedule_msg'][ $this->action ] = $this->action . '_confirm_scheduled';

			$js_array['msg'][ $this->action . '_confirm_scheduled' ] = $this->messages['confirm_scheduled'];
		}

		if ( ! empty( $this->messages['validation_error'] ) ) {
			$js_array['msg'][ $this->action . '_error' ] = $this->messages['validation_error'];
		}

		return $this->append_to_js_array( $js_array );
	}

	/**
	 * Append any module specific options to JS array.
	 *
	 * This function will be overridden by the child classes.
	 *
	 * @param array $js_array JavaScript Array.
	 *
	 * @return array Modified JavaScript Array
	 */
	protected function append_to_js_array( $js_array ) {
		return $js_array;
	}

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

		/**
		 * Filter the processed delete options.
		 *
		 * @since 6.0.0
		 *
		 * @param array $options Processed options.
		 * @param array $request Request array.
		 * @param \BulkWP\BulkDelete\Core\Base\BaseModule The delete module.
		 */
		$options = apply_filters( 'bd_processed_delete_options', $options, $request, $this );

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

	/**
	 * Delete items based on delete options.
	 *
	 * @param array $options Delete Options.
	 *
	 * @return int Number of items deleted.
	 */
	public function delete( $options ) {
		/**
		 * Filter delete options before deleting items.
		 *
		 * @since 6.0.0 Added `Modules` parameter.
		 *
		 * @param array $options Delete options.
		 * @param \BulkWP\BulkDelete\Core\Base\BaseModule Modules that is triggering deletion.
		 */
		$options = apply_filters( 'bd_delete_options', $options, $this );

		return $this->do_delete( $options );
	}

	/**
	 * Get Success Message.
	 *
	 * @param int $items_deleted Number of items that were deleted.
	 *
	 * @return string Success message.
	 */
	protected function get_success_message( $items_deleted ) {
		if ( 0 === $items_deleted ) {
			if ( ! empty( $this->messages['nothing_to_delete'] ) ) {
				return $this->messages['nothing_to_delete'];
			}
		}

		return _n( $this->messages['deleted_one'], $this->messages['deleted_multiple'], $items_deleted, 'bulk-delete' ); // phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralSingle, WordPress.WP.I18n.NonSingularStringLiteralPlural
	}

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

	/**
	 * Getter for legacy cron_hooks.
	 *
	 * @since 6.1.0
	 *
	 * @return array Legacy cron Hooks.
	 */
	public function get_legacy_cron_hooks() {
		return $this->legacy_cron_hooks;
	}

	/**
	 * 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 ) {
		$options['cron_label'] = $cron_options['cron_label'];

		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(
			/* translators: 1 Cron page url */
			__( '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
		);
	}

	/**
	 * 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 human readable label for the Schedule job.
	 *
	 * @return string Human readable label for schedule job.
	 */
	public function get_cron_label() {
		return $this->messages['cron_label'];
	}

	/**
	 * Get the name of the module.
	 *
	 * This is used as the key to identify the module from page.
	 *
	 * @return string Module name.
	 */
	public function get_name() {
		return bd_get_short_class_name( $this );
	}

	/**
	 * Get the page slug of the module.
	 *
	 * @since 6.0.1
	 *
	 * @return string Page slug.
	 */
	public function get_page_slug() {
		return $this->page_slug;
	}
}


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 of the meta box.
42		*
43		* @var string
44		*/
45		protected $meta_box_slug;
46
47		/**
48		* Action in which the delete operation should be performed.
49		*
50		* @var string
51		*/
52		protected $action = '';
53
54		/**
55		* Hook for scheduler.
56		*
57		* @var string
58		*/
59		protected $cron_hook;
60
61		/**
62		* List of legacy cron hooks that this module should support.
63		*
64		* Legacy cron hooks usually come from older version of the add-on(s).
65		*
66		* @since 6.1.0
67		*
68		* @var array
69		*/
70		protected $legacy_cron_hooks = [];
71
72		/**
73		* Url of the scheduler addon.
74		*
75		* @var string
76		*/
77		protected $scheduler_url;
78
79		/**
80		* Messages shown to the user.
81		*
82		* @var array
83		*/
84		protected $messages = array(
85		'box_label' => '',
86		'cron_label' => '',
87		'validation_error' => '',
88		'confirm_deletion' => '',
89		'confirm_scheduled' => '',
90		'scheduled' => '',
91		'nothing_to_delete' => '',
92		'deleted_one' => '',
93		'deleted_multiple' => '',
94		);
95
96		/**
97		* Initialize and setup variables.
98		*
99		* @return void
100		*/
101		abstract protected function initialize();
102
103		/**
104		* Render the Modules.
105		*
106		* @return void
107		*/
108		abstract public function render();
109
110		/**
111		* Process common filters.
112		*
113		* @param array $request Request array.
114		*
115		* @return array User options.
116		*/
117		abstract protected function parse_common_filters( $request );
118
119		/**
120		* Process user input and create metabox options.
121		*
122		* @param array $request Request array.
123		* @param array $options User options.
124		*
125		* @return array User options.
126		*/
127		abstract protected function convert_user_input_to_options( $request, $options );
128
129		/**
130		* Perform the deletion.
131		*
132		* @param array $options Array of Delete options.
133		*
134		* @return int Number of items that were deleted.
135		*/
136		abstract protected function do_delete( $options );
137
138		/**
139		* Create new instances of Modules.
140		*/
141	413	public function __construct() {
142	413	$this->initialize();
143		}
144
145		/**
146		* Register.
147		*
148		* @param string $hook_suffix Page Hook Suffix.
149		* @param string $page_slug Page slug.
150		*/
151	24	public function register( $hook_suffix, $page_slug ) {
152	24	$this->page_hook_suffix = $hook_suffix;
153	24	$this->page_slug = $page_slug;
154
155	24	add_action( "add_meta_boxes_{$this->page_hook_suffix}", array( $this, 'setup_metabox' ) );
156
157	24	add_filter( 'bd_javascript_array', array( $this, 'filter_js_array' ) );
158
159	24	if ( ! empty( $this->action ) ) {
160	24	add_action( 'bd_' . $this->action, array( $this, 'process' ) );
161		}
162		}
163
164		/**
165		* Setup the meta box.
166		*/
167		public function setup_metabox() {
168		if ( array_key_exists( 'box_label', $this->messages ) ) {
169		add_meta_box(
170		$this->meta_box_slug,
171		$this->messages['box_label'],
172		array( $this, 'render_box' ),
173		$this->page_hook_suffix,
174		'advanced'
175		);
176		}
177		}
178
179		/**
180		* Render the meta box.
181		*/
182	1	public function render_box() {
183	1	if ( $this->is_hidden() ) {
184		printf(
185		/* translators: 1 Module url */
186		__( 'This section just got enabled. Kindly <a href = "%1$s">refresh</a> the page to fully enable it.', 'bulk-delete' ),
187		'admin.php?page=' . esc_attr( $this->page_slug )
188		);
189
190		return;
191		}
192
193	1	$this->render();
194		}
195
196		/**
197		* Is the current meta box hidden by user.
198		*
199		* @return bool True, if hidden. False, otherwise.
200		*/
201	1	protected function is_hidden() {
202	1	$current_user = wp_get_current_user();
203	1	$user_meta_field = $this->get_hidden_box_user_meta_field();
204	1	$hidden_boxes = get_user_meta( $current_user->ID, $user_meta_field, true );
205
206	1	return is_array( $hidden_boxes ) && in_array( $this->meta_box_slug, $hidden_boxes, true );
207		}
208
209		/**
210		* Get the user meta field that stores the status of the hidden meta boxes.
211		*
212		* @return string Name of the User Meta field.
213		*/
214	1	protected function get_hidden_box_user_meta_field() {
215	1	if ( 'posts' === $this->item_type ) {
216		return 'metaboxhidden_toplevel_page_bulk-delete-posts';
217		} else {
218	1	return 'metaboxhidden_bulk-wp_page_' . $this->page_slug;
219		}
220		}
221
222		/**
223		* Filter the js array.
224		*
225		* Use `append_to_js_array` function to append any module specific js options.
226		*
227		* @see $this->append_to_js_array
228		*
229		* @param array $js_array JavaScript Array.
230		*
231		* @return array Modified JavaScript Array
232		*/
233		public function filter_js_array( $js_array ) {
234		$js_array['dt_iterators'][] = '_' . $this->field_slug;
235
236		$js_array['pre_delete_msg'][ $this->action ] = $this->action . '_confirm_deletion';
237		$js_array['error_msg'][ $this->action ] = $this->action . '_error';
238
239		$js_array['msg'][ $this->action . '_confirm_deletion' ] = __( 'Are you sure you want to delete all the posts based on the selected option?', 'bulk-delete' );
240		$js_array['msg'][ $this->action . '_error' ] = __( 'Please select posts from at least one option', 'bulk-delete' );
241
242		if ( ! empty( $this->messages['confirm_deletion'] ) ) {
243		$js_array['msg'][ $this->action . '_confirm_deletion' ] = $this->messages['confirm_deletion'];
244		}
245
246		if ( ! empty( $this->messages['confirm_scheduled'] ) ) {
247		$js_array['pre_schedule_msg'][ $this->action ] = $this->action . '_confirm_scheduled';
248
249		$js_array['msg'][ $this->action . '_confirm_scheduled' ] = $this->messages['confirm_scheduled'];
250		}
251
252		if ( ! empty( $this->messages['validation_error'] ) ) {
253		$js_array['msg'][ $this->action . '_error' ] = $this->messages['validation_error'];
254		}
255
256		return $this->append_to_js_array( $js_array );
257		}
258
259		/**
260		* Append any module specific options to JS array.
261		*
262		* This function will be overridden by the child classes.
263		*
264		* @param array $js_array JavaScript Array.
265		*
266		* @return array Modified JavaScript Array
267		*/
268		protected function append_to_js_array( $js_array ) {
269		return $js_array;
270		}
271
272		/**
273		* Helper function for processing deletion.
274		* Setups up cron and invokes the actual delete method.
275		*
276		* @param array $request Request array.
277		*/
278	1	public function process( $request ) {
279	1	$options = $this->parse_common_filters( $request );
280	1	$options = $this->convert_user_input_to_options( $request, $options );
281	1	$cron_options = $this->parse_cron_filters( $request );
282
283		/**
284		* Filter the processed delete options.
285		*
286		* @since 6.0.0
287		*
288		* @param array $options Processed options.
289		* @param array $request Request array.
290		* @param \BulkWP\BulkDelete\Core\Base\BaseModule The delete module.
291		*/
292	1	$options = apply_filters( 'bd_processed_delete_options', $options, $request, $this );
293
294	1	if ( $this->is_scheduled( $cron_options ) ) {
295		$msg = $this->schedule_deletion( $cron_options, $options );
296		} else {
297	1	$items_deleted = $this->delete( $options );
298	1	$msg = sprintf( $this->get_success_message( $items_deleted ), $items_deleted );
299		}
300
301	1	add_settings_error(
302	1	$this->page_slug,
303	1	$this->action,
304		$msg,
305	1	'updated'
306		);
307		}
308
309		/**
310		* Delete items based on delete options.
311		*
312		* @param array $options Delete Options.
313		*
314		* @return int Number of items deleted.
315		*/
316	330	public function delete( $options ) {
317		/**
318		* Filter delete options before deleting items.
319		*
320		* @since 6.0.0 Added `Modules` parameter.
321		*
322		* @param array $options Delete options.
323		* @param \BulkWP\BulkDelete\Core\Base\BaseModule Modules that is triggering deletion.
324		*/
325	330	$options = apply_filters( 'bd_delete_options', $options, $this );
326
327	330	return $this->do_delete( $options );
328		}
329
330		/**
331		* Get Success Message.
332		*
333		* @param int $items_deleted Number of items that were deleted.
334		*
335		* @return string Success message.
336		*/
337	1	protected function get_success_message( $items_deleted ) {
338	1	if ( 0 === $items_deleted ) {
339		if ( ! empty( $this->messages['nothing_to_delete'] ) ) {
340		return $this->messages['nothing_to_delete'];
341		}
342		}
343
344	1	return _n( $this->messages['deleted_one'], $this->messages['deleted_multiple'], $items_deleted, 'bulk-delete' ); // phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralSingle, WordPress.WP.I18n.NonSingularStringLiteralPlural
345		}
346
347		/**
348		* Getter for cron_hook.
349		*
350		* @return string Cron Hook name.
351		*/
352		public function get_cron_hook() {
353		return $this->cron_hook;
354		}
355
356		/**
357		* Getter for legacy cron_hooks.
358		*
359		* @since 6.1.0
360		*
361		* @return array Legacy cron Hooks.
362		*/
363		public function get_legacy_cron_hooks() {
364		return $this->legacy_cron_hooks;
365		}
366
367		/**
368		* Getter for field slug.
369		*
370		* @return string Field Slug.
371		*/
372		public function get_field_slug() {
373		return $this->field_slug;
374		}
375
376		/**
377		* Getter for action.
378		*
379		* @return string Modules action.
380		*/
381	340	public function get_action() {
382	340	return $this->action;
383		}
384
385		/**
386		* Is the current deletion request a scheduled request?
387		*
388		* @param array $cron_options Request object.
389		*
390		* @return bool True if it is a scheduled request, False otherwise.
391		*/
392	3	protected function is_scheduled( $cron_options ) {
393	3	return $cron_options['is_scheduled'];
394		}
395
396		/**
397		* Schedule Deletion of items.
398		*
399		* @param array $cron_options Cron options.
400		* @param array $options Deletion option.
401		*
402		* @return string Message.
403		*/
404	32	protected function schedule_deletion( $cron_options, $options ) {
405	32	$options['cron_label'] = $cron_options['cron_label'];
406
407	32	if ( '-1' === $cron_options['frequency'] ) {
408	8	wp_schedule_single_event( $cron_options['start_time'], $this->cron_hook, array( $options ) );
409		} else {
410	24	wp_schedule_event( $cron_options['start_time'], $cron_options['frequency'], $this->cron_hook, array( $options ) );
411		}
412
413	32	return $this->messages['scheduled'] . ' ' . $this->get_task_list_link();
414		}
415
416		/**
417		* Get the link to the page that lists all the scheduled tasks.
418		*
419		* @return string Link to scheduled tasks page.
420		*/
421	32	protected function get_task_list_link() {
422	32	return sprintf(
423		/* translators: 1 Cron page url */
424	32	__( 'See the full list of <a href = "%s">scheduled tasks</a>', 'bulk-delete' ),
425	32	get_bloginfo( 'wpurl' ) . '/wp-admin/admin.php?page=' . \Bulk_Delete::CRON_PAGE_SLUG
426		);
427		}
428
429		/**
430		* Parse request and create cron options.
431		*
432		* @param array $request Request array.
433		*
434		* @return array Parsed cron option.
435		*/
436	31	protected function parse_cron_filters( $request ) {
437		$cron_options = array(
438	31	'is_scheduled' => false,
439		);
440
441	31	$scheduled = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_cron', false );
442
443	31	if ( $scheduled ) {
444	28	$cron_options['is_scheduled'] = true;
445	28	$cron_options['frequency'] = sanitize_text_field( $request[ 'smbd_' . $this->field_slug . '_cron_freq' ] );
446	28	$cron_options['start_time'] = bd_get_gmt_offseted_time( sanitize_text_field( $request[ 'smbd_' . $this->field_slug . '_cron_start' ] ) );
447
448	28	$cron_options['cron_label'] = $this->get_cron_label();
449		}
450
451	31	return $cron_options;
452		}
453
454		/**
455		* Get the human readable label for the Schedule job.
456		*
457		* @return string Human readable label for schedule job.
458		*/
459	28	public function get_cron_label() {
460	28	return $this->messages['cron_label'];
461		}
462
463		/**
464		* Get the name of the module.
465		*
466		* This is used as the key to identify the module from page.
467		*
468		* @return string Module name.
469		*/
470		public function get_name() {
471		return bd_get_short_class_name( $this );
472		}
473
474		/**
475		* Get the page slug of the module.
476		*
477		* @since 6.0.1
478		*
479		* @return string Page slug.
480		*/
481		public function get_page_slug() {
482		return $this->page_slug;
483		}
484		}
485

sudar / bulk-delete

Push — dev/6.1.0 ( 7f0ec5...6298db )

BaseModule::get_cron_label() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like