ExecuteBatchDeletion::cleanup_job() - Code Metrics - Inspection of "Daily Inspection: add batch job for deleting a gro..." - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — CASC/batch-deletion (24fd65)

unknown

created 2019-12-31 21:18 UTC

ExecuteBatchDeletion::cleanup_job() A

↳ Parent: ExecuteBatchDeletion

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?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){
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            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


1		<?php
2
3		namespace EventEspressoBatchRequest\JobHandlers;
4
5		use EEM_Event;
6		use EEM_Price;
7		use EEM_Ticket;
8		use EventEspresso\core\exceptions\InvalidClassException;
9		use EventEspresso\core\exceptions\UnexpectedEntityException;
10		use EventEspresso\core\services\orm\tree_traversal\ModelObjNode;
11		use EventEspressoBatchRequest\Helpers\BatchRequestException;
12		use EventEspressoBatchRequest\Helpers\JobParameters;
13		use EventEspressoBatchRequest\Helpers\JobStepResponse;
14		use EventEspressoBatchRequest\JobHandlerBaseClasses\JobHandler;
15
16		/**
17		* Class EventDeletion
18		*
19		* Given a job code (eg generated by PreviewEventDeletion), performs the deletion of the indicated items.
20		*
21		* @package Event Espresso
22		* @author Mike Nelson
23		* @since $VID:$
24		*
25		*/
26		class ExecuteBatchDeletion extends JobHandler
27		{
28
29
30		/**
31		*
32		* @param JobParameters $job_parameters
33		* @throws BatchRequestException
34		* @return JobStepResponse
35		*/
36		public function create_job(JobParameters $job_parameters)
37		{
38		$deletion_job_code = $job_parameters->request_datum('deletion_job_code', array());
39		$roots = get_option('EEBatchDeletion' . $deletion_job_code, null);
40		if($roots === null){
41		throw new UnexpectedEntityException($roots, 'array', esc_html__('The job seems to be stale. Please press the back button in your browser twice.', 'event_espresso'));
42		}
43		$ids_to_delete = [];
44		foreach ($roots as $root) {
45		if(! $root instanceof ModelObjNode){
46		throw new UnexpectedEntityException($root, 'ModelObjNode');
47		}
48		$ids_to_delete = array_replace_recursive($ids_to_delete, $root->getIds());
49		}
50		$job_parameters->set_extra_data(
51		[
52		'deletion_job_code' => $deletion_job_code,
53		'ids_to_delete' => $ids_to_delete
54		]
55		);
56		// Find the job's actual size.
57		$job_size = 0;
58		foreach($ids_to_delete as $model_name => $ids){
59		$job_size += count($ids);
60		}
61		$job_parameters->set_job_size($job_size);
62		return new JobStepResponse(
63		$job_parameters,
64		esc_html__('Beginning to delete items...', 'event_espresso')
65		);
66		}
67
68		/**
69		* Performs another step of the job
70		* @param JobParameters $job_parameters
71		* @param int $batch_size
72		* @return JobStepResponse
73		* @throws BatchRequestException
74		*/
75		public function continue_job(JobParameters $job_parameters, $batch_size = 50)
76		{
77		$units_processed = 0;
78		$ids_to_delete = $job_parameters->extra_datum('ids_to_delete', []);
79		$ids_remaining = [];
80		foreach($ids_to_delete as $model_name => $ids){
		0 ignored issues – show Bug introduced 2019-12-31 21:34 UTC by Report Bug Copy Issue Report The expression `$ids_to_delete` of type `string\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
81		if($units_processed < $batch_size){
82		$model = EE_Registry::instance()->load_model($model_name);
83		$ids_to_delete_this_query = array_slice($ids, 0, $batch_size, true);
84	View Code Duplication	if ($model->has_primary_key_field()) {
85		$where_conditions = [
86		$model->primary_key_name() => [
87		'IN',
88		$ids
89		]
90		];
91		} else {
92		$where_conditions = [
93		'OR' => []
94		];
95		foreach ($ids as $index_primary_key_string) {
96		$keys_n_values = $model->parse_index_primary_key_string($index_primary_key_string);
97		$where_conditions['OR'][ 'AND*' . $index_primary_key_string ] = $keys_n_values;
98		}
99		}
100		$deletion_count = $model->delete_permanently(
101		[
102		$where_conditions
103		],
104		false
105		);
106		$units_processed += $deletion_count;
107		$remaining_ids = array_diff_key($ids, $ids_to_delete_this_query);
108		// If there's any more from this model, we'll do them next time.
109		if(count($remaining_ids) > 0){
110		$ids_remaining[$model_name] = $remaining_ids;
111		}
112		} else {
113		$ids_remaining[$model_name] = $ids_to_delete[$model_name];
114		}
115		$job_parameters->mark_processed($units_processed);
116		if(empty($ids_remaining)){
117		$job_parameters->set_status(JobParameters::status_complete);
118		return new JobStepResponse(
119		$job_parameters,
120		esc_html__('Deletion complete.', 'event_espresso')
121		);
122		}
123		$job_parameters->add_extra_data('ids_to_delete', $ids_remaining);
124		return new JobStepResponse(
125		$job_parameters,
126		sprintf(
127		esc_html__('Deleted %d items.', 'event_espresso'),
128		$units_processed
129		)
130		);
131		}
132		}
133
134		/**
135		* Performs any clean-up logic when we know the job is completed
136		* @param JobParameters $job_parameters
137		* @return JobStepResponse
138		* @throws BatchRequestException
139		*/
140		public function cleanup_job(JobParameters $job_parameters)
141		{
142		delete_option(
143		'EEBatchDeletion' . $job_parameters->extra_datum('deletion_job_code')
144		);
145		}
146		}
147		// End of file EventDeletion.php
148		// Location: EventEspressoBatchRequest\JobHandlers/EventDeletion.php
149

eventespresso / event-espresso-core

Branch — CASC/batch-deletion (24fd65)

ExecuteBatchDeletion::cleanup_job() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like