DeleteCommentMetaModule::get_success_message() - Code Metrics - Inspection of "Regenerate pot file for v6.0.0" - sudar/bulk-delete - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( e95607...5b55be )

by Sudar

created 2019-02-22 06:20 UTC

DeleteCommentMetaModule::get_success_message() A

↳ Parent: DeleteCommentMetaModule

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?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;
	}

	protected function append_to_js_array( $js_array ) {
		$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			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			protected function initialize() {
16			$this->field_slug = 'comment_meta';
17			$this->meta_box_slug = 'bd-comment-meta';
18			$this->action = 'delete_comment_meta';
19			$this->cron_hook = 'do-bulk-delete-comment-meta';
20			$this->messages = array(
21			'box_label' => __( 'Bulk Delete Comment Meta', 'bulk-delete' ),
22			'scheduled' => __( 'Comment meta fields from the comments with the selected criteria are scheduled for deletion.', 'bulk-delete' ),
23			'cron_label' => __( 'Delete Comment Meta', 'bulk-delete' ),
24			);
25			}
26
27			public function register( $hook_suffix, $page_slug ) {
28			parent::register( $hook_suffix, $page_slug );
29
30			add_action( 'bd_delete_comment_meta_form', array( $this, 'add_filtering_options' ) );
31
32			add_filter( 'bd_delete_comment_meta_options', array( $this, 'process_filtering_options' ), 10, 2 );
33			add_filter( 'bd_delete_comment_meta_query', array( $this, 'change_meta_query' ), 10, 2 );
34			}
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			protected function do_delete( $options ) {
119			$args = array(
120			'post_type' => $options['post_type'],
121			);
122
123			if ( $options['limit_to'] > 0 ) {
124			$args['number'] = $options['limit_to'];
125			}
126
127			$op = $options['date_op'];
128			$days = $options['days'];
129
130			if ( $options['restrict'] ) {
131			$args['date_query'] = array(
132			array(
133			'column' => 'comment_date',
134			$op => "{$days} day ago",
135			),
136			);
137			}
138
139			if ( $options['use_value'] ) {
140			$args['meta_query'] = apply_filters( 'bd_delete_comment_meta_query', array(), $options );
141			} else {
142			$args['meta_key'] = $options['meta_key'];
143			}
144
145			$meta_deleted = 0;
146			$comments = get_comments( $args );
147
148			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			if ( delete_comment_meta( $comment->comment_ID, $options['meta_key'] ) ) {
152			$meta_deleted ++;
153			}
154			}
155
156			return $meta_deleted;
157			}
158
159			protected function append_to_js_array( $js_array ) {
160			$js_array['validators'][ $this->action ] = 'noValidation';
161
162			$js_array['pre_action_msg'][ $this->action ] = 'deleteCMWarning';
163			$js_array['msg']['deleteCMWarning'] = __( 'Are you sure you want to delete all the comment meta fields that match the selected filters?', 'bulk-delete' );
164
165			return $js_array;
166			}
167
168			protected function get_success_message( $items_deleted ) {
169			/* translators: 1 Number of comment deleted */
170			return _n( 'Deleted comment meta field from %d comment', 'Deleted comment meta field from %d comments', $items_deleted, 'bulk-delete' );
171			}
172
173			/**
174			* Append filtering options to the delete comment meta form.
175			*
176			* This function was originally part of the Bulk Delete Comment Meta add-on.
177			*
178			* @since 0.1 of Bulk Delete Comment Meta add-on
179			*/
180			public function add_filtering_options() {
181			?>
182			<table class="optiontable" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_filters" style="display:none;">
183			<tr>
184			<td>
185			<?php _e( 'Comment Meta Value ', 'bulk-delete' ); ?>
186			<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_type" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_type">
187			<option value="CHAR"><?php _e( 'CHAR', 'bulk-delete' ); ?></option>
188			<option value="NUMERIC"><?php _e( 'NUMERIC', 'bulk-delete' ); ?></option>
189			<option value="DECIMAL"><?php _e( 'DECIMAL', 'bulk-delete' ); ?></option>
190			<option value="SIGNED"><?php _e( 'SIGNED', 'bulk-delete' ); ?></option>
191			<option value="UNSIGNED"><?php _e( 'UNSIGNED', 'bulk-delete' ); ?></option>
192			<option value="DATE"><?php _e( 'DATE', 'bulk-delete' ); ?></option>
193			<option value="TIME"><?php _e( 'TIME', 'bulk-delete' ); ?></option>
194			<option value="DATETIME"><?php _e( 'DATETIME', 'bulk-delete' ); ?></option>
195			<option value="BINARY"><?php _e( 'BINARY', 'bulk-delete' ); ?></option>
196			</select>
197			<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_meta_op" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_meta_op">
198			<option value="="><?php _e( 'equal to', 'bulk-delete' ); ?></option>
199			<option value="!="><?php _e( 'not equal to', 'bulk-delete' ); ?></option>
200			<option value="<"><?php _e( 'less than', 'bulk-delete' ); ?></option>
201			<option value="<="><?php _e( 'less than or equal to', 'bulk-delete' ); ?></option>
202			<option value=">"><?php _e( 'greater than', 'bulk-delete' ); ?></option>
203			<option value=">="><?php _e( 'greater than or equal to', 'bulk-delete' ); ?></option>
204			<option value="LIKE"><?php _e( 'like', 'bulk-delete' ); ?></option>
205			<option value="NOT LIKE"><?php _e( 'not like', 'bulk-delete' ); ?></option>
206			</select>
207			<input type="text" placeholder="<?php _e( 'Meta Value', 'bulk-delete' ); ?>"
208			name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_value"
209			id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_value">
210			</td>
211			</tr>
212			</table>
213			<?php
214			}
215
216			/**
217			* Process additional delete options.
218			*
219			* This function was originally part of the Bulk Delete Comment Meta add-on.
220			*
221			* @since 0.1 of Bulk Delete Comment Meta add-on
222			*
223			* @param array $delete_options Delete options array.
224			* @param array $post The POST array.
225			*
226			* @return array Processed delete options array.
227			*/
228			public function process_filtering_options( $delete_options, $post ) {
229			if ( 'true' == bd_array_get( $post, 'smbd_' . $this->field_slug . '_use_value', 'false' ) ) {
230			$delete_options['meta_op'] = bd_array_get( $post, 'smbd_' . $this->field_slug . '_meta_op', '=' );
231			$delete_options['meta_type'] = bd_array_get( $post, 'smbd_' . $this->field_slug . '_type', 'CHAR' );
232			$delete_options['meta_value'] = bd_array_get( $post, 'smbd_' . $this->field_slug . '_value', '' );
233			}
234
235			return $delete_options;
236			}
237
238			/**
239			* Change the meta query.
240			*
241			* This function was originally part of the Bulk Delete Comment Meta add-on.
242			*
243			* @since 0.1 of Bulk Delete Comment Meta add-on
244			*
245			* @param array $meta_query Meta query.
246			* @param array $delete_options List of options chosen by the user.
247			*
248			* @return array Modified meta query.
249			*/
250			public function change_meta_query( $meta_query, $delete_options ) {
251			$meta_query = array(
252			array(
253			'key' => $delete_options['meta_key'],
254			'value' => $delete_options['meta_value'],
255			'compare' => $delete_options['meta_op'],
256			'type' => $delete_options['meta_type'],
257			),
258			);
259
260			return $meta_query;
261			}
262
263			/**
264			* Hook handler.
265			*
266			* This function was originally part of the Bulk Delete Comment Meta add-on.
267			*
268			* @since 0.1 of Bulk Delete Comment Meta add-on
269			*
270			* @param array $delete_options Delete options array.
271			*/
272			public function do_delete_comment_meta( $delete_options ) {
273			do_action( 'bd_before_scheduler', $this->messages['cron_label'] );
274			$count = $this->delete( $delete_options );
275			do_action( 'bd_after_scheduler', $this->messages['cron_label'], $count );
276			}
277			}
278

sudar / bulk-delete

Push — master ( e95607...5b55be )

DeleteCommentMetaModule::get_success_message() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like