BulkWP\BulkDelete\Core\Terms\Modules\DeleteTermsByNameModule

Complexity

Total Complexity

14

Size/Duplication

Total Lines	160
Duplicated Lines	0 %

Test Coverage

Coverage

79.17%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	append_to_js_array()	0	4	1
A	render()	0	20	1
A	get_matching_terms_for_other_operators()	0	26	4
A	get_terms_that_contains()	0	7	1
A	initialize()	0	18	1
A	convert_user_input_to_options()	0	5	1
A	get_term_ids_to_delete()	0	23	4
A	get_terms_that_are_equal_to()	0	7	1

<?php

namespace BulkWP\BulkDelete\Core\Terms\Modules;

use BulkWP\BulkDelete\Core\Terms\QueryOverriders\DeleteTermsQueryOverrider;
use BulkWP\BulkDelete\Core\Terms\TermsModule;

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

/**
 * Delete Terms by Name.
 *
 * @since 6.0.0
 */
class DeleteTermsByNameModule extends TermsModule {
	// phpcs:ignore Squiz.Commenting.FunctionComment.Missing
	protected function initialize() {
		$this->item_type     = 'terms';
		$this->field_slug    = 'terms_by_name';
		$this->meta_box_slug = 'bd_delete_terms_by_name';
		$this->action        = 'delete_terms_by_name';
		$this->cron_hook     = 'do-bulk-delete-terms-by-name';
		$this->scheduler_url = 'https://bulkwp.com/addons/scheduler-for-deleting-terms/?utm_source=wpadmin&utm_campaign=BulkDelete&utm_medium=buynow&utm_content=bd-sp';
		$this->messages      = array(
			'box_label'         => __( 'Delete Terms by Name', 'bulk-delete' ),
			'scheduled'         => __( 'The selected terms are scheduled for deletion', 'bulk-delete' ),
			'cron_label'        => __( 'Delete Terms By name', 'bulk-delete' ),
			'confirm_deletion'  => __( 'Are you sure you want to delete all the terms based on the selected option?', 'bulk-delete' ),
			'confirm_scheduled' => __( 'Are you sure you want to schedule deletion for all the terms from the selected condition?', 'bulk-delete' ),
			'validation_error'  => __( 'Please enter the term name that should be deleted', 'bulk-delete' ),
			/* translators: 1 Number of terms deleted */
			'deleted_one'       => __( 'Deleted %d term with the selected options', 'bulk-delete' ),
			/* translators: 1 Number of terms deleted */
			'deleted_multiple'  => __( 'Deleted %d terms with the selected options', 'bulk-delete' ),
		);
	}

	// phpcs:ignore Squiz.Commenting.FunctionComment.Missing
	public function render() {
		?>
		<h4><?php _e( 'Select the taxonomy from which you want to delete terms', 'bulk-delete' ); ?></h4>
		<fieldset class="options">
			<table class="optiontable">
				<tr><?php $this->render_taxonomy_dropdown(); ?></tr>
				<h4><?php _e( 'Choose your filtering options', 'bulk-delete' ); ?></h4>
				<tr>
					<td>
						<?php _e( 'Delete Terms if the name ', 'bulk-delete' ); ?>
						<?php $this->render_operators_dropdown( [ 'equals', 'string-all' ] ); ?>
						<input type="text" name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_value" placeholder="<?php _e( 'Term Name', 'bulk-delete' ); ?>" class="validate">
					</td>
				</tr>
				<?php $this->render_cron_settings(); ?>
			</table>
		</fieldset>

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

	// phpcs:ignore Squiz.Commenting.FunctionComment.Missing
	protected function append_to_js_array( $js_array ) {
		$js_array['validators'][ $this->action ] = 'validateTextbox';

		return $js_array;
	}

	// phpcs:ignore Squiz.Commenting.FunctionComment.Missing
	protected function convert_user_input_to_options( $request, $options ) {
		$options['operator'] = bd_array_get( $request, 'smbd_' . $this->field_slug . '_operator' );
		$options['value']    = sanitize_text_field( bd_array_get( $request, 'smbd_' . $this->field_slug . '_value' ) );

		return $options;
	}

	/**
	 * Get the list of terms ids that need to be deleted.
	 *
	 * Return an empty query array to short-circuit deletion.
	 *
	 * @param array $options Delete options.
	 *
	 * @return int[] List of term ids to delete.
	 */
	protected function get_term_ids_to_delete( $options ) {
		$term_ids = array();
		$operator = $options['operator'];
		$value    = $options['value'];
		if ( empty( $value ) ) {
			return $term_ids;
		}

		switch ( $operator ) {
			case '=':
				$term_ids = $this->get_terms_that_are_equal_to( $options );
				break;

			case 'LIKE':
				$term_ids = $this->get_terms_that_contains( $options );
				break;

			default:
				$term_ids = $this->get_matching_terms_for_other_operators( $options );
				break;
		}

		return $term_ids;
	}

	/**
	 * Get terms with name that are equal to a specific string.
	 *
	 * @param array $options User options.
	 *
	 * @return int[] Term ids.
	 */
	protected function get_terms_that_are_equal_to( $options ) {
		$query = array(
			'taxonomy' => $options['taxonomy'],
			'name'     => $options['value'],
		);

		return $this->query_terms( $query );
	}

	/**
	 * Get terms with name that contains a specific string.
	 *
	 * @param array $options User options.
	 *
	 * @return int[] Term ids.
	 */
	protected function get_terms_that_contains( $options ) {
		$query = array(
			'taxonomy'   => $options['taxonomy'],
			'name__like' => $options['value'],
		);

		return $this->query_terms( $query );
	}

	/**
	 * Get matching terms for not equal to, not contains, starts with and ends with operators.
	 *
	 * @param array $options User options.
	 *
	 * @return int[] Term ids.
	 */
	protected function get_matching_terms_for_other_operators( $options ) {
		$operator = $options['operator'];
		$value    = $options['value'];
		switch ( $operator ) {
			case 'NOT LIKE':
				$value = '%' . $value . '%';
				break;
			case 'STARTS WITH':
				$operator = 'LIKE';
				$value    = $value . '%';
				break;
			case 'ENDS WITH':
				$operator = 'LIKE';
				$value    = '%' . $value;
				break;
		}
		$query           = array(
			'taxonomy'       => $options['taxonomy'],
			'bd_operator'    => $operator,
			'bd_value'       => $value,
			'bd_column_name' => 'name',
		);
		$query_overrider = new DeleteTermsQueryOverrider();
		$query_overrider->load();

		return $this->query_terms( $query );
	}
}