eventespresso / event-espresso-core

core/libraries/batch/JobHandlers/ExecuteBatchDeletion.php

Unused Use Statements -4 removed lines

@@ -2,10 +2,6 @@
 
 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;

Indentation +114 added lines, -114 removed lines

@@ -27,122 +27,122 @@
 {
 
 
-    /**
-     *
-     * @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')
-        );
-    }
+	/**
+	 *
+	 * @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){
-            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 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){
+			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')
-        );
-    }
+	/**
+	 * 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

Spacing +10 added lines, -10 removed lines

@@ -36,13 +36,13 @@ 
     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){
+        $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){
+            if ( ! $root instanceof ModelObjNode) {
                 throw new UnexpectedEntityException($root, 'ModelObjNode');
             }
             $ids_to_delete = array_replace_recursive($ids_to_delete, $root->getIds());
@@ -55,7 +55,7 @@ 
         );
         // Find the job's actual size.
         $job_size = 0;
-        foreach($ids_to_delete as $model_name => $ids){
+        foreach ($ids_to_delete as $model_name => $ids) {
             $job_size += count($ids);
         }
         $job_parameters->set_job_size($job_size);
@@ -77,8 +77,8 @@ 
         $units_processed = 0;
         $ids_to_delete = $job_parameters->extra_datum('ids_to_delete', []);
         $ids_remaining = [];
-        foreach($ids_to_delete as $model_name => $ids){
-            if($units_processed < $batch_size){
+        foreach ($ids_to_delete as $model_name => $ids) {
+            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()) {
@@ -94,7 +94,7 @@ 
                     ];
                     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;
+                        $where_conditions['OR']['AND*'.$index_primary_key_string] = $keys_n_values;
                     }
                 }
                 $deletion_count = $model->delete_permanently(
@@ -106,14 +106,14 @@ 
                 $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){
+                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)){
+            if (empty($ids_remaining)) {
                 $job_parameters->set_status(JobParameters::status_complete);
                 return new JobStepResponse(
                     $job_parameters,
@@ -140,7 +140,7 @@ 
     public function cleanup_job(JobParameters $job_parameters)
     {
         delete_option(
-            'EEBatchDeletion' . $job_parameters->extra_datum('deletion_job_code')
+            'EEBatchDeletion'.$job_parameters->extra_datum('deletion_job_code')
         );
     }
 }

core/libraries/batch/JobHandlers/PreviewEventDeletion.php

Indentation +117 added lines, -117 removed lines

@@ -27,126 +27,126 @@
 {
 
 
-    /**
-     *
-     * @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_ID', 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);
+	/**
+	 *
+	 * @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_ID', 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);
 //            $model_objects_to_delete[] = $event;
-            // 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
-                    ]
-                ]
-            );
-            $related_message_templates = $event->get_many_related(
-                'Message_Template_Group',
-                [
-                    [
-                        'MTP_is_global' => false
-                    ]
-                ]
-            );
-            $model_objects_to_delete = array_merge(
-                $model_objects_to_delete,
-                [$event],
-                $related_non_global_tickets,
-                $related_non_global_prices,
-                $related_message_templates
-            );
-        }
-        $roots = [];
-        foreach($model_objects_to_delete as $model_object){
-            $roots[] = new ModelObjNode($model_objects_to_delete);
-        }
-        $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__('Identified main items for deletion...', 'event_espresso')
-        );
-    }
+			// 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
+					]
+				]
+			);
+			$related_message_templates = $event->get_many_related(
+				'Message_Template_Group',
+				[
+					[
+						'MTP_is_global' => false
+					]
+				]
+			);
+			$model_objects_to_delete = array_merge(
+				$model_objects_to_delete,
+				[$event],
+				$related_non_global_tickets,
+				$related_non_global_prices,
+				$related_message_templates
+			);
+		}
+		$roots = [];
+		foreach($model_objects_to_delete as $model_object){
+			$roots[] = new ModelObjNode($model_objects_to_delete);
+		}
+		$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__('Identified main items for deletion...', '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;
-        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);
-        }
-        $job_parameters->mark_processed($units_processed);
-        // If the most-recently processed root node is complete, we must be all done!
-        if($root_node->isComplete()){
-            $deletion_job_code = wp_generate_password(8, false);
-            add_option('EEBatchDeletion' . $deletion_job_code, $job_parameters->extra_datum('roots'));
-            return new JobStepResponse(
-                $job_parameters,
-                esc_html__('Finished identifying items for deletion.', 'event_espresso'),
-                [
-                    'deletion_job_code' => $deletion_job_code
-                ]
-            );
-        } else {
-            return new JobStepResponse(
-                $job_parameters,
-                sprintf(
-                    esc_html__('Identified %d items for deletions.', '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)
+	{
+		$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);
+		}
+		$job_parameters->mark_processed($units_processed);
+		// If the most-recently processed root node is complete, we must be all done!
+		if($root_node->isComplete()){
+			$deletion_job_code = wp_generate_password(8, false);
+			add_option('EEBatchDeletion' . $deletion_job_code, $job_parameters->extra_datum('roots'));
+			return new JobStepResponse(
+				$job_parameters,
+				esc_html__('Finished identifying items for deletion.', 'event_espresso'),
+				[
+					'deletion_job_code' => $deletion_job_code
+				]
+			);
+		} else {
+			return new JobStepResponse(
+				$job_parameters,
+				sprintf(
+					esc_html__('Identified %d items for deletions.', '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

Spacing +7 added lines, -7 removed lines

@@ -78,7 +78,7 @@ 
             );
         }
         $roots = [];
-        foreach($model_objects_to_delete as $model_object){
+        foreach ($model_objects_to_delete as $model_object) {
             $roots[] = new ModelObjNode($model_objects_to_delete);
         }
         $job_parameters->add_extra_data('roots', $roots);
@@ -102,23 +102,23 @@ 
     public function continue_job(JobParameters $job_parameters, $batch_size = 50)
     {
         $units_processed = 0;
-        foreach($job_parameters->extra_datum('roots', array()) as $root_node){
-            if($units_processed >= $batch_size){
+        foreach ($job_parameters->extra_datum('roots', array()) as $root_node) {
+            if ($units_processed >= $batch_size) {
                 break;
             }
-            if(! $root_node instanceof ModelObjNode){
+            if ( ! $root_node instanceof ModelObjNode) {
                 throw new InvalidClassException('ModelObjNode');
             }
-            if($root_node->isComplete()){
+            if ($root_node->isComplete()) {
                 continue;
             }
             $units_processed += $root_node->visit($batch_size);
         }
         $job_parameters->mark_processed($units_processed);
         // If the most-recently processed root node is complete, we must be all done!
-        if($root_node->isComplete()){
+        if ($root_node->isComplete()) {
             $deletion_job_code = wp_generate_password(8, false);
-            add_option('EEBatchDeletion' . $deletion_job_code, $job_parameters->extra_datum('roots'));
+            add_option('EEBatchDeletion'.$deletion_job_code, $job_parameters->extra_datum('roots'));
             return new JobStepResponse(
                 $job_parameters,
                 esc_html__('Finished identifying items for deletion.', 'event_espresso'),