TermsModule::render_private_post_settings() - Code Metrics - Inspection of "178 feature/delete terms by postfix prefix" - sudar/bulk-delete - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — dev/6.0.0 (#332)

by Rajan

created 2018-07-10 19:21 UTC

TermsModule::render_private_post_settings() A

↳ Parent: TermsModule

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
namespace BulkWP\BulkDelete\Core\Terms;

use BulkWP\BulkDelete\Core\Base\BaseModule;

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

/**
 * Module for deleting terms.
 *
 * @since 6.0.0
 */
abstract class TermsModule extends BaseModule {
	/**
	 * Build query params for WP_Query by using delete options.
	 *
	 * Return an empty query array to short-circuit deletion.
	 *
	 * @param array $options Delete options.
	 *
	 * @return array Query.
	 */
	abstract protected function build_query( $options );

	protected $item_type = 'terms';

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

		$options['restrict']     = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_restrict', false );
		$options['limit_to']     = absint( bd_array_get( $request, 'smbd_' . $this->field_slug . '_limit_to', 0 ) );
		$options['force_delete'] = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_force_delete', false );

		$options['date_op'] = bd_array_get( $request, 'smbd_' . $this->field_slug . '_op' );
		$options['days']    = absint( bd_array_get( $request, 'smbd_' . $this->field_slug . '_days' ) );

		return $options;
	}

	public function filter_js_array( $js_array ) {
		return $js_array;
	}

	protected function do_delete( $options ) {
		$query = $this->build_query( $options );

		if ( empty( $query ) ) {
			// Short circuit deletion, if nothing needs to be deleted.
			return 0;
		}

		return $this->delete_terms_from_query( $query, $options );
	}

	/**
	 * Build the query using query params and then Delete posts.
	 *
	 * @param array $query   Params for WP Query.
	 * @param array $options Delete Options.
	 *
	 * @return int Number of posts deleted.
	 */
	protected function delete_terms_from_query( $query, $options ) {
		$term_ids = $this->term_query( $query, $options['taxonomy'] );

		return $this->delete_terms_by_id( $term_ids, $options );
	}

	/**
	 * Render the "private post" setting fields.
	 */
	protected function render_private_post_settings() {
		bd_render_private_post_settings( $this->field_slug );
	}

	/**
	 * Delete terms by ids.
	 *
	 * @param int[] $term_ids List of term ids to delete.
	 * @param mixed $options
	 *
	 * @return int Number of posts deleted.
	 */
	protected function delete_terms_by_id( $term_ids, $options ) {
		$count = 0;

		foreach ( $term_ids as $term_id ) {
			$term = get_term( $term_id, $options['taxonomy'] );

			if( is_wp_error($term) ){
				continue;
			}

			if ( isset( $options['no_posts'] ) && $term->count > 0 ) {

				continue;
			}

			wp_delete_term( $term_id, $options['taxonomy'] );
			$count ++;
		}

		return $count;
	}

	/**
	 * custom string function use to get is string start with specified string.
	 *
	 * @param string $haystack.
	 * @param string $needle.
	 *
	 * @return bool.

	 */
	protected function bd_starts_with($haystack, $needle){
	     $length = strlen($needle);

	     return (substr($haystack, 0, $length) === $needle);
	}

	/**
	 * custom string function use to get is string ends with specified string.
	 *
	 * @param string $haystack.
	 * @param string $needle.
	 *
	 * @return bool.

	 */
	protected function bd_ends_with($haystack, $needle){
	    $length = strlen($needle);

	    return $length === 0 ||
	    (substr($haystack, -$length) === $needle);
	}

	/**
	 * get terms which is start with specified string.
	 *
	 * @param string $term_text.
	 * @param array  $options.
	 *
	 * @return array term ids.
	 */
	protected function term_starts( $term_text , $options ){
		$term_ids = array();
		$terms    = get_terms( $options['taxonomy'], array(
		    'hide_empty' => false,
		) );

		foreach( $terms as $term ){
			if( $this->bd_starts_with( $term->name, $term_text ) ){
				$term_ids[] = $term->term_id;
			}
		}

		return $term_ids;
	}

	/**
	 * get terms which is ends with specified string.
	 *
	 * @param string $term_text.
	 * @param array  $options.
	 *
	 * @return array term ids.
	 */
	protected function term_ends( $term_text , $options ){
		$term_ids = array();
		$terms    = get_terms( $options['taxonomy'], array(
		    'hide_empty' => false,
		) );

		foreach( $terms as $term ){
			if( $this->bd_ends_with( $term->name, $term_text ) ){
				$term_ids[] = $term->term_id;
			}
		}

		return $term_ids;
	}

	/**
	 * get terms which is contain specified string.
	 *
	 * @param string $term_text.
	 * @param array  $options.
	 *
	 * @return array term ids.
	 */
	protected function term_contains( $term_text , $options ){
		$term_ids = array();
		$terms    = get_terms( $options['taxonomy'], array(
		    'hide_empty' => false,
		) );

		foreach( $terms as $term ){
			if ( strpos( $term->name, $term_text ) !== false ) {
				$term_ids[] = $term->term_id;
			}
		}

		return $term_ids;
	}

	/**
	 * Get term ids which is have the sepcified post count .
	 *
	 * @param array $options.
	 *
	 * @return array term ids.
	 */
	protected function term_count_query( $options ){
		$term_ids = array();
		$terms    = get_terms( $options['taxonomy'], array(
		    'hide_empty' => false,
		) );

		foreach( $terms as $term ){
			$args = array(
				'post_type' => 'post',
				'tax_query' => array(
					array(
						'taxonomy' => $options['taxonomy'],
						'field'    => 'slug',
						'terms'    => $term->slug,
					),
				),
			);

			$posts = get_posts($args);

			$term_ids[] = $this->get_term_id_by_name( $options['term_text'], $options['term_opt'], $term->term_id, count($posts) );
		}

		return $term_ids;
	}

	protected function get_term_id_by_name( $term_text, $term_opt, $term_id, $post_count ){
		if( $post_count == $term_text && $term_opt == 'equal_to' ){
			return $term_id;
		}elseif( $post_count != $term_text && $term_opt == 'not_equal_to' ){
			return $term_id;
		}elseif( $post_count < $term_text && $term_opt == 'less_than' ){
			return $term_id;
		}elseif( $post_count > $term_text && $term_opt == 'greater_than' ){
			return $term_id;
		}
	}

	/**
	 * Wrapper for WP_Term.
	 *
	 * Adds some performance enhancing defaults.
	 *
	 * @since  6.0
	 *
	 * @param array $options  List of options
	 * @param mixed $taxonomy
	 *
	 * @return array Result array
	 */
	public function term_query( $options, $taxonomy ) {
		$defaults = array(
			'fields'     => 'ids', // retrieve only ids
			'taxonomy'	  => $taxonomy,
			'hide_empty' => 0,
			'count'		    => true,
		);
		$options = wp_parse_args( $options, $defaults );

		$term_query = new \WP_Term_Query();

		/**
		 * This action runs before the query happens.
		 *
		 * @since 5.5
		 * @since 5.6 added $term_query param.
		 *
		 * @param \WP_Query $term_query Query object.
		 */
		do_action( 'bd_before_term_query', $term_query );

		$terms = $term_query->query( $options );

		/**
		 * This action runs after the query happens.
		 *
		 * @since 5.5
		 * @since 5.6 added $term_query param.
		 *
		 * @param \WP_Query $term_query Query object.
		 */
		do_action( 'bd_after_term_query', $term_query );

		return $terms;
	}
}


1			<?php
2			namespace BulkWP\BulkDelete\Core\Terms;
3
4			use BulkWP\BulkDelete\Core\Base\BaseModule;
5
6			defined( 'ABSPATH' ) \|\| exit; // Exit if accessed directly.
7
8			/**
9			* Module for deleting terms.
10			*
11			* @since 6.0.0
12			*/
13			abstract class TermsModule extends BaseModule {
14			/**
15			* Build query params for WP_Query by using delete options.
16			*
17			* Return an empty query array to short-circuit deletion.
18			*
19			* @param array $options Delete options.
20			*
21			* @return array Query.
22			*/
23			abstract protected function build_query( $options );
24
25			protected $item_type = 'terms';
26
27			/**
28			* Handle common filters.
29			*
30			* @param array $request Request array.
31			*
32			* @return array User options.
33			*/
34			protected function parse_common_filters( $request ) {
35			$options = array();
36
37			$options['restrict'] = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_restrict', false );
38			$options['limit_to'] = absint( bd_array_get( $request, 'smbd_' . $this->field_slug . '_limit_to', 0 ) );
39			$options['force_delete'] = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_force_delete', false );
40
41			$options['date_op'] = bd_array_get( $request, 'smbd_' . $this->field_slug . '_op' );
42			$options['days'] = absint( bd_array_get( $request, 'smbd_' . $this->field_slug . '_days' ) );
43
44			return $options;
45			}
46
47			public function filter_js_array( $js_array ) {
48			return $js_array;
49			}
50
51			protected function do_delete( $options ) {
52			$query = $this->build_query( $options );
53
54			if ( empty( $query ) ) {
55			// Short circuit deletion, if nothing needs to be deleted.
56			return 0;
57			}
58
59			return $this->delete_terms_from_query( $query, $options );
60			}
61
62			/**
63			* Build the query using query params and then Delete posts.
64			*
65			* @param array $query Params for WP Query.
66			* @param array $options Delete Options.
67			*
68			* @return int Number of posts deleted.
69			*/
70			protected function delete_terms_from_query( $query, $options ) {
71			$term_ids = $this->term_query( $query, $options['taxonomy'] );
72
73			return $this->delete_terms_by_id( $term_ids, $options );
74			}
75
76			/**
77			* Render the "private post" setting fields.
78			*/
79			protected function render_private_post_settings() {
80			bd_render_private_post_settings( $this->field_slug );
81			}
82
83			/**
84			* Delete terms by ids.
85			*
86			* @param int[] $term_ids List of term ids to delete.
87			* @param mixed $options
88			*
89			* @return int Number of posts deleted.
90			*/
91			protected function delete_terms_by_id( $term_ids, $options ) {
92			$count = 0;
93
94			foreach ( $term_ids as $term_id ) {
95			$term = get_term( $term_id, $options['taxonomy'] );
96
97			if( is_wp_error($term) ){
98			continue;
99			}
100
101			if ( isset( $options['no_posts'] ) && $term->count > 0 ) {
			0 ignored issues – show Bug introduced 2018-07-09 03:42 UTC by Report Bug Copy Issue Report The property `count` does not seem to exist on `WP_Error`. Loading history...
102			continue;
103			}
104
105			wp_delete_term( $term_id, $options['taxonomy'] );
106			$count ++;
107			}
108
109			return $count;
110			}
111
112			/**
113			* custom string function use to get is string start with specified string.
114			*
115			* @param string $haystack.
116			* @param string $needle.
117			*
118			* @return bool.
			0 ignored issues – show Documentation Bug introduced 2018-07-10 19:12 UTC by Report Bug Copy Issue Report The doc comment `bool.` at position `0` could not be parsed: Unknown type name 'bool.' at position 0 in bool.. Loading history...
119			*/
120			protected function bd_starts_with($haystack, $needle){
121			$length = strlen($needle);
122
123			return (substr($haystack, 0, $length) === $needle);
124			}
125
126			/**
127			* custom string function use to get is string ends with specified string.
128			*
129			* @param string $haystack.
130			* @param string $needle.
131			*
132			* @return bool.
			0 ignored issues – show Documentation Bug introduced 2018-07-10 19:12 UTC by Report Bug Copy Issue Report The doc comment `bool.` at position `0` could not be parsed: Unknown type name 'bool.' at position 0 in bool.. Loading history...
133			*/
134			protected function bd_ends_with($haystack, $needle){
135			$length = strlen($needle);
136
137			return $length === 0 \|\|
138			(substr($haystack, -$length) === $needle);
139			}
140
141			/**
142			* get terms which is start with specified string.
143			*
144			* @param string $term_text.
145			* @param array $options.
146			*
147			* @return array term ids.
148			*/
149			protected function term_starts( $term_text , $options ){
150			$term_ids = array();
151			$terms = get_terms( $options['taxonomy'], array(
152			'hide_empty' => false,
153			) );
154
155			foreach( $terms as $term ){
156			if( $this->bd_starts_with( $term->name, $term_text ) ){
157			$term_ids[] = $term->term_id;
158			}
159			}
160
161			return $term_ids;
162			}
163
164			/**
165			* get terms which is ends with specified string.
166			*
167			* @param string $term_text.
168			* @param array $options.
169			*
170			* @return array term ids.
171			*/
172			protected function term_ends( $term_text , $options ){
173			$term_ids = array();
174			$terms = get_terms( $options['taxonomy'], array(
175			'hide_empty' => false,
176			) );
177
178			foreach( $terms as $term ){
179			if( $this->bd_ends_with( $term->name, $term_text ) ){
180			$term_ids[] = $term->term_id;
181			}
182			}
183
184			return $term_ids;
185			}
186
187			/**
188			* get terms which is contain specified string.
189			*
190			* @param string $term_text.
191			* @param array $options.
192			*
193			* @return array term ids.
194			*/
195			protected function term_contains( $term_text , $options ){
196			$term_ids = array();
197			$terms = get_terms( $options['taxonomy'], array(
198			'hide_empty' => false,
199			) );
200
201			foreach( $terms as $term ){
202			if ( strpos( $term->name, $term_text ) !== false ) {
203			$term_ids[] = $term->term_id;
204			}
205			}
206
207			return $term_ids;
208			}
209
210			/**
211			* Get term ids which is have the sepcified post count .
212			*
213			* @param array $options.
214			*
215			* @return array term ids.
216			*/
217			protected function term_count_query( $options ){
218			$term_ids = array();
219			$terms = get_terms( $options['taxonomy'], array(
220			'hide_empty' => false,
221			) );
222
223			foreach( $terms as $term ){
224			$args = array(
225			'post_type' => 'post',
226			'tax_query' => array(
227			array(
228			'taxonomy' => $options['taxonomy'],
229			'field' => 'slug',
230			'terms' => $term->slug,
231			),
232			),
233			);
234
235			$posts = get_posts($args);
236
237			$term_ids[] = $this->get_term_id_by_name( $options['term_text'], $options['term_opt'], $term->term_id, count($posts) );
238			}
239
240			return $term_ids;
241			}
242
243			protected function get_term_id_by_name( $term_text, $term_opt, $term_id, $post_count ){
244			if( $post_count == $term_text && $term_opt == 'equal_to' ){
245			return $term_id;
246			}elseif( $post_count != $term_text && $term_opt == 'not_equal_to' ){
247			return $term_id;
248			}elseif( $post_count < $term_text && $term_opt == 'less_than' ){
249			return $term_id;
250			}elseif( $post_count > $term_text && $term_opt == 'greater_than' ){
251			return $term_id;
252			}
253			}
254
255			/**
256			* Wrapper for WP_Term.
257			*
258			* Adds some performance enhancing defaults.
259			*
260			* @since 6.0
261			*
262			* @param array $options List of options
263			* @param mixed $taxonomy
264			*
265			* @return array Result array
266			*/
267			public function term_query( $options, $taxonomy ) {
268			$defaults = array(
269			'fields' => 'ids', // retrieve only ids
270			'taxonomy' => $taxonomy,
271			'hide_empty' => 0,
272			'count' => true,
273			);
274			$options = wp_parse_args( $options, $defaults );
275
276			$term_query = new \WP_Term_Query();
277
278			/**
279			* This action runs before the query happens.
280			*
281			* @since 5.5
282			* @since 5.6 added $term_query param.
283			*
284			* @param \WP_Query $term_query Query object.
285			*/
286			do_action( 'bd_before_term_query', $term_query );
287
288			$terms = $term_query->query( $options );
289
290			/**
291			* This action runs after the query happens.
292			*
293			* @since 5.5
294			* @since 5.6 added $term_query param.
295			*
296			* @param \WP_Query $term_query Query object.
297			*/
298			do_action( 'bd_after_term_query', $term_query );
299
300			return $terms;
301			}
302			}
303

sudar / bulk-delete

Pull Request — dev/6.0.0 (#332)

TermsModule::render_private_post_settings() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like