eventespresso / event-espresso-core

core/services/orm/tree_traversal/BaseNode.php

Spacing +1 added lines, -1 removed lines

@@ -68,7 +68,7 @@
      */
     public function visit($model_objects_to_identify)
     {
-        if (! $this->isDiscovered()) {
+        if ( ! $this->isDiscovered()) {
             $this->discover();
         }
         if ($this->isComplete()) {

Indentation +61 added lines, -61 removed lines

@@ -31,73 +31,73 @@
  */
 abstract class BaseNode
 {
-    /**
-     * @var boolean
-     */
-    protected $complete;
-    /**
-     * Whether this item has already been initialized
-     */
-    abstract protected function isDiscovered();
+	/**
+	 * @var boolean
+	 */
+	protected $complete;
+	/**
+	 * Whether this item has already been initialized
+	 */
+	abstract protected function isDiscovered();
 
-    /**
-     * Determines if the work is done yet or not. Requires you to have first discovered what work exists by calling
-     * discover().
-     * @since $VID:$
-     * @return boolean
-     */
-    abstract public function isComplete();
+	/**
+	 * Determines if the work is done yet or not. Requires you to have first discovered what work exists by calling
+	 * discover().
+	 * @since $VID:$
+	 * @return boolean
+	 */
+	abstract public function isComplete();
 
-    /**
-     * Discovers what work needs to be done to complete traversing this node and its children.
-     * Note that this is separate from the constructor, so we can create child nodes without
-     * discovering them immediately.
-     * @since $VID:$
-     * @return mixed
-     */
-    abstract protected function discover();
+	/**
+	 * Discovers what work needs to be done to complete traversing this node and its children.
+	 * Note that this is separate from the constructor, so we can create child nodes without
+	 * discovering them immediately.
+	 * @since $VID:$
+	 * @return mixed
+	 */
+	abstract protected function discover();
 
-    /**
-     * Identifies model objects, up to the limit $model_objects_to_identify.
-     * @since $VID:$
-     * @param int $model_objects_to_identify
-     * @return int units of work done
-     */
-    abstract protected function work($model_objects_to_identify);
+	/**
+	 * Identifies model objects, up to the limit $model_objects_to_identify.
+	 * @since $VID:$
+	 * @param int $model_objects_to_identify
+	 * @return int units of work done
+	 */
+	abstract protected function work($model_objects_to_identify);
 
-    /**
-     * Shows the entity/relation node as an array.
-     * @since $VID:$
-     * @return array
-     */
-    abstract public function toArray();
+	/**
+	 * Shows the entity/relation node as an array.
+	 * @since $VID:$
+	 * @return array
+	 */
+	abstract public function toArray();
 
-    /**
-     * Discovers how much work there is to do, double-checks the work isn't already finished, and then does the work.
-     * Note: do not call when site is in maintenance mode level 2.
-     *
-     * @since $VID:$
-     * @param $model_objects_to_identify
-     * @return int number of model objects we want to identify during this call. On subsequent calls we'll continue
-     * where we left off.
-     */
-    public function visit($model_objects_to_identify)
-    {
-        if (! $this->isDiscovered()) {
-            $this->discover();
-        }
-        if ($this->isComplete()) {
-            return 0;
-        }
-        return $this->work($model_objects_to_identify);
-    }
+	/**
+	 * Discovers how much work there is to do, double-checks the work isn't already finished, and then does the work.
+	 * Note: do not call when site is in maintenance mode level 2.
+	 *
+	 * @since $VID:$
+	 * @param $model_objects_to_identify
+	 * @return int number of model objects we want to identify during this call. On subsequent calls we'll continue
+	 * where we left off.
+	 */
+	public function visit($model_objects_to_identify)
+	{
+		if (! $this->isDiscovered()) {
+			$this->discover();
+		}
+		if ($this->isComplete()) {
+			return 0;
+		}
+		return $this->work($model_objects_to_identify);
+	}
 
-    /**
-     * Gets the IDs of completely identified model objects that can be deleted.
-     * @since $VID:$
-     * @return mixed
-     */
-    abstract public function getIds();
+	/**
+	 * Gets the IDs of completely identified model objects that can be deleted.
+	 * @since $VID:$
+	 * @return mixed
+	 */
+	abstract public function getIds();
 }
 // End of file BaseNode.php
 // Location: EventEspresso\core\services\orm\tree_traversal/BaseNode.php

core/services/orm/tree_traversal/ModelObjNode.php

Spacing +3 added lines, -3 removed lines

@@ -51,9 +51,9 @@ 
         $this->relation_nodes = [];
         foreach ($this->model_obj->get_model()->relation_settings() as $relationName => $relation) {
             if ($relation instanceof EE_Has_Many_Relation) {
-                $this->relation_nodes[ $relationName ] = new RelationNode($this->model_obj, $relation->get_other_model());
+                $this->relation_nodes[$relationName] = new RelationNode($this->model_obj, $relation->get_other_model());
             } elseif ($relation instanceof EE_HABTM_Relation) {
-                $this->relation_nodes[ $relation->get_join_model()->get_this_model_name() ] = new RelationNode($this->model_obj, $relation->get_join_model());
+                $this->relation_nodes[$relation->get_join_model()->get_this_model_name()] = new RelationNode($this->model_obj, $relation->get_join_model());
             }
         }
         ksort($this->relation_nodes);
@@ -122,7 +122,7 @@ 
             $tree['rels'] = null;
         } else {
             foreach ($this->relation_nodes as $relation_name => $relation_node) {
-                $tree['rels'][ $relation_name ] = $relation_node->toArray();
+                $tree['rels'][$relation_name] = $relation_node->toArray();
             }
         }
         return $tree;

Indentation +119 added lines, -119 removed lines

@@ -21,134 +21,134 @@
  */
 class ModelObjNode extends BaseNode
 {
-    /**
-     * @var EE_Base_Class
-     */
-    protected $model_obj;
+	/**
+	 * @var EE_Base_Class
+	 */
+	protected $model_obj;
 
-    /**
-     * @var RelationNode[]
-     */
-    protected $relation_nodes;
+	/**
+	 * @var RelationNode[]
+	 */
+	protected $relation_nodes;
 
-    public function __construct($instance)
-    {
-        $this->model_obj = $instance;
-    }
+	public function __construct($instance)
+	{
+		$this->model_obj = $instance;
+	}
 
-    /**
-     * 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->relation_nodes = [];
-        foreach ($this->model_obj->get_model()->relation_settings() as $relationName => $relation) {
-            if ($relation instanceof EE_Has_Many_Relation) {
-                $this->relation_nodes[ $relationName ] = new RelationNode($this->model_obj, $relation->get_other_model());
-            } elseif ($relation instanceof EE_HABTM_Relation) {
-                $this->relation_nodes[ $relation->get_join_model()->get_this_model_name() ] = new RelationNode($this->model_obj, $relation->get_join_model());
-            }
-        }
-        ksort($this->relation_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->relation_nodes = [];
+		foreach ($this->model_obj->get_model()->relation_settings() as $relationName => $relation) {
+			if ($relation instanceof EE_Has_Many_Relation) {
+				$this->relation_nodes[ $relationName ] = new RelationNode($this->model_obj, $relation->get_other_model());
+			} elseif ($relation instanceof EE_HABTM_Relation) {
+				$this->relation_nodes[ $relation->get_join_model()->get_this_model_name() ] = new RelationNode($this->model_obj, $relation->get_join_model());
+			}
+		}
+		ksort($this->relation_nodes);
+	}
 
 
-    /**
-     * Whether this item has already been initialized
-     */
-    protected function isDiscovered()
-    {
-        return $this->relation_nodes !== null && is_array($this->relation_nodes);
-    }
+	/**
+	 * Whether this item has already been initialized
+	 */
+	protected function isDiscovered()
+	{
+		return $this->relation_nodes !== null && is_array($this->relation_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->relation_nodes as $relation_node) {
-            $num_identified += $relation_node->visit($model_objects_to_identify);
-            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->relation_nodes as $relation_node) {
+			$num_identified += $relation_node->visit($model_objects_to_identify);
+			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->model_obj->ID(),
-            'complete' => $this->isComplete(),
-            'rels' => []
-        ];
-        if ($this->relation_nodes === null) {
-            $tree['rels'] = null;
-        } else {
-            foreach ($this->relation_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->model_obj->ID(),
+			'complete' => $this->isComplete(),
+			'rels' => []
+		];
+		if ($this->relation_nodes === null) {
+			$tree['rels'] = null;
+		} else {
+			foreach ($this->relation_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_obj->get_model()->get_this_model_name() => [
-                $this->model_obj->ID() => $this->model_obj->ID()
-            ]
-        ];
-        foreach ($this->relation_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_obj->get_model()->get_this_model_name() => [
+				$this->model_obj->ID() => $this->model_obj->ID()
+			]
+		];
+		foreach ($this->relation_nodes as $relation_node) {
+			$ids = array_replace_recursive($ids, $relation_node->getIds());
+		}
+		return $ids;
+	}
 }
 // End of file Visitor.php
 // Location: EventEspresso\core\services\orm\tree_traversal/Visitor.php

core/services/orm/tree_traversal/RelationNode.php

Doc Comments +5 added lines, -1 removed lines

@@ -46,6 +46,10 @@ 
      */
     protected $model_obj_nodes;
 
+    /**
+     * @param EE_Base_Class $main_model_obj
+     * @param EEM_Base|null $related_model
+     */
     public function __construct($main_model_obj, $related_model)
     {
         $this->main_model_obj = $main_model_obj;
@@ -122,7 +126,7 @@ 
      * 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
+     * @param integer $work_budget
      * @return int
      */
     protected function visitAlreadyDiscoveredNodes($model_obj_nodes, $work_budget)

Unused Use Statements -2 removed lines

@@ -5,11 +5,9 @@
 use EE_Base_Class;
 use EE_Error;
 use EE_Has_Many_Any_Relation;
-use EE_Model_Relation_Base;
 use EEM_Base;
 use EventEspresso\core\exceptions\InvalidDataTypeException;
 use EventEspresso\core\exceptions\InvalidInterfaceException;
-use EventEspresso\core\services\payment_methods\forms\PayPalSettingsForm;
 use InvalidArgumentException;
 use ReflectionException;
 

Indentation +219 added lines, -219 removed lines

@@ -26,225 +26,225 @@
  */
 class RelationNode extends BaseNode
 {
-    /**
-     * @var EE_Base_Class
-     */
-    protected $main_model_obj;
-
-    /**
-     * @var int
-     */
-    protected $count;
-
-    /**
-     * @var EEM_Base
-     */
-    protected $related_model;
-
-    /**
-     * @var ModelObjNode[]
-     */
-    protected $model_obj_nodes;
-
-    public function __construct($main_model_obj, $related_model)
-    {
-        $this->main_model_obj = $main_model_obj;
-        $this->related_model = $related_model;
-        $this->model_obj_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->model_obj_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->model_obj_nodes),
-                        $model_objects_to_identify
-                    ]
-                ]
-            );
-            $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);
-                $this->model_obj_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->model_obj_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->model_obj_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;
-    }
-
-    /**
-     * 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->model_obj_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()]);
-    }
-
-    /**
-     * @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_obj->get_model()->get_this_model_name()
-            )->get_name() => $this->main_model_obj->ID()
-        ];
-        try {
-            $relation_settings = $this->main_model_obj->get_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_obj->get_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->model_obj_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->model_obj_nodes)) {
-            return [];
-        }
-        $ids = [
-            $this->related_model->get_this_model_name() => array_combine(
-                array_keys($this->model_obj_nodes),
-                array_keys($this->model_obj_nodes)
-            )
-        ];
-        foreach ($this->model_obj_nodes as $model_obj_node) {
-            $ids = array_replace_recursive($ids, $model_obj_node->getIds());
-        }
-        return $ids;
-    }
+	/**
+	 * @var EE_Base_Class
+	 */
+	protected $main_model_obj;
+
+	/**
+	 * @var int
+	 */
+	protected $count;
+
+	/**
+	 * @var EEM_Base
+	 */
+	protected $related_model;
+
+	/**
+	 * @var ModelObjNode[]
+	 */
+	protected $model_obj_nodes;
+
+	public function __construct($main_model_obj, $related_model)
+	{
+		$this->main_model_obj = $main_model_obj;
+		$this->related_model = $related_model;
+		$this->model_obj_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->model_obj_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->model_obj_nodes),
+						$model_objects_to_identify
+					]
+				]
+			);
+			$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);
+				$this->model_obj_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->model_obj_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->model_obj_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;
+	}
+
+	/**
+	 * 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->model_obj_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()]);
+	}
+
+	/**
+	 * @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_obj->get_model()->get_this_model_name()
+			)->get_name() => $this->main_model_obj->ID()
+		];
+		try {
+			$relation_settings = $this->main_model_obj->get_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_obj->get_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->model_obj_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->model_obj_nodes)) {
+			return [];
+		}
+		$ids = [
+			$this->related_model->get_this_model_name() => array_combine(
+				array_keys($this->model_obj_nodes),
+				array_keys($this->model_obj_nodes)
+			)
+		];
+		foreach ($this->model_obj_nodes as $model_obj_node) {
+			$ids = array_replace_recursive($ids, $model_obj_node->getIds());
+		}
+		return $ids;
+	}
 }
 // End of file RelationNode.php
 // Location: EventEspresso\core\services\orm\tree_traversal/RelationNode.php

Spacing +7 added lines, -7 removed lines

@@ -84,8 +84,8 @@ 
             // 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);
-                $this->model_obj_nodes[ $related_model_obj->ID() ] = $entity_node;
-                $new_item_nodes[ $related_model_obj->ID() ] = $entity_node;
+                $this->model_obj_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) {
@@ -111,7 +111,7 @@ 
     protected function allChildrenComplete()
     {
         foreach ($this->model_obj_nodes as $model_obj_node) {
-            if (! $model_obj_node->isComplete()) {
+            if ( ! $model_obj_node->isComplete()) {
                 return false;
             }
         }
@@ -128,7 +128,7 @@ 
     protected function visitAlreadyDiscoveredNodes($model_obj_nodes, $work_budget)
     {
         $work_done = 0;
-        if (! $model_obj_nodes) {
+        if ( ! $model_obj_nodes) {
             return 0;
         }
         foreach ($model_obj_nodes as $model_obj_node) {
@@ -190,7 +190,7 @@ 
      */
     protected function whereQueryParams()
     {
-        $where_params =  [
+        $where_params = [
             $this->related_model->get_foreign_key_to(
                 $this->main_model_obj->get_model()->get_this_model_name()
             )->get_name() => $this->main_model_obj->ID()
@@ -203,7 +203,7 @@ 
             $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_obj->get_model()->get_this_model_name();
+            $where_params[$this->related_model->get_field_containing_related_model_name()->get_name()] = $this->main_model_obj->get_model()->get_this_model_name();
         }
         return $where_params;
     }
@@ -219,7 +219,7 @@ 
             'objs' => []
         ];
         foreach ($this->model_obj_nodes as $id => $model_obj_node) {
-            $tree['objs'][ $id ] = $model_obj_node->toArray();
+            $tree['objs'][$id] = $model_obj_node->toArray();
         }
         return $tree;
     }