BaseModule::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

BaseModule::delete() A

↳ Parent: BaseModule

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	12
ccs	3
cts	3
cp	1
crap	1
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'  => '',
		'cron_label' => '',
	);

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

	/**
	 * 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 sticky settings.
	 */
	protected function render_sticky_settings() {
		bd_render_sticky_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 based on whether scheduler is present or not.
	 */
	protected function render_cron_settings() {
		$disabled_attr = 'disabled';
		if ( empty( $this->scheduler_url ) ) {
			$disabled_attr = '';
		}
		?>

		<tr>
			<td scope="row" colspan="2">
				<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron" value="false" type="radio" checked="checked"> <?php _e( 'Delete now', 'bulk-delete' ); ?>
				<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron" value="true" type="radio" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron" <?php echo esc_attr( $disabled_attr ); ?>> <?php _e( 'Schedule', 'bulk-delete' ); ?>
				<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_start" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_start" value="now" type="text" <?php echo esc_attr( $disabled_attr ); ?>><?php _e( 'repeat ', 'bulk-delete' ); ?>

				<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_freq" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_freq" <?php echo esc_attr( $disabled_attr ); ?>>
					<option value="-1"><?php _e( "Don't repeat", 'bulk-delete' ); ?></option>

					<?php
					/**
					 * List of cron schedules.
					 *
					 * @since 6.0.0
					 *
					 * @param array                                   $cron_schedules List of cron schedules.
					 * @param \BulkWP\BulkDelete\Core\Base\BaseModule $module         Module.
					 */
					$cron_schedules = apply_filters( 'bd_cron_schedules', wp_get_schedules(), $this );
					?>

					<?php foreach ( $cron_schedules as $key => $value ) : ?>
						<option value="<?php echo esc_attr( $key ); ?>"><?php echo esc_html( $value['display'] ); ?></option>
					<?php endforeach; ?>
				</select>

				<?php if ( ! empty( $this->scheduler_url ) ) : ?>
					<?php
					$pro_class = 'bd-' . str_replace( '_', '-', $this->field_slug ) . '-pro';

					/**
					 * HTML class of the span that displays the 'Pro only feature' message.
					 *
					 * @since 6.0.0
					 *
					 * @param string                                  $pro_class  HTML class.
					 * @param string                                  $field_slug Field Slug of module.
					 * @param \BulkWP\BulkDelete\Core\Base\BaseModule $module     Module.
					 */
					apply_filters( 'bd_pro_only_feature_class', $pro_class, $this->field_slug, $this )
					?>

					<span class="<?php echo sanitize_html_class( $pro_class ); ?>" style="color:red">
						<?php _e( 'Only available in Pro Addon', 'bulk-delete' ); ?> <a href="<?php echo esc_url( $this->scheduler_url ); ?>">Buy now</a>
					</span>
				<?php endif; ?>
			</td>
		</tr>

		<tr>
			<td scope="row" colspan="2">
				<?php _e( 'Enter time in <strong>Y-m-d H:i:s</strong> format or enter <strong>now</strong> to use current time', 'bulk-delete' ); ?>
			</td>
		</tr>
		<?php
	}

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

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

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

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

	/**
	 * Render Post type dropdown.
	 */
	protected function render_post_type_dropdown() {
		bd_render_post_type_dropdown( $this->field_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 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 common filters.
101		*
102		* @param array $request Request array.
103		*
104		* @return array User options.
105		*/
106		abstract protected function parse_common_filters( $request );
107
108		/**
109		* Process user input and create metabox options.
110		*
111		* @param array $request Request array.
112		* @param array $options User options.
113		*
114		* @return array User options.
115		*/
116		abstract protected function convert_user_input_to_options( $request, $options );
117
118		/**
119		* Perform the deletion.
120		*
121		* @param array $options Array of Delete options.
122		*
123		* @return int Number of items that were deleted.
124		*/
125		abstract protected function do_delete( $options );
126
127		/**
128		* Get Success Message.
129		*
130		* @param int $items_deleted Number of items that were deleted.
131		*
132		* @return string Success message.
133		*/
134		abstract protected function get_success_message( $items_deleted );
135
136		/**
137		* Create new instances of Modules.
138		*/
139	131	public function __construct() {
140	131	$this->initialize();
141	131	}
142
143		/**
144		* Register.
145		*
146		* @param string $hook_suffix Page Hook Suffix.
147		* @param string $page_slug Page slug.
148		*/
149		public function register( $hook_suffix, $page_slug ) {
150		$this->page_hook_suffix = $hook_suffix;
151		$this->page_slug = $page_slug;
152
153		add_action( "add_meta_boxes_{$this->page_hook_suffix}", array( $this, 'setup_metabox' ) );
154
155		add_action( 'bd_' . $this->action, array( $this, 'process' ) );
156		add_filter( 'bd_javascript_array', array( $this, 'filter_js_array' ) );
157		}
158
159		/**
160		* Setup the meta box.
161		*/
162		public function setup_metabox() {
163		add_meta_box(
164		$this->meta_box_slug,
165		$this->messages['box_label'],
166		array( $this, 'render_box' ),
167		$this->page_hook_suffix,
168		'advanced'
169		);
170		}
171
172		/**
173		* Render the meta box.
174		*/
175	1	public function render_box() {
176	1	if ( $this->is_hidden() ) {
177		printf(
178		/* translators: 1 module url */
179		__( 'This section just got enabled. Kindly <a href = "%1$s">refresh</a> the page to fully enable it.', 'bulk-delete' ),
180		'admin.php?page=' . $this->page_slug
181		);
182
183		return;
184		}
185
186	1	$this->render();
187	1	}
188
189		/**
190		* Is the current meta box hidden by user.
191		*
192		* @return bool True, if hidden. False, otherwise.
193		*/
194	1	protected function is_hidden() {
195	1	$current_user = wp_get_current_user();
196	1	$user_meta_field = $this->get_hidden_box_user_meta_field();
197	1	$hidden_boxes = get_user_meta( $current_user->ID, $user_meta_field, true );
198
199	1	return is_array( $hidden_boxes ) && in_array( $this->meta_box_slug, $hidden_boxes, true );
200		}
201
202		/**
203		* Get the user meta field that stores the status of the hidden meta boxes.
204		*
205		* @return string Name of the User Meta field.
206		*/
207	1	protected function get_hidden_box_user_meta_field() {
208	1	if ( 'posts' === $this->item_type ) {
209		return 'metaboxhidden_toplevel_page_bulk-delete-posts';
210		} else {
211	1	return 'metaboxhidden_bulk-wp_page_' . $this->page_slug;
212		}
213		}
214
215		/**
216		* Filter the js array.
217		*
218		* This function will be overridden by the child classes.
219		*
220		* @param array $js_array JavaScript Array.
221		*
222		* @return array Modified JavaScript Array
223		*/
224		public function filter_js_array( $js_array ) {
225		return $js_array;
226		}
227
228		/**
229		* Render filtering table header.
230		*/
231		protected function render_filtering_table_header() {
232		bd_render_filtering_table_header();
233		}
234
235		/**
236		* Render restrict settings.
237		*/
238		protected function render_restrict_settings() {
239		bd_render_restrict_settings( $this->field_slug, $this->item_type );
240		}
241
242		/**
243		* Render delete settings.
244		*/
245		protected function render_delete_settings() {
246		bd_render_delete_settings( $this->field_slug );
247		}
248
249		/**
250		* Render sticky settings.
251		*/
252		protected function render_sticky_settings() {
253		bd_render_sticky_settings( $this->field_slug );
254		}
255
256		/**
257		* Render limit settings.
258		*/
259		protected function render_limit_settings() {
260		bd_render_limit_settings( $this->field_slug, $this->item_type );
261		}
262
263		/**
264		* Render cron settings based on whether scheduler is present or not.
265		*/
266		protected function render_cron_settings() {
267		$disabled_attr = 'disabled';
268		if ( empty( $this->scheduler_url ) ) {
269		$disabled_attr = '';
270		}
271		?>
272
273		<tr>
274		<td scope="row" colspan="2">
275		<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron" value="false" type="radio" checked="checked"> <?php _e( 'Delete now', 'bulk-delete' ); ?>
276		<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron" value="true" type="radio" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron" <?php echo esc_attr( $disabled_attr ); ?>> <?php _e( 'Schedule', 'bulk-delete' ); ?>
277		<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_start" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_start" value="now" type="text" <?php echo esc_attr( $disabled_attr ); ?>><?php _e( 'repeat ', 'bulk-delete' ); ?>
278
279		<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_freq" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_freq" <?php echo esc_attr( $disabled_attr ); ?>>
280		<option value="-1"><?php _e( "Don't repeat", 'bulk-delete' ); ?></option>
281
282		<?php
283		/**
284		* List of cron schedules.
285		*
286		* @since 6.0.0
287		*
288		* @param array $cron_schedules List of cron schedules.
289		* @param \BulkWP\BulkDelete\Core\Base\BaseModule $module Module.
290		*/
291		$cron_schedules = apply_filters( 'bd_cron_schedules', wp_get_schedules(), $this );
292		?>
293
294		<?php foreach ( $cron_schedules as $key => $value ) : ?>
295		<option value="<?php echo esc_attr( $key ); ?>"><?php echo esc_html( $value['display'] ); ?></option>
296		<?php endforeach; ?>
297		</select>
298
299		<?php if ( ! empty( $this->scheduler_url ) ) : ?>
300		<?php
301		$pro_class = 'bd-' . str_replace( '_', '-', $this->field_slug ) . '-pro';
302
303		/**
304		* HTML class of the span that displays the 'Pro only feature' message.
305		*
306		* @since 6.0.0
307		*
308		* @param string $pro_class HTML class.
309		* @param string $field_slug Field Slug of module.
310		* @param \BulkWP\BulkDelete\Core\Base\BaseModule $module Module.
311		*/
312		apply_filters( 'bd_pro_only_feature_class', $pro_class, $this->field_slug, $this )
313		?>
314
315		<span class="<?php echo sanitize_html_class( $pro_class ); ?>" style="color:red">
316		<?php _e( 'Only available in Pro Addon', 'bulk-delete' ); ?> <a href="<?php echo esc_url( $this->scheduler_url ); ?>">Buy now</a>
317		</span>
318		<?php endif; ?>
319		</td>
320		</tr>
321
322		<tr>
323		<td scope="row" colspan="2">
324		<?php _e( 'Enter time in <strong>Y-m-d H:i:s</strong> format or enter <strong>now</strong> to use current time', 'bulk-delete' ); ?>
325		</td>
326		</tr>
327		<?php
328		}
329
330		/**
331		* Render submit button.
332		*/
333		protected function render_submit_button() {
334		bd_render_submit_button( $this->action );
335		}
336
337		/**
338		* Helper function for processing deletion.
339		* Setups up cron and invokes the actual delete method.
340		*
341		* @param array $request Request array.
342		*/
343	1	public function process( $request ) {
344	1	$options = $this->parse_common_filters( $request );
345	1	$options = $this->convert_user_input_to_options( $request, $options );
346	1	$cron_options = $this->parse_cron_filters( $request );
347
348	1	if ( $this->is_scheduled( $cron_options ) ) {
349		$msg = $this->schedule_deletion( $cron_options, $options );
350		} else {
351	1	$items_deleted = $this->delete( $options );
352	1	$msg = sprintf( $this->get_success_message( $items_deleted ), $items_deleted );
353		}
354
355	1	add_settings_error(
356	1	$this->page_slug,
357	1	$this->action,
358	1	$msg,
359	1	'updated'
360		);
361	1	}
362
363		/**
364		* Delete items based on delete options.
365		*
366		* @param array $options Delete Options.
367		*
368		* @return int Number of items deleted.
369		*/
370	65	public function delete( $options ) {
371		/**
372		* Filter delete options before deleting items.
373		*
374		* @since 6.0.0 Added `Modules` parameter.
375		*
376		* @param array $options Delete options.
377		* @param \BulkWP\BulkDelete\Core\Base\BaseModule Modules that is triggering deletion.
378		*/
379	65	$options = apply_filters( 'bd_delete_options', $options, $this );
380
381	65	return $this->do_delete( $options );
382		}
383
384		/**
385		* Getter for cron_hook.
386		*
387		* @return string Cron Hook name.
388		*/
389		public function get_cron_hook() {
390		return $this->cron_hook;
391		}
392
393		/**
394		* Getter for field slug.
395		*
396		* @return string Field Slug.
397		*/
398		public function get_field_slug() {
399		return $this->field_slug;
400		}
401
402		/**
403		* Getter for action.
404		*
405		* @return string Modules action.
406		*/
407	65	public function get_action() {
408	65	return $this->action;
409		}
410
411		/**
412		* Is the current deletion request a scheduled request?
413		*
414		* @param array $cron_options Request object.
415		*
416		* @return bool True if it is a scheduled request, False otherwise.
417		*/
418	3	protected function is_scheduled( $cron_options ) {
419	3	return $cron_options['is_scheduled'];
420		}
421
422		/**
423		* Schedule Deletion of items.
424		*
425		* @param array $cron_options Cron options.
426		* @param array $options Deletion option.
427		*
428		* @return string Message.
429		*/
430	32	protected function schedule_deletion( $cron_options, $options ) {
431	32	if ( '-1' === $cron_options['frequency'] ) {
432	8	wp_schedule_single_event( $cron_options['start_time'], $this->cron_hook, array( $options ) );
433		} else {
434	24	wp_schedule_event( $cron_options['start_time'], $cron_options['frequency'], $this->cron_hook, array( $options ) );
435		}
436
437	32	return $this->messages['scheduled'] . ' ' . $this->get_task_list_link();
438		}
439
440		/**
441		* Get the link to the page that lists all the scheduled tasks.
442		*
443		* @return string Link to scheduled tasks page.
444		*/
445	32	protected function get_task_list_link() {
446	32	return sprintf(
447	32	__( 'See the full list of <a href = "%s">scheduled tasks</a>', 'bulk-delete' ),
448	32	get_bloginfo( 'wpurl' ) . '/wp-admin/admin.php?page=' . \Bulk_Delete::CRON_PAGE_SLUG
449		);
450		}
451
452		/**
453		* Parse request and create cron options.
454		*
455		* @param array $request Request array.
456		*
457		* @return array Parsed cron option.
458		*/
459	31	protected function parse_cron_filters( $request ) {
460		$cron_options = array(
461	31	'is_scheduled' => false,
462		);
463
464	31	$scheduled = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_cron', false );
465
466	31	if ( $scheduled ) {
467	28	$cron_options['is_scheduled'] = true;
468	28	$cron_options['frequency'] = sanitize_text_field( $request[ 'smbd_' . $this->field_slug . '_cron_freq' ] );
469	28	$cron_options['start_time'] = bd_get_gmt_offseted_time( sanitize_text_field( $request[ 'smbd_' . $this->field_slug . '_cron_start' ] ) );
470
471	28	$cron_options['cron_label'] = $this->get_cron_label();
472		}
473
474	31	return $cron_options;
475		}
476
477		/**
478		* Get the threshold after which enhanced select should be used.
479		*
480		* @return int Threshold.
481		*/
482		protected function get_enhanced_select_threshold() {
483		/**
484		* Filter the enhanced select threshold.
485		*
486		* @since 6.0.0
487		*
488		* @param int Threshold.
489		*/
490		return apply_filters( 'bd_enhanced_select_threshold', 1000 );
491		}
492
493		/**
494		* Get the class name for select2 dropdown based on the number of items present.
495		*
496		* @param int $count The number of items present.
497		* @param string $class_name Primary class name.
498		*
499		* @return string Class name.
500		*/
501		protected function enable_ajax_if_needed_to_dropdown_class_name( $count, $class_name ) {
502		if ( $count >= $this->get_enhanced_select_threshold() ) {
503		$class_name .= '-ajax';
504		}
505
506		return $class_name;
507		}
508
509		/**
510		* Get the human readable label for the Schedule job.
511		*
512		* @return string Human readable label for schedule job.
513		*/
514	28	protected function get_cron_label() {
515	28	return $this->messages['cron_label'];
516		}
517
518		/**
519		* Render Post type dropdown.
520		*/
521		protected function render_post_type_dropdown() {
522		bd_render_post_type_dropdown( $this->field_slug );
523		}
524		}
525

sudar / bulk-delete

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

BaseModule::delete() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like