eventespresso / event-espresso-core

core/libraries/batch/JobHandlers/PreviewEventDeletion.php

Indentation +122 added lines, -122 removed lines

@@ -26,130 +26,130 @@
 class PreviewEventDeletion extends JobHandler
 {
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    /**
-     *
-     * @param JobParameters $job_parameters
-     * @throws BatchRequestException
-     * @return JobStepResponse
-     */
-    public function create_job(JobParameters $job_parameters)
-    {
-        // Set the "root" model objects we will want to delete (record their ID and model)
-        $event_ids = $job_parameters->request_datum('EVT_IDs', array());
-        // Find all the root nodes to delete (this isn't just events, because there's other data, like related tickets,
-        // prices, message templates, etc, whose model definition doesn't make them dependent on events. But,
-        // we have no UI to access them independent of events, so they may as well get deleted too.)
-        $model_objects_to_delete = [];
-        foreach ($event_ids as $event_id) {
-            $event = EEM_Event::instance()->get_one_by_ID($event_id);
-            // Also, we want to delete their related, non-global, tickets, prices and message templates
-            $related_non_global_tickets = EEM_Ticket::instance()->get_all_deleted_and_undeleted(
-                [
-                    [
-                        'TKT_is_default' => false,
-                        'Datetime.EVT_ID' => $event_id
-                    ]
-                ]
-            );
-            $related_non_global_prices = EEM_Price::instance()->get_all_deleted_and_undeleted(
-                [
-                    [
-                        'PRC_is_default' => false,
-                        'Ticket.Datetime.EVT_ID' => $event_id
-                    ]
-                ]
-            );
-            $model_objects_to_delete = array_merge(
-                $model_objects_to_delete,
-                [$event],
-                $related_non_global_tickets,
-                $related_non_global_prices
-            );
-        }
-        $roots = [];
-        foreach ($model_objects_to_delete as $model_object) {
-            $roots[] = new ModelObjNode($model_object->ID(), $model_object->get_model());
-        }
-        $job_parameters->add_extra_data('roots', $roots);
-        // Set an estimate of how long this will take (we're discovering as we go, so it seems impossible to give
-        // an accurate count.)
-        $estimated_work_per_model_obj = 100;
-        $job_parameters->set_job_size(count($roots) * $estimated_work_per_model_obj);
-        return new JobStepResponse(
-            $job_parameters,
-            esc_html__('Generating preview of data to be deleted...', 'event_espresso')
-        );
-    }
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	/**
+	 *
+	 * @param JobParameters $job_parameters
+	 * @throws BatchRequestException
+	 * @return JobStepResponse
+	 */
+	public function create_job(JobParameters $job_parameters)
+	{
+		// Set the "root" model objects we will want to delete (record their ID and model)
+		$event_ids = $job_parameters->request_datum('EVT_IDs', array());
+		// Find all the root nodes to delete (this isn't just events, because there's other data, like related tickets,
+		// prices, message templates, etc, whose model definition doesn't make them dependent on events. But,
+		// we have no UI to access them independent of events, so they may as well get deleted too.)
+		$model_objects_to_delete = [];
+		foreach ($event_ids as $event_id) {
+			$event = EEM_Event::instance()->get_one_by_ID($event_id);
+			// Also, we want to delete their related, non-global, tickets, prices and message templates
+			$related_non_global_tickets = EEM_Ticket::instance()->get_all_deleted_and_undeleted(
+				[
+					[
+						'TKT_is_default' => false,
+						'Datetime.EVT_ID' => $event_id
+					]
+				]
+			);
+			$related_non_global_prices = EEM_Price::instance()->get_all_deleted_and_undeleted(
+				[
+					[
+						'PRC_is_default' => false,
+						'Ticket.Datetime.EVT_ID' => $event_id
+					]
+				]
+			);
+			$model_objects_to_delete = array_merge(
+				$model_objects_to_delete,
+				[$event],
+				$related_non_global_tickets,
+				$related_non_global_prices
+			);
+		}
+		$roots = [];
+		foreach ($model_objects_to_delete as $model_object) {
+			$roots[] = new ModelObjNode($model_object->ID(), $model_object->get_model());
+		}
+		$job_parameters->add_extra_data('roots', $roots);
+		// Set an estimate of how long this will take (we're discovering as we go, so it seems impossible to give
+		// an accurate count.)
+		$estimated_work_per_model_obj = 100;
+		$job_parameters->set_job_size(count($roots) * $estimated_work_per_model_obj);
+		return new JobStepResponse(
+			$job_parameters,
+			esc_html__('Generating preview of data to be deleted...', '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)
-    {
-        // Serializing and unserializing is what really makes this drag on (eg on localhost, the ajax requests took
-        // about 4 seconds when the batch size was 250, but 3 seconds when the batch size was 50. So like
-        // 50% of the request is just serializing and unserializing.) So, make the batches much bigger.
-        $batch_size *= 3;
-        $units_processed = 0;
-        foreach ($job_parameters->extra_datum('roots', array()) as $root_node) {
-            if ($units_processed >= $batch_size) {
-                break;
-            }
-            if (! $root_node instanceof ModelObjNode) {
-                throw new InvalidClassException('ModelObjNode');
-            }
-            if ($root_node->isComplete()) {
-                continue;
-            }
-            $units_processed += $root_node->visit($batch_size - $units_processed);
-        }
-        $job_parameters->mark_processed($units_processed);
-        // If the most-recently processed root node is complete, we must be all done because we're doing them
-        // sequentially.
-        if (isset($root_node) && $root_node instanceof ModelObjNode && $root_node->isComplete()) {
-            $job_parameters->set_status(JobParameters::status_complete);
-            // Show a full progress bar.
-            $job_parameters->set_units_processed($job_parameters->job_size());
-            $deletion_job_code = $job_parameters->request_datum('deletion_job_code');
-            add_option('ee_deletion_' . $deletion_job_code, $job_parameters->extra_datum('roots'), null, 'no');
-            return new JobStepResponse(
-                $job_parameters,
-                esc_html__('Finished identifying items for deletion.', 'event_espresso'),
-                [
-                    'deletion_job_code' => $deletion_job_code
-                ]
-            );
-        } else {
-            // Because the job size was a guess, it may have likely been provden wrong. We don't want to show more work
-            // done than we originally said there would be. So adjust the estimate.
-            if (($job_parameters->units_processed() / $job_parameters->job_size()) > .8) {
-                $job_parameters->set_job_size($job_parameters->job_size() * 2);
-            }
-            return new JobStepResponse(
-                $job_parameters,
-                sprintf(
-                    esc_html__('Identified %d items for deletion.', 'event_espresso'),
-                    $units_processed
-                )
-            );
-        }
-    }
+	/**
+	 * 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)
+	{
+		// Serializing and unserializing is what really makes this drag on (eg on localhost, the ajax requests took
+		// about 4 seconds when the batch size was 250, but 3 seconds when the batch size was 50. So like
+		// 50% of the request is just serializing and unserializing.) So, make the batches much bigger.
+		$batch_size *= 3;
+		$units_processed = 0;
+		foreach ($job_parameters->extra_datum('roots', array()) as $root_node) {
+			if ($units_processed >= $batch_size) {
+				break;
+			}
+			if (! $root_node instanceof ModelObjNode) {
+				throw new InvalidClassException('ModelObjNode');
+			}
+			if ($root_node->isComplete()) {
+				continue;
+			}
+			$units_processed += $root_node->visit($batch_size - $units_processed);
+		}
+		$job_parameters->mark_processed($units_processed);
+		// If the most-recently processed root node is complete, we must be all done because we're doing them
+		// sequentially.
+		if (isset($root_node) && $root_node instanceof ModelObjNode && $root_node->isComplete()) {
+			$job_parameters->set_status(JobParameters::status_complete);
+			// Show a full progress bar.
+			$job_parameters->set_units_processed($job_parameters->job_size());
+			$deletion_job_code = $job_parameters->request_datum('deletion_job_code');
+			add_option('ee_deletion_' . $deletion_job_code, $job_parameters->extra_datum('roots'), null, 'no');
+			return new JobStepResponse(
+				$job_parameters,
+				esc_html__('Finished identifying items for deletion.', 'event_espresso'),
+				[
+					'deletion_job_code' => $deletion_job_code
+				]
+			);
+		} else {
+			// Because the job size was a guess, it may have likely been provden wrong. We don't want to show more work
+			// done than we originally said there would be. So adjust the estimate.
+			if (($job_parameters->units_processed() / $job_parameters->job_size()) > .8) {
+				$job_parameters->set_job_size($job_parameters->job_size() * 2);
+			}
+			return new JobStepResponse(
+				$job_parameters,
+				sprintf(
+					esc_html__('Identified %d items for deletion.', '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)
-    {
-        // Nothing much to do. We can't delete the option with the built tree because we may need it in a moment for the deletion
-    }
+	/**
+	 * 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)
+	{
+		// Nothing much to do. We can't delete the option with the built tree because we may need it in a moment for the deletion
+	}
 }
 // End of file EventDeletion.php
 // Location: EventEspressoBatchRequest\JobHandlers/EventDeletion.php

core/libraries/batch/JobHandlers/ExecuteBatchDeletion.php

Indentation +121 added lines, -121 removed lines

@@ -27,129 +27,129 @@
 class ExecuteBatchDeletion extends JobHandler
 {
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    /**
-     *
-     * @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', null);
-        $roots = get_option('ee_deletion_'  . $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'));
-        }
-        $models_and_ids_to_delete = [];
-        foreach ($roots as $root) {
-            if (! $root instanceof ModelObjNode) {
-                throw new UnexpectedEntityException($root, 'ModelObjNode');
-            }
-            $models_and_ids_to_delete = array_replace_recursive($models_and_ids_to_delete, $root->getIds());
-        }
-        $job_parameters->set_extra_data(
-            [
-                'models_and_ids_to_delete' => $models_and_ids_to_delete
-            ]
-        );
-        // Find the job's actual size.
-        $job_size = 0;
-        foreach ($models_and_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')
-        );
-    }
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	/**
+	 *
+	 * @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', null);
+		$roots = get_option('ee_deletion_'  . $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'));
+		}
+		$models_and_ids_to_delete = [];
+		foreach ($roots as $root) {
+			if (! $root instanceof ModelObjNode) {
+				throw new UnexpectedEntityException($root, 'ModelObjNode');
+			}
+			$models_and_ids_to_delete = array_replace_recursive($models_and_ids_to_delete, $root->getIds());
+		}
+		$job_parameters->set_extra_data(
+			[
+				'models_and_ids_to_delete' => $models_and_ids_to_delete
+			]
+		);
+		// Find the job's actual size.
+		$job_size = 0;
+		foreach ($models_and_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)
-    {
-        // We already have the items IDs. So deleting is really fast. Let's speed it up.
-        $batch_size *= 10;
-        $units_processed = 0;
-        $models_and_ids_to_delete = $job_parameters->extra_datum('models_and_ids_to_delete', []);
-        // Build a new list of everything leftover after this request's of deletions.
-        $models_and_ids_remaining = [];
-        foreach ($models_and_ids_to_delete as $model_name => $ids_to_delete) {
-            if ($units_processed < $batch_size) {
-                $model = EE_Registry::instance()->load_model($model_name);
-                $ids_to_delete_this_query = array_slice($ids_to_delete, 0, $batch_size - $units_processed, true);
-                if ($model->has_primary_key_field()) {
-                    $where_conditions = [
-                        $model->primary_key_name() => [
-                            'IN',
-                            $ids_to_delete_this_query
-                        ]
-                    ];
-                } else {
-                    $where_conditions = [
-                        'OR' => []
-                    ];
-                    foreach ($ids_to_delete_this_query 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;
-                    }
-                }
-                // Deleting time!
-                // The model's deletion method reports every ROW deleted, and in the case of CPT models that will be
-                // two rows deleted for event CPT item. So don't rely on it for the count of items deleted.
-                $model->delete_permanently(
-                    [
-                        $where_conditions
-                    ],
-                    false
-                );
-                $units_processed += count($ids_to_delete_this_query);
-                $remaining_ids = array_diff_key($ids_to_delete, $ids_to_delete_this_query);
-                // If there's any more from this model, we'll do them next time.
-                if (count($remaining_ids) > 0) {
-                    $models_and_ids_remaining[ $model_name ] = $remaining_ids;
-                }
-            } else {
-                $models_and_ids_remaining[ $model_name ] = $models_and_ids_to_delete[ $model_name ];
-            }
-        }
-        $job_parameters->mark_processed($units_processed);
-        // All done deleting for this request. Is there anything to do next time?
-        if (empty($models_and_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('models_and_ids_to_delete', $models_and_ids_remaining);
-        return new JobStepResponse(
-            $job_parameters,
-            sprintf(
-                esc_html__('Deleted %d items.', 'event_espresso'),
-                $units_processed
-            )
-        );
-    }
+	/**
+	 * 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)
+	{
+		// We already have the items IDs. So deleting is really fast. Let's speed it up.
+		$batch_size *= 10;
+		$units_processed = 0;
+		$models_and_ids_to_delete = $job_parameters->extra_datum('models_and_ids_to_delete', []);
+		// Build a new list of everything leftover after this request's of deletions.
+		$models_and_ids_remaining = [];
+		foreach ($models_and_ids_to_delete as $model_name => $ids_to_delete) {
+			if ($units_processed < $batch_size) {
+				$model = EE_Registry::instance()->load_model($model_name);
+				$ids_to_delete_this_query = array_slice($ids_to_delete, 0, $batch_size - $units_processed, true);
+				if ($model->has_primary_key_field()) {
+					$where_conditions = [
+						$model->primary_key_name() => [
+							'IN',
+							$ids_to_delete_this_query
+						]
+					];
+				} else {
+					$where_conditions = [
+						'OR' => []
+					];
+					foreach ($ids_to_delete_this_query 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;
+					}
+				}
+				// Deleting time!
+				// The model's deletion method reports every ROW deleted, and in the case of CPT models that will be
+				// two rows deleted for event CPT item. So don't rely on it for the count of items deleted.
+				$model->delete_permanently(
+					[
+						$where_conditions
+					],
+					false
+				);
+				$units_processed += count($ids_to_delete_this_query);
+				$remaining_ids = array_diff_key($ids_to_delete, $ids_to_delete_this_query);
+				// If there's any more from this model, we'll do them next time.
+				if (count($remaining_ids) > 0) {
+					$models_and_ids_remaining[ $model_name ] = $remaining_ids;
+				}
+			} else {
+				$models_and_ids_remaining[ $model_name ] = $models_and_ids_to_delete[ $model_name ];
+			}
+		}
+		$job_parameters->mark_processed($units_processed);
+		// All done deleting for this request. Is there anything to do next time?
+		if (empty($models_and_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('models_and_ids_to_delete', $models_and_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->request_datum('deletion_job_code')
-        );
-    }
+	/**
+	 * 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->request_datum('deletion_job_code')
+		);
+	}
 }
 // End of file EventDeletion.php
 // Location: EventEspressoBatchRequest\JobHandlers/EventDeletion.php