eventespresso / event-espresso-core

core/services/orm/tree_traversal/RelationNode.php

Doc Comments +3 added lines

@@ -35,6 +35,9 @@
 
     protected $itemNodes;
 
+    /**
+     * @param EE_Base_Class $mainEntity
+     */
     public function __construct($mainEntity, $relation)
     {
         $this->mainEntity = $mainEntity;

Indentation +91 added lines, -91 removed lines

@@ -17,109 +17,109 @@
  */
 class RelationNode extends BaseNode
 {
-    /**
-     * @var EE_Base_Class
-     */
-    protected $mainEntity;
+	/**
+	 * @var EE_Base_Class
+	 */
+	protected $mainEntity;
 
-    /**
-     * @var int
-     */
-    protected $count;
+	/**
+	 * @var int
+	 */
+	protected $count;
 
-    /**
-     * @var \EE_Model_Relation_Base
-     */
-    protected $relation;
+	/**
+	 * @var \EE_Model_Relation_Base
+	 */
+	protected $relation;
 
 
-    protected $itemNodes;
+	protected $itemNodes;
 
-    public function __construct($mainEntity, $relation)
-    {
-        $this->mainEntity = $mainEntity;
-        $this->relation = $relation;
-    }
+	public function __construct($mainEntity, $relation)
+	{
+		$this->mainEntity = $mainEntity;
+		$this->relation = $relation;
+	}
 
 
-    /**
-     * Here is where most of the work happens. We've counted how many related model objects exist, but now we need to
-     * trigger visiting each of them, and then visiting their children etc.
-     * @since $VID:$
-     * @param $work_budget
-     * @return int|void
-     * @throws \EE_Error
-     */
-    protected function work($work_budget){
-        $work_done = 0;
-        foreach($this->itemNodes as $entity_node){
-            if($work_done < $work_budget){
-                $work_done += $entity_node->visit($work_budget);
-            }
-        }
-        if($work_done < $work_budget){
-            $items = $this->relation->get_this_model()->get_all_related(
-                $this->mainEntity,
-                $this->relation->get_other_model(),
-                [
-                    'limit' => [
-                        count($this->itemNodes),
-                        $work_budget
-                    ]
-                ]
-            );
-            $work_done += count($items);
-            $new_item_nodes = [];
+	/**
+	 * Here is where most of the work happens. We've counted how many related model objects exist, but now we need to
+	 * trigger visiting each of them, and then visiting their children etc.
+	 * @since $VID:$
+	 * @param $work_budget
+	 * @return int|void
+	 * @throws \EE_Error
+	 */
+	protected function work($work_budget){
+		$work_done = 0;
+		foreach($this->itemNodes as $entity_node){
+			if($work_done < $work_budget){
+				$work_done += $entity_node->visit($work_budget);
+			}
+		}
+		if($work_done < $work_budget){
+			$items = $this->relation->get_this_model()->get_all_related(
+				$this->mainEntity,
+				$this->relation->get_other_model(),
+				[
+					'limit' => [
+						count($this->itemNodes),
+						$work_budget
+					]
+				]
+			);
+			$work_done += count($items);
+			$new_item_nodes = [];
 
-            // Add entity nodes for each of the model objects we fetched.
-            foreach($items as $item){
-                $entity_node = new EntityNode($item);
-                $this->itemNodes[] = $entity_node;
-                $new_item_nodes[] = $entity_node;
-            }
+			// Add entity nodes for each of the model objects we fetched.
+			foreach($items as $item){
+				$entity_node = new EntityNode($item);
+				$this->itemNodes[] = $entity_node;
+				$new_item_nodes[] = $entity_node;
+			}
 
-            // And lastly do the work.
-            foreach($new_item_nodes as $new_item_node){
-                if($work_done >= $work_budget){
-                    break;
-                }
-                $work_done += $new_item_node->visit($work_budget - $work_done);
-            }
-        }
-        // We're all done this node if we've done everything here and still have budget for more.
-        if($work_done < $work_budget){
-            $this->complete = true;
-        }
-        return $work_done;
-    }
+			// And lastly do the work.
+			foreach($new_item_nodes as $new_item_node){
+				if($work_done >= $work_budget){
+					break;
+				}
+				$work_done += $new_item_node->visit($work_budget - $work_done);
+			}
+		}
+		// We're all done this node if we've done everything here and still have budget for more.
+		if($work_done < $work_budget){
+			$this->complete = true;
+		}
+		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()
-    {
-        return $this->complete;
-    }
+	/**
+	 * @since $VID:$
+	 * @return boolean
+	 */
+	public function isComplete()
+	{
+		return $this->complete;
+	}
 
-    /**
-     * Discovers how many related model objects exist.
-     * @since $VID:$
-     * @return mixed|void
-     * @throws \EE_Error
-     */
-    protected function discover()
-    {
-        $this->count = $this->relation->get_this_model()->count_related($this->mainEntity, $this->relation->get_other_model());
-    }
+	/**
+	 * Discovers how many related model objects exist.
+	 * @since $VID:$
+	 * @return mixed|void
+	 * @throws \EE_Error
+	 */
+	protected function discover()
+	{
+		$this->count = $this->relation->get_this_model()->count_related($this->mainEntity, $this->relation->get_other_model());
+	}
 }
 // End of file RelationNode.php
 // Location: EventEspresso\core\services\orm\tree_traversal/RelationNode.php

Spacing +8 added lines, -8 removed lines

@@ -50,14 +50,14 @@ 
      * @return int|void
      * @throws \EE_Error
      */
-    protected function work($work_budget){
+    protected function work($work_budget) {
         $work_done = 0;
-        foreach($this->itemNodes as $entity_node){
-            if($work_done < $work_budget){
+        foreach ($this->itemNodes as $entity_node) {
+            if ($work_done < $work_budget) {
                 $work_done += $entity_node->visit($work_budget);
             }
         }
-        if($work_done < $work_budget){
+        if ($work_done < $work_budget) {
             $items = $this->relation->get_this_model()->get_all_related(
                 $this->mainEntity,
                 $this->relation->get_other_model(),
@@ -72,22 +72,22 @@ 
             $new_item_nodes = [];
 
             // Add entity nodes for each of the model objects we fetched.
-            foreach($items as $item){
+            foreach ($items as $item) {
                 $entity_node = new EntityNode($item);
                 $this->itemNodes[] = $entity_node;
                 $new_item_nodes[] = $entity_node;
             }
 
             // And lastly do the work.
-            foreach($new_item_nodes as $new_item_node){
-                if($work_done >= $work_budget){
+            foreach ($new_item_nodes as $new_item_node) {
+                if ($work_done >= $work_budget) {
                     break;
                 }
                 $work_done += $new_item_node->visit($work_budget - $work_done);
             }
         }
         // We're all done this node if we've done everything here and still have budget for more.
-        if($work_done < $work_budget){
+        if ($work_done < $work_budget) {
             $this->complete = true;
         }
         return $work_done;

core/services/orm/tree_traversal/EntityNode.php

Indentation +68 added lines, -68 removed lines

@@ -16,81 +16,81 @@
  */
 class EntityNode extends BaseNode
 {
-    /**
-     * @var EE_Base_Class
-     */
-    protected $initialInstance;
+	/**
+	 * @var EE_Base_Class
+	 */
+	protected $initialInstance;
 
-    /**
-     * @var RelationNode[]
-     */
-    protected $relation_nodes;
+	/**
+	 * @var RelationNode[]
+	 */
+	protected $relation_nodes;
 
-    public function __construct( $instance)
-    {
-        $this->initialInstance = $instance;
-    }
+	public function __construct( $instance)
+	{
+		$this->initialInstance = $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 \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \InvalidArgumentException
-     * @throws \ReflectionException
-     */
-    protected function discover(){
-        $this->relation_nodes = [];
-        foreach($this->initialInstance->get_model()->relation_settings() as $relation){
-            if($relation->block_delete_if_related_models_exist()){
-                $this->relation_nodes[] = new RelationNode($this->initialInstance, $relation);
-            }
-        }
-    }
+	/**
+	 * 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 \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \InvalidArgumentException
+	 * @throws \ReflectionException
+	 */
+	protected function discover(){
+		$this->relation_nodes = [];
+		foreach($this->initialInstance->get_model()->relation_settings() as $relation){
+			if($relation->block_delete_if_related_models_exist()){
+				$this->relation_nodes[] = new RelationNode($this->initialInstance, $relation);
+			}
+		}
+	}
 
 
-    /**
-     * 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 $work_budget
-     * @return int units of work done
-     */
-    protected function work($work_budget)
-    {
-        $units_worked = 0;
-        foreach($this->relation_nodes as $relation_node){
-            $units_worked += $relation_node->visit($work_budget);
-            if($units_worked >= $work_budget){
-                break;
-            }
-        }
-        if($units_worked < $work_budget){
-            $this->complete = true;
-        }
-        return $units_worked;
-    }
+	/**
+	 * Triggers working on each child relation node that has work to do.
+	 * @since $VID:$
+	 * @param $work_budget
+	 * @return int units of work done
+	 */
+	protected function work($work_budget)
+	{
+		$units_worked = 0;
+		foreach($this->relation_nodes as $relation_node){
+			$units_worked += $relation_node->visit($work_budget);
+			if($units_worked >= $work_budget){
+				break;
+			}
+		}
+		if($units_worked < $work_budget){
+			$this->complete = true;
+		}
+		return $units_worked;
+	}
 }
 // End of file Visitor.php
 // Location: EventEspresso\core\services\orm\tree_traversal/Visitor.php

Spacing +8 added lines, -8 removed lines

@@ -26,7 +26,7 @@ 
      */
     protected $relation_nodes;
 
-    public function __construct( $instance)
+    public function __construct($instance)
     {
         $this->initialInstance = $instance;
     }
@@ -41,10 +41,10 @@ 
      * @throws \InvalidArgumentException
      * @throws \ReflectionException
      */
-    protected function discover(){
+    protected function discover() {
         $this->relation_nodes = [];
-        foreach($this->initialInstance->get_model()->relation_settings() as $relation){
-            if($relation->block_delete_if_related_models_exist()){
+        foreach ($this->initialInstance->get_model()->relation_settings() as $relation) {
+            if ($relation->block_delete_if_related_models_exist()) {
                 $this->relation_nodes[] = new RelationNode($this->initialInstance, $relation);
             }
         }
@@ -65,7 +65,7 @@ 
      */
     public function isComplete()
     {
-        if($this->complete === null){
+        if ($this->complete === null) {
             $this->complete = false;
         }
         return $this->complete;
@@ -80,13 +80,13 @@ 
     protected function work($work_budget)
     {
         $units_worked = 0;
-        foreach($this->relation_nodes as $relation_node){
+        foreach ($this->relation_nodes as $relation_node) {
             $units_worked += $relation_node->visit($work_budget);
-            if($units_worked >= $work_budget){
+            if ($units_worked >= $work_budget) {
                 break;
             }
         }
-        if($units_worked < $work_budget){
+        if ($units_worked < $work_budget) {
             $this->complete = true;
         }
         return $units_worked;

core/services/orm/tree_traversal/BaseNode.php

Indentation +44 added lines, -44 removed lines

@@ -14,54 +14,54 @@
  */
 abstract class BaseNode
 {
-    /**
-     * @var boolean
-     */
-    protected $complete;
-    /**
-     * Whether this item has already been initialized
-     */
-    protected abstract function isDiscovered();
+	/**
+	 * @var boolean
+	 */
+	protected $complete;
+	/**
+	 * Whether this item has already been initialized
+	 */
+	protected abstract 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
-     */
-    public abstract 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
+	 */
+	public abstract 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
-     */
-    protected abstract 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
+	 */
+	protected abstract function discover();
 
-    /**
-     * @since $VID:$
-     * @param $work_to_do
-     * @return int units of work done
-     */
-    public function visit($work_to_do){
-        if(! $this->isDiscovered()){
-            $this->discover();
-        }
-        if($this->isComplete()){
-           return 0;
-        }
-        return $this->work($work_to_do);
-    }
+	/**
+	 * @since $VID:$
+	 * @param $work_to_do
+	 * @return int units of work done
+	 */
+	public function visit($work_to_do){
+		if(! $this->isDiscovered()){
+			$this->discover();
+		}
+		if($this->isComplete()){
+		   return 0;
+		}
+		return $this->work($work_to_do);
+	}
 
-    /**
-     *
-     * @since $VID:$
-     * @param $work_budget
-     * @return int units of work done
-     */
-    protected abstract function work($work_budget);
+	/**
+	 *
+	 * @since $VID:$
+	 * @param $work_budget
+	 * @return int units of work done
+	 */
+	protected abstract function work($work_budget);
 }
 // End of file BaseNode.php
 // Location: EventEspresso\core\services\orm\tree_traversal/BaseNode.php

Spacing +3 added lines, -3 removed lines

@@ -45,11 +45,11 @@
      * @param $work_to_do
      * @return int units of work done
      */
-    public function visit($work_to_do){
-        if(! $this->isDiscovered()){
+    public function visit($work_to_do) {
+        if ( ! $this->isDiscovered()) {
             $this->discover();
         }
-        if($this->isComplete()){
+        if ($this->isComplete()) {
            return 0;
         }
         return $this->work($work_to_do);