eventespresso / event-espresso-core

core/services/orm/tree_traversal/RelationNode.php

Doc Comments +4 added lines, -1 removed lines

@@ -35,6 +35,9 @@ 
 
     protected $itemNodes;
 
+    /**
+     * @param EE_Base_Class $mainEntity
+     */
     public function __construct($mainEntity, $relation)
     {
         $this->mainEntity = $mainEntity;
@@ -66,7 +69,7 @@ 
 
     /**
      * @since $VID:$
-     * @return boolean
+     * @return boolean|null
      */
     public function isComplete()
     {

Unused Use Statements -1 removed lines

@@ -3,7 +3,6 @@
 namespace EventEspresso\core\services\orm\tree_traversal;
 
 use EE_Base_Class;
-use EventEspresso\core\libraries\rest_api\controllers\Base;
 
 /**
  * Class RelationNode

Indentation +49 added lines, -49 removed lines

@@ -17,66 +17,66 @@
  */
 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;
+	}
 
 
 
-    protected function work($work_to_do){
-        $items = $this->relation->get_this_model()->get_all_related(
-            $this->mainEntity,
-            $this->relation->get_other_model(),
-            [
-                'limit' => $work_to_do
-            ]
-        );
-        foreach($items as $item){
-            $this->itemNodes[] = new EntityNode($item);
-        }
-    }
+	protected function work($work_to_do){
+		$items = $this->relation->get_this_model()->get_all_related(
+			$this->mainEntity,
+			$this->relation->get_other_model(),
+			[
+				'limit' => $work_to_do
+			]
+		);
+		foreach($items as $item){
+			$this->itemNodes[] = new EntityNode($item);
+		}
+	}
 
-    /**
-     * Whether this item has already been initialized
-     */
-    public function isDiscovered()
-    {
-        // TODO: Implement isDiscovered() method.
-    }
+	/**
+	 * Whether this item has already been initialized
+	 */
+	public function isDiscovered()
+	{
+		// TODO: Implement isDiscovered() method.
+	}
 
-    /**
-     * @since $VID:$
-     * @return boolean
-     */
-    public function isComplete()
-    {
-        // TODO: Implement isComplete() method.
-    }
+	/**
+	 * @since $VID:$
+	 * @return boolean
+	 */
+	public function isComplete()
+	{
+		// TODO: Implement isComplete() method.
+	}
 
-    public function discover()
-    {
-        $this->count = $this->relation->get_this_model()->count_related($this->mainEntity, $this->relation->get_other_model());
-    }
+	public 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 +2 added lines, -2 removed lines

@@ -43,7 +43,7 @@ 
 
 
 
-    protected function work($work_to_do){
+    protected function work($work_to_do) {
         $items = $this->relation->get_this_model()->get_all_related(
             $this->mainEntity,
             $this->relation->get_other_model(),
@@ -51,7 +51,7 @@ 
                 'limit' => $work_to_do
             ]
         );
-        foreach($items as $item){
+        foreach ($items as $item) {
             $this->itemNodes[] = new EntityNode($item);
         }
     }

core/services/orm/tree_traversal/BaseNode.php

Indentation +35 added lines, -35 removed lines

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

Spacing +3 added lines, -3 removed lines

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

core/services/orm/tree_traversal/EntityNode.php

Indentation +62 added lines, -62 removed lines

@@ -16,75 +16,75 @@
  */
 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;
+	}
 
-    public function discover(){
-        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);
-            }
-        }
-    }
+	public function discover(){
+		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
-     */
-    public function isDiscovered()
-    {
-        // TODO: Implement isDiscovered() method.
-    }
+	/**
+	 * Whether this item has already been initialized
+	 */
+	public function isDiscovered()
+	{
+		// TODO: Implement isDiscovered() method.
+	}
 
-    /**
-     * @since $VID:$
-     * @return boolean
-     */
-    public function isComplete()
-    {
-        if($this->complete == null){
-            $this->complete = true;
-            foreach($this->relation_nodes as $relation_node){
-                if(! $relation_node->isComplete()){
-                    $this->complete = false;
-                    break;
-                }
-            }
-        }
-        return $this->complete;
-    }
+	/**
+	 * @since $VID:$
+	 * @return boolean
+	 */
+	public function isComplete()
+	{
+		if($this->complete == null){
+			$this->complete = true;
+			foreach($this->relation_nodes as $relation_node){
+				if(! $relation_node->isComplete()){
+					$this->complete = false;
+					break;
+				}
+			}
+		}
+		return $this->complete;
+	}
 
-    /**
-     *
-     * @since $VID:$
-     * @param $work_to_do
-     * @return int units of work done
-     */
-    protected function work($work_to_do)
-    {
-        $units_worked = 0;
-        foreach($this->relation_nodes as $relation_node){
-            if(! $relation_node->isComplete()){
-                $units_worked += $relation_node->visit($work_to_do);
-            }
-            if($units_worked >= $work_to_do){
-                break;
-            }
-        }
-        return $units_worked;
-    }
+	/**
+	 *
+	 * @since $VID:$
+	 * @param $work_to_do
+	 * @return int units of work done
+	 */
+	protected function work($work_to_do)
+	{
+		$units_worked = 0;
+		foreach($this->relation_nodes as $relation_node){
+			if(! $relation_node->isComplete()){
+				$units_worked += $relation_node->visit($work_to_do);
+			}
+			if($units_worked >= $work_to_do){
+				break;
+			}
+		}
+		return $units_worked;
+	}
 }
 // End of file Visitor.php
 // Location: EventEspresso\core\services\orm\tree_traversal/Visitor.php

Spacing +10 added lines, -10 removed lines

@@ -26,14 +26,14 @@ 
      */
     protected $relation_nodes;
 
-    public function __construct( $instance)
+    public function __construct($instance)
     {
         $this->initialInstance = $instance;
     }
 
-    public function discover(){
-        foreach($this->initialInstance->get_model()->relation_settings() as $relation){
-            if($relation->block_delete_if_related_models_exist()){
+    public function discover() {
+        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);
             }
         }
@@ -54,10 +54,10 @@ 
      */
     public function isComplete()
     {
-        if($this->complete == null){
+        if ($this->complete == null) {
             $this->complete = true;
-            foreach($this->relation_nodes as $relation_node){
-                if(! $relation_node->isComplete()){
+            foreach ($this->relation_nodes as $relation_node) {
+                if ( ! $relation_node->isComplete()) {
                     $this->complete = false;
                     break;
                 }
@@ -75,11 +75,11 @@ 
     protected function work($work_to_do)
     {
         $units_worked = 0;
-        foreach($this->relation_nodes as $relation_node){
-            if(! $relation_node->isComplete()){
+        foreach ($this->relation_nodes as $relation_node) {
+            if ( ! $relation_node->isComplete()) {
                 $units_worked += $relation_node->visit($work_to_do);
             }
-            if($units_worked >= $work_to_do){
+            if ($units_worked >= $work_to_do) {
                 break;
             }
         }