DeleteCommentMetaModule::change_meta_query() - Code Metrics - Inspection of "Merge pull request #526 from sudar/analysis-zD5Mpl" - sudar/bulk-delete - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 247-fix/delete-term-meta ( 593cad...aed584 )

by Sudar

created 2018-09-19 11:14 UTC

DeleteCommentMetaModule::change_meta_query() A

↳ Parent: DeleteCommentMetaModule

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

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

<?php

namespace BulkWP\BulkDelete\Core\Metas\Modules;

use BulkWP\BulkDelete\Core\Metas\MetasModule;

defined( 'ABSPATH' ) || exit; // Exit if accessed directly.

/**
 * Delete Comment Meta Module.
 *
 * @since 6.0.0
 */
class DeleteCommentMetaModule extends MetasModule {
	protected function initialize() {
		$this->field_slug    = 'comment_meta';
		$this->meta_box_slug = 'bd-comment-meta';
		$this->action        = 'delete_comment_meta';
		$this->cron_hook     = 'do-bulk-delete-comment-meta';
		$this->messages      = array(
			'box_label'  => __( 'Bulk Delete Comment Meta', 'bulk-delete' ),
			'scheduled'  => __( 'Comment meta fields from the comments with the selected criteria are scheduled for deletion.', 'bulk-delete' ),
			'cron_label' => __( 'Delete Comment Meta', 'bulk-delete' ),
		);
	}

	public function register( $hook_suffix, $page_slug ) {
		parent::register( $hook_suffix, $page_slug );

		add_action( 'bd_delete_comment_meta_form', array( $this, 'add_filtering_options' ) );

		add_filter( 'bd_delete_comment_meta_options', array( $this, 'process_filtering_options' ), 10, 2 );
		add_filter( 'bd_delete_comment_meta_query', array( $this, 'change_meta_query' ), 10, 2 );
	}

	/**
	 * Render the Delete Comment Meta box.
	 */
	public function render() {
		?>
		<!-- Comment Meta box start-->
		<fieldset class="options">
			<h4><?php _e( 'Select the post type whose comment meta fields you want to delete', 'bulk-delete' ); ?></h4>
			<table class="optiontable">
				<?php $this->render_post_type_dropdown(); ?>
			</table>

			<h4><?php _e( 'Choose your comment meta field settings', 'bulk-delete' ); ?></h4>
			<table class="optiontable">
				<tr>
					<td>
						<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value" value="false" type="radio" checked>
						<label for="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value"><?php echo __( 'Delete based on comment meta key name only', 'bulk-delete' ); ?></label>
					</td>
				</tr>

				<tr>
					<td>
						<input type="radio" value="true" name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value">

						<label for="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value"><?php echo __( 'Delete based on comment meta key name and value', 'bulk-delete' ); ?></label>
					</td>
				</tr>

				<tr>
					<td>
						<label for="smbd_<?php echo esc_attr( $this->field_slug ); ?>_meta_key"><?php _e( 'Comment Meta Key ', 'bulk-delete' ); ?></label>
						<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_meta_key" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_meta_key" placeholder="<?php _e( 'Meta Key', 'bulk-delete' ); ?>">
					</td>
				</tr>
			</table>

			<?php
			/**
			 * Add more fields to the delete comment meta field form.
			 * This hook can be used to add more fields to the delete comment meta field form.
			 *
			 * @since 5.4
			 */
			do_action( 'bd_delete_comment_meta_form' );
			?>
			<table class="optiontable">
				<tr>
					<td colspan="2">
						<h4><?php _e( 'Choose your deletion options', 'bulk-delete' ); ?></h4>
					</td>
				</tr>

				<?php $this->render_restrict_settings( 'comments' ); ?>
				<?php $this->render_limit_settings(); ?>
				<?php $this->render_cron_settings(); ?>

			</table>
		</fieldset>

		<?php $this->render_submit_button(); ?>

		<!-- Comment Meta box end-->
		<?php
	}

	protected function convert_user_input_to_options( $request, $options ) {
		$options['post_type'] = esc_sql( bd_array_get( $request, 'smbd_' . $this->field_slug . '_post_type', 'post' ) );

		$options['use_value'] = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_use_value', false );
		$options['meta_key']  = esc_sql( bd_array_get( $request, 'smbd_' . $this->field_slug . '_meta_key', '' ) );

		/**
		 * Delete comment-meta delete options filter.
		 *
		 * This filter is for processing filtering options for deleting comment meta.
		 *
		 * @since 5.4
		 */
		return apply_filters( 'bd_delete_comment_meta_options', $options, $request );
	}

	protected function do_delete( $options ) {
		$args = array(
			'post_type' => $options['post_type'],
		);

		if ( $options['limit_to'] > 0 ) {
			$args['number'] = $options['limit_to'];
		}

		$op   = $options['date_op'];
		$days = $options['days'];

		if ( $options['restrict'] ) {
			$args['date_query'] = array(
				array(
					'column' => 'comment_date',
					$op      => "{$days} day ago",
				),
			);
		}

		if ( $options['use_value'] ) {
			$args['meta_query'] = apply_filters( 'bd_delete_comment_meta_query', array(), $options );
		} else {
			$args['meta_key'] = $options['meta_key'];
		}

		$meta_deleted = 0;
		$comments     = get_comments( $args );

		foreach ( $comments as $comment ) {
			// Todo: Don't delete all meta rows if there are duplicate meta keys.
			// See https://github.com/sudar/bulk-delete/issues/515 for details.
			if ( delete_comment_meta( $comment->comment_ID, $options['meta_key'] ) ) {
				$meta_deleted ++;
			}
		}

		return $meta_deleted;
	}

	public function filter_js_array( $js_array ) {
		$js_array['dt_iterators'][]              = '_' . $this->field_slug;
		$js_array['validators'][ $this->action ] = 'noValidation';

		$js_array['pre_action_msg'][ $this->action ] = 'deleteCMWarning';
		$js_array['msg']['deleteCMWarning']          = __( 'Are you sure you want to delete all the comment meta fields that match the selected filters?', 'bulk-delete' );

		return $js_array;
	}

	protected function get_success_message( $items_deleted ) {
		/* translators: 1 Number of comment deleted */
		return _n( 'Deleted comment meta field from %d comment', 'Deleted comment meta field from %d comments', $items_deleted, 'bulk-delete' );
	}

	/**
	 * Append filtering options to the delete comment meta form.
	 *
	 * This function was originally part of the Bulk Delete Comment Meta add-on.
	 *
	 * @since 0.1 of Bulk Delete Comment Meta add-on
	 */
	public function add_filtering_options() {
		?>
		<table class="optiontable" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_filters" style="display:none;">
			<tr>
				<td>
					<?php _e( 'Comment Meta Value ', 'bulk-delete' ); ?>
					<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_type" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_type">
						<option value="CHAR"><?php _e( 'CHAR', 'bulk-delete' ); ?></option>
						<option value="NUMERIC"><?php _e( 'NUMERIC', 'bulk-delete' ); ?></option>
						<option value="DECIMAL"><?php _e( 'DECIMAL', 'bulk-delete' ); ?></option>
						<option value="SIGNED"><?php _e( 'SIGNED', 'bulk-delete' ); ?></option>
						<option value="UNSIGNED"><?php _e( 'UNSIGNED', 'bulk-delete' ); ?></option>
						<option value="DATE"><?php _e( 'DATE', 'bulk-delete' ); ?></option>
						<option value="TIME"><?php _e( 'TIME', 'bulk-delete' ); ?></option>
						<option value="DATETIME"><?php _e( 'DATETIME', 'bulk-delete' ); ?></option>
						<option value="BINARY"><?php _e( 'BINARY', 'bulk-delete' ); ?></option>
					</select>
					<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_meta_op" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_meta_op">
						<option value="="><?php _e( 'equal to', 'bulk-delete' ); ?></option>
						<option value="!="><?php _e( 'not equal to', 'bulk-delete' ); ?></option>
						<option value="<"><?php _e( 'less than', 'bulk-delete' ); ?></option>
						<option value="<="><?php _e( 'less than or equal to', 'bulk-delete' ); ?></option>
						<option value=">"><?php _e( 'greater than', 'bulk-delete' ); ?></option>
						<option value=">="><?php _e( 'greater than or equal to', 'bulk-delete' ); ?></option>
						<option value="LIKE"><?php _e( 'like', 'bulk-delete' ); ?></option>
						<option value="NOT LIKE"><?php _e( 'not like', 'bulk-delete' ); ?></option>
					</select>
					<input type="text" placeholder="<?php _e( 'Meta Value', 'bulk-delete' ); ?>"
						name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_value"
						id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_value">
				</td>
			</tr>
		</table>
		<?php
	}

	/**
	 * Process additional delete options.
	 *
	 * This function was originally part of the Bulk Delete Comment Meta add-on.
	 *
	 * @since 0.1 of Bulk Delete Comment Meta add-on
	 *
	 * @param array $delete_options Delete options array.
	 * @param array $post           The POST array.
	 *
	 * @return array Processed delete options array.
	 */
	public function process_filtering_options( $delete_options, $post ) {
		if ( 'true' == bd_array_get( $post, 'smbd_' . $this->field_slug . '_use_value', 'false' ) ) {
			$delete_options['meta_op']    = bd_array_get( $post, 'smbd_' . $this->field_slug . '_meta_op', '=' );
			$delete_options['meta_type']  = bd_array_get( $post, 'smbd_' . $this->field_slug . '_type', 'CHAR' );
			$delete_options['meta_value'] = bd_array_get( $post, 'smbd_' . $this->field_slug . '_value', '' );
		}

		return $delete_options;
	}

	/**
	 * Change the meta query.
	 *
	 * This function was originally part of the Bulk Delete Comment Meta add-on.
	 *
	 * @since 0.1 of Bulk Delete Comment Meta add-on
	 *
	 * @param array $meta_query     Meta query.
	 * @param array $delete_options List of options chosen by the user.
	 *
	 * @return array Modified meta query.
	 */
	public function change_meta_query( $meta_query, $delete_options ) {
		$meta_query = array(
			array(
				'key'     => $delete_options['meta_key'],
				'value'   => $delete_options['meta_value'],
				'compare' => $delete_options['meta_op'],
				'type'    => $delete_options['meta_type'],
			),
		);

		return $meta_query;
	}

	/**
	 * Hook handler.
	 *
	 * This function was originally part of the Bulk Delete Comment Meta add-on.
	 *
	 * @since 0.1 of Bulk Delete Comment Meta add-on
	 *
	 * @param array $delete_options Delete options array.
	 */
	public function do_delete_comment_meta( $delete_options ) {
		do_action( 'bd_before_scheduler', $this->messages['cron_label'] );
		$count = $this->delete( $delete_options );
		do_action( 'bd_after_scheduler', $this->messages['cron_label'], $count );
	}
}


1		<?php
2
3		namespace BulkWP\BulkDelete\Core\Metas\Modules;
4
5		use BulkWP\BulkDelete\Core\Metas\MetasModule;
6
7	1	defined( 'ABSPATH' ) \|\| exit; // Exit if accessed directly.
8
9		/**
10		* Delete Comment Meta Module.
11		*
12		* @since 6.0.0
13		*/
14		class DeleteCommentMetaModule extends MetasModule {
15	7	protected function initialize() {
16	7	$this->field_slug = 'comment_meta';
17	7	$this->meta_box_slug = 'bd-comment-meta';
18	7	$this->action = 'delete_comment_meta';
19	7	$this->cron_hook = 'do-bulk-delete-comment-meta';
20	7	$this->messages = array(
21	7	'box_label' => __( 'Bulk Delete Comment Meta', 'bulk-delete' ),
22	7	'scheduled' => __( 'Comment meta fields from the comments with the selected criteria are scheduled for deletion.', 'bulk-delete' ),
23	7	'cron_label' => __( 'Delete Comment Meta', 'bulk-delete' ),
24		);
25	7	}
26
27	7	public function register( $hook_suffix, $page_slug ) {
28	7	parent::register( $hook_suffix, $page_slug );
29
30	7	add_action( 'bd_delete_comment_meta_form', array( $this, 'add_filtering_options' ) );
31
32	7	add_filter( 'bd_delete_comment_meta_options', array( $this, 'process_filtering_options' ), 10, 2 );
33	7	add_filter( 'bd_delete_comment_meta_query', array( $this, 'change_meta_query' ), 10, 2 );
34	7	}
35
36		/**
37		* Render the Delete Comment Meta box.
38		*/
39		public function render() {
40		?>
41		<!-- Comment Meta box start-->
42		<fieldset class="options">
43		<h4><?php _e( 'Select the post type whose comment meta fields you want to delete', 'bulk-delete' ); ?></h4>
44		<table class="optiontable">
45		<?php $this->render_post_type_dropdown(); ?>
46		</table>
47
48		<h4><?php _e( 'Choose your comment meta field settings', 'bulk-delete' ); ?></h4>
49		<table class="optiontable">
50		<tr>
51		<td>
52		<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value" value="false" type="radio" checked>
53		<label for="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value"><?php echo __( 'Delete based on comment meta key name only', 'bulk-delete' ); ?></label>
54		</td>
55		</tr>
56
57		<tr>
58		<td>
59		<input type="radio" value="true" name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value">
60
61		<label for="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value"><?php echo __( 'Delete based on comment meta key name and value', 'bulk-delete' ); ?></label>
62		</td>
63		</tr>
64
65		<tr>
66		<td>
67		<label for="smbd_<?php echo esc_attr( $this->field_slug ); ?>_meta_key"><?php _e( 'Comment Meta Key ', 'bulk-delete' ); ?></label>
68		<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_meta_key" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_meta_key" placeholder="<?php _e( 'Meta Key', 'bulk-delete' ); ?>">
69		</td>
70		</tr>
71		</table>
72
73		<?php
74		/**
75		* Add more fields to the delete comment meta field form.
76		* This hook can be used to add more fields to the delete comment meta field form.
77		*
78		* @since 5.4
79		*/
80		do_action( 'bd_delete_comment_meta_form' );
81		?>
82		<table class="optiontable">
83		<tr>
84		<td colspan="2">
85		<h4><?php _e( 'Choose your deletion options', 'bulk-delete' ); ?></h4>
86		</td>
87		</tr>
88
89		<?php $this->render_restrict_settings( 'comments' ); ?>
90		<?php $this->render_limit_settings(); ?>
91		<?php $this->render_cron_settings(); ?>
92
93		</table>
94		</fieldset>
95
96		<?php $this->render_submit_button(); ?>
97
98		<!-- Comment Meta box end-->
99		<?php
100		}
101
102		protected function convert_user_input_to_options( $request, $options ) {
103		$options['post_type'] = esc_sql( bd_array_get( $request, 'smbd_' . $this->field_slug . '_post_type', 'post' ) );
104
105		$options['use_value'] = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_use_value', false );
106		$options['meta_key'] = esc_sql( bd_array_get( $request, 'smbd_' . $this->field_slug . '_meta_key', '' ) );
107
108		/**
109		* Delete comment-meta delete options filter.
110		*
111		* This filter is for processing filtering options for deleting comment meta.
112		*
113		* @since 5.4
114		*/
115		return apply_filters( 'bd_delete_comment_meta_options', $options, $request );
116		}
117
118	7	protected function do_delete( $options ) {
119		$args = array(
120	7	'post_type' => $options['post_type'],
121		);
122
123	7	if ( $options['limit_to'] > 0 ) {
124	1	$args['number'] = $options['limit_to'];
125		}
126
127	7	$op = $options['date_op'];
128	7	$days = $options['days'];
129
130	7	if ( $options['restrict'] ) {
131	2	$args['date_query'] = array(
132		array(
133	2	'column' => 'comment_date',
134	2	$op => "{$days} day ago",
135		),
136		);
137		}
138
139	7	if ( $options['use_value'] ) {
140	2	$args['meta_query'] = apply_filters( 'bd_delete_comment_meta_query', array(), $options );
141		} else {
142	5	$args['meta_key'] = $options['meta_key'];
143		}
144
145	7	$meta_deleted = 0;
146	7	$comments = get_comments( $args );
147
148	7	foreach ( $comments as $comment ) {
149		// Todo: Don't delete all meta rows if there are duplicate meta keys.
150		// See https://github.com/sudar/bulk-delete/issues/515 for details.
151	7	if ( delete_comment_meta( $comment->comment_ID, $options['meta_key'] ) ) {
152	7	$meta_deleted ++;
153		}
154		}
155
156	7	return $meta_deleted;
157		}
158
159		public function filter_js_array( $js_array ) {
160		$js_array['dt_iterators'][] = '_' . $this->field_slug;
161		$js_array['validators'][ $this->action ] = 'noValidation';
162
163		$js_array['pre_action_msg'][ $this->action ] = 'deleteCMWarning';
164		$js_array['msg']['deleteCMWarning'] = __( 'Are you sure you want to delete all the comment meta fields that match the selected filters?', 'bulk-delete' );
165
166		return $js_array;
167		}
168
169		protected function get_success_message( $items_deleted ) {
170		/* translators: 1 Number of comment deleted */
171		return _n( 'Deleted comment meta field from %d comment', 'Deleted comment meta field from %d comments', $items_deleted, 'bulk-delete' );
172		}
173
174		/**
175		* Append filtering options to the delete comment meta form.
176		*
177		* This function was originally part of the Bulk Delete Comment Meta add-on.
178		*
179		* @since 0.1 of Bulk Delete Comment Meta add-on
180		*/
181		public function add_filtering_options() {
182		?>
183		<table class="optiontable" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_filters" style="display:none;">
184		<tr>
185		<td>
186		<?php _e( 'Comment Meta Value ', 'bulk-delete' ); ?>
187		<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_type" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_type">
188		<option value="CHAR"><?php _e( 'CHAR', 'bulk-delete' ); ?></option>
189		<option value="NUMERIC"><?php _e( 'NUMERIC', 'bulk-delete' ); ?></option>
190		<option value="DECIMAL"><?php _e( 'DECIMAL', 'bulk-delete' ); ?></option>
191		<option value="SIGNED"><?php _e( 'SIGNED', 'bulk-delete' ); ?></option>
192		<option value="UNSIGNED"><?php _e( 'UNSIGNED', 'bulk-delete' ); ?></option>
193		<option value="DATE"><?php _e( 'DATE', 'bulk-delete' ); ?></option>
194		<option value="TIME"><?php _e( 'TIME', 'bulk-delete' ); ?></option>
195		<option value="DATETIME"><?php _e( 'DATETIME', 'bulk-delete' ); ?></option>
196		<option value="BINARY"><?php _e( 'BINARY', 'bulk-delete' ); ?></option>
197		</select>
198		<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_meta_op" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_meta_op">
199		<option value="="><?php _e( 'equal to', 'bulk-delete' ); ?></option>
200		<option value="!="><?php _e( 'not equal to', 'bulk-delete' ); ?></option>
201		<option value="<"><?php _e( 'less than', 'bulk-delete' ); ?></option>
202		<option value="<="><?php _e( 'less than or equal to', 'bulk-delete' ); ?></option>
203		<option value=">"><?php _e( 'greater than', 'bulk-delete' ); ?></option>
204		<option value=">="><?php _e( 'greater than or equal to', 'bulk-delete' ); ?></option>
205		<option value="LIKE"><?php _e( 'like', 'bulk-delete' ); ?></option>
206		<option value="NOT LIKE"><?php _e( 'not like', 'bulk-delete' ); ?></option>
207		</select>
208		<input type="text" placeholder="<?php _e( 'Meta Value', 'bulk-delete' ); ?>"
209		name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_value"
210		id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_value">
211		</td>
212		</tr>
213		</table>
214		<?php
215		}
216
217		/**
218		* Process additional delete options.
219		*
220		* This function was originally part of the Bulk Delete Comment Meta add-on.
221		*
222		* @since 0.1 of Bulk Delete Comment Meta add-on
223		*
224		* @param array $delete_options Delete options array.
225		* @param array $post The POST array.
226		*
227		* @return array Processed delete options array.
228		*/
229		public function process_filtering_options( $delete_options, $post ) {
230		if ( 'true' == bd_array_get( $post, 'smbd_' . $this->field_slug . '_use_value', 'false' ) ) {
231		$delete_options['meta_op'] = bd_array_get( $post, 'smbd_' . $this->field_slug . '_meta_op', '=' );
232		$delete_options['meta_type'] = bd_array_get( $post, 'smbd_' . $this->field_slug . '_type', 'CHAR' );
233		$delete_options['meta_value'] = bd_array_get( $post, 'smbd_' . $this->field_slug . '_value', '' );
234		}
235
236		return $delete_options;
237		}
238
239		/**
240		* Change the meta query.
241		*
242		* This function was originally part of the Bulk Delete Comment Meta add-on.
243		*
244		* @since 0.1 of Bulk Delete Comment Meta add-on
245		*
246		* @param array $meta_query Meta query.
247		* @param array $delete_options List of options chosen by the user.
248		*
249		* @return array Modified meta query.
250		*/
251	2	public function change_meta_query( $meta_query, $delete_options ) {
252		$meta_query = array(
253		array(
254	2	'key' => $delete_options['meta_key'],
255	2	'value' => $delete_options['meta_value'],
256	2	'compare' => $delete_options['meta_op'],
257	2	'type' => $delete_options['meta_type'],
258		),
259		);
260
261	2	return $meta_query;
262		}
263
264		/**
265		* Hook handler.
266		*
267		* This function was originally part of the Bulk Delete Comment Meta add-on.
268		*
269		* @since 0.1 of Bulk Delete Comment Meta add-on
270		*
271		* @param array $delete_options Delete options array.
272		*/
273		public function do_delete_comment_meta( $delete_options ) {
274		do_action( 'bd_before_scheduler', $this->messages['cron_label'] );
275		$count = $this->delete( $delete_options );
276		do_action( 'bd_after_scheduler', $this->messages['cron_label'], $count );
277		}
278		}
279

sudar / bulk-delete

Push — 247-fix/delete-term-meta ( 593cad...aed584 )

DeleteCommentMetaModule::change_meta_query() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like