TermsModule::delete_terms_from_query() - Code Metrics - Inspection of "Fix Codacy Cyclomatic complexity issue" - sudar/bulk-delete - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 178-feature/delete-terms--by-p... ( 13ec01...9e7a19 )

by Rajan

created 2018-07-10 19:00 UTC

TermsModule::delete_terms_from_query() A

↳ Parent: TermsModule

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	2
dl	0
loc	4
ccs	0
cts	3
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 ( 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 );

		}

		return $term_ids;
	}

	protected function get_term_id_by_name( $term_text, $term_opt, $term_id ){

		if( count($posts) == $term_text && $term_opt == 'equal_to' ){

			return $term_id;
		}elseif( count($posts) != $term_text && $term_opt == 'not_equal_to' ){
			return $term_id;
		}elseif( count($posts) < $term_text && $term_opt == 'less_than' ){
			return $term_id;
		}elseif( count($posts) > $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 ( 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...
98			continue;
99			}
100
101			wp_delete_term( $term_id, $options['taxonomy'] );
102			$count ++;
103			}
104
105			return $count;
106			}
107
108			/**
109			* custom string function use to get is string start with specified string.
110			*
111			* @param string $haystack.
112			* @param string $needle.
113			*
114			* @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...
115			*/
116			protected function bd_starts_with($haystack, $needle){
117			$length = strlen($needle);
118
119			return (substr($haystack, 0, $length) === $needle);
120			}
121
122			/**
123			* custom string function use to get is string ends with specified string.
124			*
125			* @param string $haystack.
126			* @param string $needle.
127			*
128			* @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...
129			*/
130			protected function bd_ends_with($haystack, $needle){
131			$length = strlen($needle);
132
133			return $length === 0 \|\|
134			(substr($haystack, -$length) === $needle);
135			}
136
137			/**
138			* get terms which is start with specified string.
139			*
140			* @param string $term_text.
141			* @param array $options.
142			*
143			* @return array term ids.
144			*/
145			protected function term_starts( $term_text , $options ){
146			$term_ids = array();
147			$terms = get_terms( $options['taxonomy'], array(
148			'hide_empty' => false,
149			) );
150
151			foreach( $terms as $term ){
152			if( $this->bd_starts_with( $term->name, $term_text ) ){
153			$term_ids[] = $term->term_id;
154			}
155			}
156
157			return $term_ids;
158			}
159
160			/**
161			* get terms which is ends with specified string.
162			*
163			* @param string $term_text.
164			* @param array $options.
165			*
166			* @return array term ids.
167			*/
168			protected function term_ends( $term_text , $options ){
169			$term_ids = array();
170			$terms = get_terms( $options['taxonomy'], array(
171			'hide_empty' => false,
172			) );
173
174			foreach( $terms as $term ){
175			if( $this->bd_ends_with( $term->name, $term_text ) ){
176			$term_ids[] = $term->term_id;
177			}
178			}
179
180			return $term_ids;
181			}
182
183			/**
184			* get terms which is contain specified string.
185			*
186			* @param string $term_text.
187			* @param array $options.
188			*
189			* @return array term ids.
190			*/
191			protected function term_contains( $term_text , $options ){
192			$term_ids = array();
193			$terms = get_terms( $options['taxonomy'], array(
194			'hide_empty' => false,
195			) );
196
197			foreach( $terms as $term ){
198			if ( strpos( $term->name, $term_text ) !== false ) {
199			$term_ids[] = $term->term_id;
200			}
201			}
202
203			return $term_ids;
204			}
205
206			/**
207			* Get term ids which is have the sepcified post count .
208			*
209			* @param array $options.
210			*
211			* @return array term ids.
212			*/
213			protected function term_count_query( $options ){
214			$term_ids = array();
215			$terms = get_terms( $options['taxonomy'], array(
216			'hide_empty' => false,
217			) );
218
219			foreach( $terms as $term ){
220			$args = array(
221			'post_type' => 'post',
222			'tax_query' => array(
223			array(
224			'taxonomy' => $options['taxonomy'],
225			'field' => 'slug',
226			'terms' => $term->slug,
227			),
228			),
229			);
230
231			$posts = get_posts($args);
			0 ignored issues – show Unused Code introduced 2018-07-10 19:12 UTC by Report Bug Copy Issue Report The assignment to `$posts` is dead and can be removed. Loading history...
232
233			$term_ids[] = $this->get_term_id_by_name( $options['term_text'], $options['term_opt'], $term->term_id );
234
235			}
236
237			return $term_ids;
238			}
239
240			protected function get_term_id_by_name( $term_text, $term_opt, $term_id ){
241
242			if( count($posts) == $term_text && $term_opt == 'equal_to' ){
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-07-10 19:12 UTC by Report Bug Copy Issue Report The variable `$posts` seems to be never defined. Loading history...
243			return $term_id;
244			}elseif( count($posts) != $term_text && $term_opt == 'not_equal_to' ){
245			return $term_id;
246			}elseif( count($posts) < $term_text && $term_opt == 'less_than' ){
247			return $term_id;
248			}elseif( count($posts) > $term_text && $term_opt == 'greater_than' ){
249			return $term_id;
250			}
251
252			}
253
254			/**
255			* Wrapper for WP_Term.
256			*
257			* Adds some performance enhancing defaults.
258			*
259			* @since 6.0
260			*
261			* @param array $options List of options
262			* @param mixed $taxonomy
263			*
264			* @return array Result array
265			*/
266			public function term_query( $options, $taxonomy ) {
267			$defaults = array(
268			'fields' => 'ids', // retrieve only ids
269			'taxonomy' => $taxonomy,
270			'hide_empty' => 0,
271			'count' => true,
272			);
273			$options = wp_parse_args( $options, $defaults );
274
275			$term_query = new \WP_Term_Query();
276
277			/**
278			* This action runs before the query happens.
279			*
280			* @since 5.5
281			* @since 5.6 added $term_query param.
282			*
283			* @param \WP_Query $term_query Query object.
284			*/
285			do_action( 'bd_before_term_query', $term_query );
286
287			$terms = $term_query->query( $options );
288
289			/**
290			* This action runs after the query happens.
291			*
292			* @since 5.5
293			* @since 5.6 added $term_query param.
294			*
295			* @param \WP_Query $term_query Query object.
296			*/
297			do_action( 'bd_after_term_query', $term_query );
298
299			return $terms;
300			}
301			}
302

sudar / bulk-delete

Push — 178-feature/delete-terms--by-p... ( 13ec01...9e7a19 )

TermsModule::delete_terms_from_query() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like