EventEspressoBatchRequest\JobHandlers\ExecuteBatchDeletion

Complexity

Total Complexity

13

Size/Duplication

Total Lines	121
Duplicated Lines	13.22 %

Coupling/Cohesion

Components	0
Dependencies	5

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	create_job()	0	31	5
B	continue_job()	16	58	7
A	cleanup_job()	0	6	1

<?php

namespace EventEspressoBatchRequest\JobHandlers;

use EEM_Event;
use EEM_Price;
use EEM_Ticket;
use EventEspresso\core\exceptions\InvalidClassException;
use EventEspresso\core\exceptions\UnexpectedEntityException;
use EventEspresso\core\services\orm\tree_traversal\ModelObjNode;
use EventEspressoBatchRequest\Helpers\BatchRequestException;
use EventEspressoBatchRequest\Helpers\JobParameters;
use EventEspressoBatchRequest\Helpers\JobStepResponse;
use EventEspressoBatchRequest\JobHandlerBaseClasses\JobHandler;

/**
 * Class EventDeletion
 *
 * Given a job code (eg generated by PreviewEventDeletion), performs the deletion of the indicated items.
 *
 * @package     Event Espresso
 * @author         Mike Nelson
 * @since         $VID:$
 *
 */
class ExecuteBatchDeletion extends JobHandler
{


    /**
     *
     * @param JobParameters $job_parameters
     * @throws BatchRequestException
     * @return JobStepResponse
     */
    public function create_job(JobParameters $job_parameters)
    {
        $deletion_job_code = $job_parameters->request_datum('deletion_job_code', array());
        $roots = get_option('EEBatchDeletion'  . $deletion_job_code, null);
        if($roots === null){
            throw new UnexpectedEntityException($roots, 'array', esc_html__('The job seems to be stale. Please press the back button in your browser twice.', 'event_espresso'));
        }
        $ids_to_delete = [];
        foreach ($roots as $root) {
            if(! $root instanceof ModelObjNode){
                throw new UnexpectedEntityException($root, 'ModelObjNode');
            }
            $ids_to_delete = array_replace_recursive($ids_to_delete, $root->getIds());
        }
        $job_parameters->set_extra_data(
            [
                'deletion_job_code' => $deletion_job_code,
                'ids_to_delete' => $ids_to_delete
            ]
        );
        // Find the job's actual size.
        $job_size = 0;
        foreach($ids_to_delete as $model_name => $ids){
            $job_size += count($ids);
        }
        $job_parameters->set_job_size($job_size);
        return new JobStepResponse(
            $job_parameters,
            esc_html__('Beginning to delete items...', 'event_espresso')
        );
    }

    /**
     * Performs another step of the job
     * @param JobParameters $job_parameters
     * @param int $batch_size
     * @return JobStepResponse
     * @throws BatchRequestException
     */
    public function continue_job(JobParameters $job_parameters, $batch_size = 50)
    {
        $units_processed = 0;
        $ids_to_delete = $job_parameters->extra_datum('ids_to_delete', []);
        $ids_remaining = [];
        foreach($ids_to_delete as $model_name => $ids){

The expression $ids_to_delete of type string|array is not guaranteed to be traversable. How about adding an additional type check?

            if($units_processed < $batch_size){
                $model = EE_Registry::instance()->load_model($model_name);
                $ids_to_delete_this_query = array_slice($ids, 0, $batch_size, true);
                if ($model->has_primary_key_field()) {
                    $where_conditions = [
                        $model->primary_key_name() => [
                            'IN',
                            $ids
                        ]
                    ];
                } else {
                    $where_conditions = [
                        'OR' => []
                    ];
                    foreach ($ids as $index_primary_key_string) {
                        $keys_n_values = $model->parse_index_primary_key_string($index_primary_key_string);
                        $where_conditions['OR'][ 'AND*' . $index_primary_key_string ] = $keys_n_values;
                    }
                }
                $deletion_count = $model->delete_permanently(
                    [
                        $where_conditions
                    ],
                    false
                );
                $units_processed += $deletion_count;
                $remaining_ids = array_diff_key($ids, $ids_to_delete_this_query);
                // If there's any more from this model, we'll do them next time.
                if(count($remaining_ids) > 0){
                    $ids_remaining[$model_name] = $remaining_ids;
                }
            } else {
                $ids_remaining[$model_name] = $ids_to_delete[$model_name];
            }
            $job_parameters->mark_processed($units_processed);
            if(empty($ids_remaining)){
                $job_parameters->set_status(JobParameters::status_complete);
                return new JobStepResponse(
                    $job_parameters,
                    esc_html__('Deletion complete.', 'event_espresso')
                );
            }
            $job_parameters->add_extra_data('ids_to_delete', $ids_remaining);
            return new JobStepResponse(
                $job_parameters,
                sprintf(
                    esc_html__('Deleted %d items.', 'event_espresso'),
                    $units_processed
                )
            );
        }
    }

    /**
     * Performs any clean-up logic when we know the job is completed
     * @param JobParameters $job_parameters
     * @return JobStepResponse
     * @throws BatchRequestException
     */
    public function cleanup_job(JobParameters $job_parameters)
    {
        delete_option(
            'EEBatchDeletion' . $job_parameters->extra_datum('deletion_job_code')
        );
    }
}
// End of file EventDeletion.php
// Location: EventEspressoBatchRequest\JobHandlers/EventDeletion.php