eventespresso / event-espresso-core

core/libraries/batch/JobHandlers/PreviewEventDeletion.php

Doc Comments +1 added lines, -1 removed lines

@@ -97,7 +97,7 @@
     /**
      * @since $VID:$
      * @param EE_Base_Class[] $model_objs
-     * @param array $dont_traverse_models
+     * @param string[] $dont_traverse_models
      */
     protected function createModelObjNodes($model_objs, array $dont_traverse_models = [])
     {

Indentation +154 added lines, -154 removed lines

@@ -28,164 +28,164 @@
 class PreviewEventDeletion extends JobHandler
 {
 
-    /**
-     * @var NodeGroupDao
-     */
-    protected $model_obj_node_group_persister;
-    public function __construct(NodeGroupDao $model_obj_node_group_persister)
-    {
-        $this->model_obj_node_group_persister = $model_obj_node_group_persister;
-    }
+	/**
+	 * @var NodeGroupDao
+	 */
+	protected $model_obj_node_group_persister;
+	public function __construct(NodeGroupDao $model_obj_node_group_persister)
+	{
+		$this->model_obj_node_group_persister = $model_obj_node_group_persister;
+	}
 
-    // 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 = [];
-        $roots = [];
-        foreach ($event_ids as $event_id) {
-            $roots[] = new ModelObjNode(
-                $event_id,
-                EEM_Event::instance()
-            );
-            // 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
-                    ]
-                ]
-            );
-            $roots = array_merge(
-                $roots,
-                // Dont have ticket nodes also traverse registrations, its unnecessary because
-                // registrations also depend on events so they will already get traversed.
-                $this->createModelObjNodes($related_non_global_tickets, ['Registration']),
-                $this->createModelObjNodes($related_non_global_prices)
-            );
-        }
-        $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 = [];
+		$roots = [];
+		foreach ($event_ids as $event_id) {
+			$roots[] = new ModelObjNode(
+				$event_id,
+				EEM_Event::instance()
+			);
+			// 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
+					]
+				]
+			);
+			$roots = array_merge(
+				$roots,
+				// Dont have ticket nodes also traverse registrations, its unnecessary because
+				// registrations also depend on events so they will already get traversed.
+				$this->createModelObjNodes($related_non_global_tickets, ['Registration']),
+				$this->createModelObjNodes($related_non_global_prices)
+			);
+		}
+		$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')
+		);
+	}
 
-    /**
-     * @since $VID:$
-     * @param EE_Base_Class[] $model_objs
-     * @param array $dont_traverse_models
-     */
-    protected function createModelObjNodes($model_objs, array $dont_traverse_models = [])
-    {
-        $nodes = [];
-        foreach ($model_objs as $model_obj) {
-            $nodes[] = new ModelObjNode(
-                $model_obj->ID(),
-                $model_obj->get_model(),
-                $dont_traverse_models
-            );
-        }
-        return $nodes;
-    }
+	/**
+	 * @since $VID:$
+	 * @param EE_Base_Class[] $model_objs
+	 * @param array $dont_traverse_models
+	 */
+	protected function createModelObjNodes($model_objs, array $dont_traverse_models = [])
+	{
+		$nodes = [];
+		foreach ($model_objs as $model_obj) {
+			$nodes[] = new ModelObjNode(
+				$model_obj->ID(),
+				$model_obj->get_model(),
+				$dont_traverse_models
+			);
+		}
+		return $nodes;
+	}
 
-    /**
-     * 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');
-            $this->model_obj_node_group_persister->persistModelObjNodesGroup(
-                $job_parameters->extra_datum('roots'),
-                $deletion_job_code
-            );
-            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');
+			$this->model_obj_node_group_persister->persistModelObjNodesGroup(
+				$job_parameters->extra_datum('roots'),
+				$deletion_job_code
+			);
+			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
-     */
-    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
-        return new JobStepResponse(
-            $job_parameters,
-            esc_html__('All done', 'event_espresso')
-        );
-    }
+	/**
+	 * Performs any clean-up logic when we know the job is completed
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 */
+	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
+		return new JobStepResponse(
+			$job_parameters,
+			esc_html__('All done', 'event_espresso')
+		);
+	}
 }
 // End of file EventDeletion.php
 // Location: EventEspressoBatchRequest\JobHandlers/EventDeletion.php

core/services/orm/tree_traversal/ModelObjNode.php

Indentation +185 added lines, -185 removed lines

@@ -22,203 +22,203 @@
  */
 class ModelObjNode extends BaseNode
 {
-    /**
-     * @var int|string
-     */
-    protected $id;
+	/**
+	 * @var int|string
+	 */
+	protected $id;
 
-    /**
-     * @var EEM_Base
-     */
-    protected $model;
+	/**
+	 * @var EEM_Base
+	 */
+	protected $model;
 
-    /**
-     * @var RelationNode[]
-     */
-    protected $nodes;
+	/**
+	 * @var RelationNode[]
+	 */
+	protected $nodes;
 
-    /**
-     * We don't pass the model objects because this needs to serialize to something tiny for effiency.
-     * @param $model_obj_id
-     * @param EEM_Base $model
-     */
-    public function __construct($model_obj_id, EEM_Base $model, array $dont_traverse_models = []])
-    {
-        $this->id = $model_obj_id;
-        $this->model = $model;
-        $this->dont_traverse_models = $dont_traverse_models;
-    }
+	/**
+	 * We don't pass the model objects because this needs to serialize to something tiny for effiency.
+	 * @param $model_obj_id
+	 * @param EEM_Base $model
+	 */
+	public function __construct($model_obj_id, EEM_Base $model, array $dont_traverse_models = []])
+	{
+		$this->id = $model_obj_id;
+		$this->model = $model;
+		$this->dont_traverse_models = $dont_traverse_models;
+	}
 
-    /**
-     * Creates a relation node for each relation of this model's relations.
-     * Does NOT call `discover` on them yet though.
-     * @since $VID:$
-     * @throws \EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function discover()
-    {
-        $this->nodes = [];
-        foreach ($this->model->relation_settings() as $relationName => $relation) {
-            // Make sure this isn't one of the models we were told to not traverse into.
-            if (in_array($relationName, $this->dont_traverse_models)) {
-                continue;
-            }
-            if ($relation instanceof EE_Has_Many_Relation) {
-                $this->nodes[ $relationName ] = new RelationNode(
-                    $this->id,
-                    $this->model,
-                    $relation->get_other_model(),
-                    $this->dont_traverse_models
-                );
-            } elseif ($relation instanceof EE_HABTM_Relation &&
-                ! in_array(
-                    $relation->get_join_model()->get_this_model_name(),
-                    $this->dont_traverse_models
-                )) {
-                $this->nodes[ $relation->get_join_model()->get_this_model_name() ] = new RelationNode(
-                    $this->id,
-                    $this->model,
-                    $relation->get_join_model(),
-                    $this->dont_traverse_models
-                );
-            }
-        }
-        ksort($this->nodes);
-    }
+	/**
+	 * Creates a relation node for each relation of this model's relations.
+	 * Does NOT call `discover` on them yet though.
+	 * @since $VID:$
+	 * @throws \EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function discover()
+	{
+		$this->nodes = [];
+		foreach ($this->model->relation_settings() as $relationName => $relation) {
+			// Make sure this isn't one of the models we were told to not traverse into.
+			if (in_array($relationName, $this->dont_traverse_models)) {
+				continue;
+			}
+			if ($relation instanceof EE_Has_Many_Relation) {
+				$this->nodes[ $relationName ] = new RelationNode(
+					$this->id,
+					$this->model,
+					$relation->get_other_model(),
+					$this->dont_traverse_models
+				);
+			} elseif ($relation instanceof EE_HABTM_Relation &&
+				! in_array(
+					$relation->get_join_model()->get_this_model_name(),
+					$this->dont_traverse_models
+				)) {
+				$this->nodes[ $relation->get_join_model()->get_this_model_name() ] = new RelationNode(
+					$this->id,
+					$this->model,
+					$relation->get_join_model(),
+					$this->dont_traverse_models
+				);
+			}
+		}
+		ksort($this->nodes);
+	}
 
 
-    /**
-     * Whether this item has already been initialized
-     */
-    protected function isDiscovered()
-    {
-        return $this->nodes !== null && is_array($this->nodes);
-    }
+	/**
+	 * Whether this item has already been initialized
+	 */
+	protected function isDiscovered()
+	{
+		return $this->nodes !== null && is_array($this->nodes);
+	}
 
-    /**
-     * @since $VID:$
-     * @return boolean
-     */
-    public function isComplete()
-    {
-        if ($this->complete === null) {
-            $this->complete = false;
-        }
-        return $this->complete;
-    }
+	/**
+	 * @since $VID:$
+	 * @return boolean
+	 */
+	public function isComplete()
+	{
+		if ($this->complete === null) {
+			$this->complete = false;
+		}
+		return $this->complete;
+	}
 
-    /**
-     * Triggers working on each child relation node that has work to do.
-     * @since $VID:$
-     * @param $model_objects_to_identify
-     * @return int units of work done
-     */
-    protected function work($model_objects_to_identify)
-    {
-        $num_identified = 0;
-        // Begin assuming we'll finish all the work on this node and its children...
-        $this->complete = true;
-        foreach ($this->nodes as $model_name => $relation_node) {
-            $num_identified += $relation_node->visit($model_objects_to_identify - $num_identified);
-            // To save on space when serializing, only bother keeping a record of relation nodes that actually found
-            // related model objects.
-            if ($relation_node->isComplete() && $relation_node->countSubNodes() === 0) {
-                unset($this->nodes[ $model_name ]);
-            }
-            if ($num_identified >= $model_objects_to_identify) {
-                // ...but admit we're wrong if the work exceeded the budget.
-                $this->complete = false;
-                break;
-            }
-        }
-        return $num_identified;
-    }
+	/**
+	 * Triggers working on each child relation node that has work to do.
+	 * @since $VID:$
+	 * @param $model_objects_to_identify
+	 * @return int units of work done
+	 */
+	protected function work($model_objects_to_identify)
+	{
+		$num_identified = 0;
+		// Begin assuming we'll finish all the work on this node and its children...
+		$this->complete = true;
+		foreach ($this->nodes as $model_name => $relation_node) {
+			$num_identified += $relation_node->visit($model_objects_to_identify - $num_identified);
+			// To save on space when serializing, only bother keeping a record of relation nodes that actually found
+			// related model objects.
+			if ($relation_node->isComplete() && $relation_node->countSubNodes() === 0) {
+				unset($this->nodes[ $model_name ]);
+			}
+			if ($num_identified >= $model_objects_to_identify) {
+				// ...but admit we're wrong if the work exceeded the budget.
+				$this->complete = false;
+				break;
+			}
+		}
+		return $num_identified;
+	}
 
-    /**
-     * @since $VID:$
-     * @return array
-     * @throws \EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function toArray()
-    {
-        $tree = [
-            'id' => $this->id,
-            'complete' => $this->isComplete(),
-            'rels' => []
-        ];
-        if ($this->nodes === null) {
-            $tree['rels'] = null;
-        } else {
-            foreach ($this->nodes as $relation_name => $relation_node) {
-                $tree['rels'][ $relation_name ] = $relation_node->toArray();
-            }
-        }
-        return $tree;
-    }
+	/**
+	 * @since $VID:$
+	 * @return array
+	 * @throws \EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function toArray()
+	{
+		$tree = [
+			'id' => $this->id,
+			'complete' => $this->isComplete(),
+			'rels' => []
+		];
+		if ($this->nodes === null) {
+			$tree['rels'] = null;
+		} else {
+			foreach ($this->nodes as $relation_name => $relation_node) {
+				$tree['rels'][ $relation_name ] = $relation_node->toArray();
+			}
+		}
+		return $tree;
+	}
 
-    /**
-     * @since $VID:$
-     * @return array|mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws \EE_Error
-     */
-    public function getIds()
-    {
-        $ids = [
-            $this->model->get_this_model_name() => [
-                $this->id => $this->id
-            ]
-        ];
-        if ($this->nodes && is_array($this->nodes)) {
-            foreach ($this->nodes as $relation_node) {
-                $ids = array_replace_recursive($ids, $relation_node->getIds());
-            }
-        }
-        return $ids;
-    }
+	/**
+	 * @since $VID:$
+	 * @return array|mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws \EE_Error
+	 */
+	public function getIds()
+	{
+		$ids = [
+			$this->model->get_this_model_name() => [
+				$this->id => $this->id
+			]
+		];
+		if ($this->nodes && is_array($this->nodes)) {
+			foreach ($this->nodes as $relation_node) {
+				$ids = array_replace_recursive($ids, $relation_node->getIds());
+			}
+		}
+		return $ids;
+	}
 
-    /**
-     * Don't serialize the models. Just record their names on some dynamic properties.
-     * @since $VID:$
-     */
-    public function __sleep()
-    {
-        $this->m = $this->model->get_this_model_name();
-        return array_merge(
-            [
-                'm',
-                'id',
-                'nodes',
-            ],
-            parent::__sleep()
-        );
-    }
+	/**
+	 * Don't serialize the models. Just record their names on some dynamic properties.
+	 * @since $VID:$
+	 */
+	public function __sleep()
+	{
+		$this->m = $this->model->get_this_model_name();
+		return array_merge(
+			[
+				'm',
+				'id',
+				'nodes',
+			],
+			parent::__sleep()
+		);
+	}
 
-    /**
-     * Use the dynamic properties to instantiate the models we use.
-     * @since $VID:$
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function __wakeup()
-    {
-        $this->model = EE_Registry::instance()->load_model($this->m);
-        parent::__wakeup();
-    }
+	/**
+	 * Use the dynamic properties to instantiate the models we use.
+	 * @since $VID:$
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function __wakeup()
+	{
+		$this->model = EE_Registry::instance()->load_model($this->m);
+		parent::__wakeup();
+	}
 }
 // End of file Visitor.php
 // Location: EventEspresso\core\services\orm\tree_traversal/Visitor.php

core/services/orm/tree_traversal/RelationNode.php

Indentation +253 added lines, -253 removed lines

@@ -28,278 +28,278 @@
 class RelationNode extends BaseNode
 {
 
-    /**
-     * @var string|int
-     */
-    protected $id;
+	/**
+	 * @var string|int
+	 */
+	protected $id;
 
-    /**
-     * @var EEM_Base
-     */
-    protected $main_model;
+	/**
+	 * @var EEM_Base
+	 */
+	protected $main_model;
 
-    /**
-     * @var int
-     */
-    protected $count;
+	/**
+	 * @var int
+	 */
+	protected $count;
 
-    /**
-     * @var EEM_Base
-     */
-    protected $related_model;
+	/**
+	 * @var EEM_Base
+	 */
+	protected $related_model;
 
-    /**
-     * @var ModelObjNode[]
-     */
-    protected $nodes;
+	/**
+	 * @var ModelObjNode[]
+	 */
+	protected $nodes;
 
-    public function __construct($main_model_obj_id, EEM_Base $main_model, EEM_Base $related_model, array $dont_traverse_models = [])
-    {
-        $this->id = $main_model_obj_id;
-        $this->main_model = $main_model;
-        $this->related_model = $related_model;
-        $this->nodes = [];
-        $this->dont_traverse_models = $dont_traverse_models;
-    }
+	public function __construct($main_model_obj_id, EEM_Base $main_model, EEM_Base $related_model, array $dont_traverse_models = [])
+	{
+		$this->id = $main_model_obj_id;
+		$this->main_model = $main_model;
+		$this->related_model = $related_model;
+		$this->nodes = [];
+		$this->dont_traverse_models = $dont_traverse_models;
+	}
 
 
-    /**
-     * Here is where most of the work happens. We've counted how many related model objects exist, here we identify
-     * them (ie, learn their IDs). But its recursive, so we'll also find their related dependent model objects etc.
-     * @since $VID:$
-     * @param int $model_objects_to_identify
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function work($model_objects_to_identify)
-    {
-        $num_identified = $this->visitAlreadyDiscoveredNodes($this->nodes, $model_objects_to_identify);
-        if ($num_identified < $model_objects_to_identify) {
-            $related_model_objs = $this->related_model->get_all(
-                [
-                    $this->whereQueryParams(),
-                    'limit' => [
-                        count($this->nodes),
-                        $model_objects_to_identify - $num_identified
-                    ]
-                ]
-            );
-            $new_item_nodes = [];
+	/**
+	 * Here is where most of the work happens. We've counted how many related model objects exist, here we identify
+	 * them (ie, learn their IDs). But its recursive, so we'll also find their related dependent model objects etc.
+	 * @since $VID:$
+	 * @param int $model_objects_to_identify
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function work($model_objects_to_identify)
+	{
+		$num_identified = $this->visitAlreadyDiscoveredNodes($this->nodes, $model_objects_to_identify);
+		if ($num_identified < $model_objects_to_identify) {
+			$related_model_objs = $this->related_model->get_all(
+				[
+					$this->whereQueryParams(),
+					'limit' => [
+						count($this->nodes),
+						$model_objects_to_identify - $num_identified
+					]
+				]
+			);
+			$new_item_nodes = [];
 
-            // Add entity nodes for each of the model objects we fetched.
-            foreach ($related_model_objs as $related_model_obj) {
-                $entity_node = new ModelObjNode($related_model_obj->ID(), $related_model_obj->get_model(), $this->dont_traverse_models);
-                $this->nodes[ $related_model_obj->ID() ] = $entity_node;
-                $new_item_nodes[ $related_model_obj->ID() ] = $entity_node;
-            }
-            $num_identified += count($new_item_nodes);
-            if ($num_identified < $model_objects_to_identify) {
-                // And lastly do the work.
-                $num_identified += $this->visitAlreadyDiscoveredNodes(
-                    $new_item_nodes,
-                    $model_objects_to_identify - $num_identified
-                );
-            }
-        }
+			// Add entity nodes for each of the model objects we fetched.
+			foreach ($related_model_objs as $related_model_obj) {
+				$entity_node = new ModelObjNode($related_model_obj->ID(), $related_model_obj->get_model(), $this->dont_traverse_models);
+				$this->nodes[ $related_model_obj->ID() ] = $entity_node;
+				$new_item_nodes[ $related_model_obj->ID() ] = $entity_node;
+			}
+			$num_identified += count($new_item_nodes);
+			if ($num_identified < $model_objects_to_identify) {
+				// And lastly do the work.
+				$num_identified += $this->visitAlreadyDiscoveredNodes(
+					$new_item_nodes,
+					$model_objects_to_identify - $num_identified
+				);
+			}
+		}
 
-        if (count($this->nodes) >= $this->count && $this->allChildrenComplete()) {
-            $this->complete = true;
-        }
-        return $num_identified;
-    }
+		if (count($this->nodes) >= $this->count && $this->allChildrenComplete()) {
+			$this->complete = true;
+		}
+		return $num_identified;
+	}
 
-    /**
-     * Checks if all the identified child nodes are complete or not.
-     * @since $VID:$
-     * @return bool
-     */
-    protected function allChildrenComplete()
-    {
-        foreach ($this->nodes as $model_obj_node) {
-            if (! $model_obj_node->isComplete()) {
-                return false;
-            }
-        }
-        return true;
-    }
+	/**
+	 * Checks if all the identified child nodes are complete or not.
+	 * @since $VID:$
+	 * @return bool
+	 */
+	protected function allChildrenComplete()
+	{
+		foreach ($this->nodes as $model_obj_node) {
+			if (! $model_obj_node->isComplete()) {
+				return false;
+			}
+		}
+		return true;
+	}
 
-    /**
-     * Visits the provided nodes and keeps track of how much work was done, making sure to not go over budget.
-     * @since $VID:$
-     * @param ModelObjNode[] $model_obj_nodes
-     * @param $work_budget
-     * @return int
-     */
-    protected function visitAlreadyDiscoveredNodes($model_obj_nodes, $work_budget)
-    {
-        $work_done = 0;
-        if (! $model_obj_nodes) {
-            return 0;
-        }
-        foreach ($model_obj_nodes as $model_obj_node) {
-            if ($work_done >= $work_budget) {
-                break;
-            }
-            $work_done += $model_obj_node->visit($work_budget - $work_done);
-        }
-        return $work_done;
-    }
+	/**
+	 * Visits the provided nodes and keeps track of how much work was done, making sure to not go over budget.
+	 * @since $VID:$
+	 * @param ModelObjNode[] $model_obj_nodes
+	 * @param $work_budget
+	 * @return int
+	 */
+	protected function visitAlreadyDiscoveredNodes($model_obj_nodes, $work_budget)
+	{
+		$work_done = 0;
+		if (! $model_obj_nodes) {
+			return 0;
+		}
+		foreach ($model_obj_nodes as $model_obj_node) {
+			if ($work_done >= $work_budget) {
+				break;
+			}
+			$work_done += $model_obj_node->visit($work_budget - $work_done);
+		}
+		return $work_done;
+	}
 
-    /**
-     * Whether this item has already been initialized
-     */
-    protected function isDiscovered()
-    {
-        return $this->count !== null;
-    }
+	/**
+	 * Whether this item has already been initialized
+	 */
+	protected function isDiscovered()
+	{
+		return $this->count !== null;
+	}
 
-    /**
-     * @since $VID:$
-     * @return boolean
-     */
-    public function isComplete()
-    {
-        if ($this->complete === null) {
-            if (count($this->nodes) === $this->count) {
-                $this->complete = true;
-            } else {
-                $this->complete = false;
-            }
-        }
-        return $this->complete;
-    }
+	/**
+	 * @since $VID:$
+	 * @return boolean
+	 */
+	public function isComplete()
+	{
+		if ($this->complete === null) {
+			if (count($this->nodes) === $this->count) {
+				$this->complete = true;
+			} else {
+				$this->complete = false;
+			}
+		}
+		return $this->complete;
+	}
 
-    /**
-     * Discovers how many related model objects exist.
-     * @since $VID:$
-     * @return mixed|void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function discover()
-    {
-        $this->count = $this->related_model->count([$this->whereQueryParams()]);
-    }
+	/**
+	 * Discovers how many related model objects exist.
+	 * @since $VID:$
+	 * @return mixed|void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function discover()
+	{
+		$this->count = $this->related_model->count([$this->whereQueryParams()]);
+	}
 
-    /**
-     * @since $VID:$
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function whereQueryParams()
-    {
-        $where_params =  [
-            $this->related_model->get_foreign_key_to(
-                $this->main_model->get_this_model_name()
-            )->get_name() => $this->id
-        ];
-        try {
-            $relation_settings = $this->main_model->related_settings_for($this->related_model->get_this_model_name());
-        } catch (EE_Error $e) {
-            // This will happen for has-and-belongs-to-many relations, when this node's related model is that join table
-            // which hasn't been explicitly declared in the main model object's model's relations.
-            $relation_settings = null;
-        }
-        if ($relation_settings instanceof EE_Has_Many_Any_Relation) {
-            $where_params[ $this->related_model->get_field_containing_related_model_name()->get_name() ] = $this->main_model->get_this_model_name();
-        }
-        return $where_params;
-    }
-    /**
-     * @since $VID:$
-     * @return array
-     */
-    public function toArray()
-    {
-        $tree = [
-            'count' => $this->count,
-            'complete' => $this->isComplete(),
-            'objs' => []
-        ];
-        foreach ($this->nodes as $id => $model_obj_node) {
-            $tree['objs'][ $id ] = $model_obj_node->toArray();
-        }
-        return $tree;
-    }
+	/**
+	 * @since $VID:$
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function whereQueryParams()
+	{
+		$where_params =  [
+			$this->related_model->get_foreign_key_to(
+				$this->main_model->get_this_model_name()
+			)->get_name() => $this->id
+		];
+		try {
+			$relation_settings = $this->main_model->related_settings_for($this->related_model->get_this_model_name());
+		} catch (EE_Error $e) {
+			// This will happen for has-and-belongs-to-many relations, when this node's related model is that join table
+			// which hasn't been explicitly declared in the main model object's model's relations.
+			$relation_settings = null;
+		}
+		if ($relation_settings instanceof EE_Has_Many_Any_Relation) {
+			$where_params[ $this->related_model->get_field_containing_related_model_name()->get_name() ] = $this->main_model->get_this_model_name();
+		}
+		return $where_params;
+	}
+	/**
+	 * @since $VID:$
+	 * @return array
+	 */
+	public function toArray()
+	{
+		$tree = [
+			'count' => $this->count,
+			'complete' => $this->isComplete(),
+			'objs' => []
+		];
+		foreach ($this->nodes as $id => $model_obj_node) {
+			$tree['objs'][ $id ] = $model_obj_node->toArray();
+		}
+		return $tree;
+	}
 
-    /**
-     * Gets the IDs of all the model objects to delete; indexed first by model object name.
-     * @since $VID:$
-     * @return array
-     */
-    public function getIds()
-    {
-        if (empty($this->nodes)) {
-            return [];
-        }
-        $ids = [
-            $this->related_model->get_this_model_name() => array_combine(
-                array_keys($this->nodes),
-                array_keys($this->nodes)
-            )
-        ];
-        foreach ($this->nodes as $model_obj_node) {
-            $ids = array_replace_recursive($ids, $model_obj_node->getIds());
-        }
-        return $ids;
-    }
+	/**
+	 * Gets the IDs of all the model objects to delete; indexed first by model object name.
+	 * @since $VID:$
+	 * @return array
+	 */
+	public function getIds()
+	{
+		if (empty($this->nodes)) {
+			return [];
+		}
+		$ids = [
+			$this->related_model->get_this_model_name() => array_combine(
+				array_keys($this->nodes),
+				array_keys($this->nodes)
+			)
+		];
+		foreach ($this->nodes as $model_obj_node) {
+			$ids = array_replace_recursive($ids, $model_obj_node->getIds());
+		}
+		return $ids;
+	}
 
-    /**
-     * Returns the number of sub-nodes found (ie, related model objects across this relation.)
-     * @since $VID:$
-     * @return int
-     */
-    public function countSubNodes()
-    {
-        return count($this->nodes);
-    }
+	/**
+	 * Returns the number of sub-nodes found (ie, related model objects across this relation.)
+	 * @since $VID:$
+	 * @return int
+	 */
+	public function countSubNodes()
+	{
+		return count($this->nodes);
+	}
 
-    /**
-     * Don't serialize the models. Just record their names on some dynamic properties.
-     * @since $VID:$
-     */
-    public function __sleep()
-    {
-        $this->m = $this->main_model->get_this_model_name();
-        $this->rm = $this->related_model->get_this_model_name();
-        return array_merge(
-            [
-                'm',
-                'rm',
-                'id',
-                'count',
-                'nodes',
-            ],
-            parent::__sleep()
-        );
-    }
+	/**
+	 * Don't serialize the models. Just record their names on some dynamic properties.
+	 * @since $VID:$
+	 */
+	public function __sleep()
+	{
+		$this->m = $this->main_model->get_this_model_name();
+		$this->rm = $this->related_model->get_this_model_name();
+		return array_merge(
+			[
+				'm',
+				'rm',
+				'id',
+				'count',
+				'nodes',
+			],
+			parent::__sleep()
+		);
+	}
 
-    /**
-     * Use the dynamic properties to instantiate the models we use.
-     * @since $VID:$
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function __wakeup()
-    {
-        $this->main_model = EE_Registry::instance()->load_model($this->m);
-        $this->related_model = EE_Registry::instance()->load_model($this->rm);
-        parent::__wakeup();
-    }
+	/**
+	 * Use the dynamic properties to instantiate the models we use.
+	 * @since $VID:$
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function __wakeup()
+	{
+		$this->main_model = EE_Registry::instance()->load_model($this->m);
+		$this->related_model = EE_Registry::instance()->load_model($this->rm);
+		parent::__wakeup();
+	}
 }
 // End of file RelationNode.php
 // Location: EventEspresso\core\services\orm\tree_traversal/RelationNode.php