Merge pull request #198 from studycloud/bugfix_tree_resource_duplication

aryarm · web-flow · commit 1fdf4e13048f · 2020-06-13T20:50:32.000-07:00
clean up code and comments for tree relates stuff
diff --git a/app/Helpers/NodesAndConnections.php b/app/Helpers/NodesAndConnections.php
@@ -81,10 +81,10 @@ public static function separatedTree($repository, ...$args)
 	/**
 	 * some data won't have pivot objects, but conversion function depends on their existence
 	 * let's format an $node into the "nodes with pivot" format
-	 * @param array		$node	the data that needs to be converted; the node must have a 'parent_id' attribute
-	 * @param string	$name		the name of the type of object (ex: "topic" or "class")
-	 * @param int|null	$other_id	the id of the pivot's parent_id, if not the parent_id itself
-	 * @return array				the reformated data as a collection with a pivot attribute
+	 * @param array		$node			the data that needs to be converted; the node must have a 'parent_id' attribute
+	 * @param string	$name			the name of the type of object (ex: "topic" or "class")
+	 * @param int|null	$replace_child	the id of the pivot's parent_id, if not the parent_id itself
+	 * @return array					the reformated data as a collection with a pivot attribute
 	 * added and the 'parent_id' attribute removed
 	 */
 	public static function addPivot($node, $name, $replace_child=null)
diff --git a/app/Repositories/ClassRepository.php b/app/Repositories/ClassRepository.php
@@ -56,7 +56,7 @@ public function descendants(Academic_Class $class = null, int $levels = null, $r
 				);
 				$tree = $tree->merge(
 					// RECURSION!
-					$this->descendants($child, $levels - 1, $root)
+					$this->descendants($child, is_null($levels) ? null : $levels - 1, $root)
 				);
 			}
 		}
@@ -105,7 +105,7 @@ public function ancestors(Academic_Class $class = null, int $levels = null, $roo
 				);
 				$tree = $tree->merge(
 					// RECURSION!
-					$this->ancestors($parent, $levels - 1, $root)
+					$this->ancestors($parent, is_null($levels) ? null : $levels - 1, $root)
 				);
 			}
 		}
@@ -191,7 +191,7 @@ function ($class) use ($descendant_class_id, $connections)
 	/**
 	 * given a portion of the tree, check to see whether $ancestor_class_id is an ancestor of $class_id
 	 * @param  int			$class_id			the descendant class
-	 * @param  int|array	$ancestor_class_id	the ancestor to search for
+	 * @param  int|array	$ancestor_class_id	the ancestor(s) to search for
 	 * @param  Collection	$connections		a portion of the tree to traverse, in the connections or separated connections format
 	 * @return boolean|array					whether $ancestor_class_id is an ancestor of $class; if $ancestor_class_id is an array, return the elements in it that are ancestors
 	 */
diff --git a/app/Repositories/TopicRepository.php b/app/Repositories/TopicRepository.php
@@ -66,7 +66,7 @@ public function descendants(Topic $topic = null, int $levels = null, $root = nul
 				$tree->push(collect($child));
 				$tree = $tree->merge(
 					// RECURSION!
-					$this->descendants($child, $levels - 1, $root)
+					$this->descendants($child, is_null($levels) ? null : $levels - 1, $root)
 				);
 			}
 		}
@@ -114,7 +114,7 @@ public function ancestors(Topic $topic = null, int $levels = null, $root = null)
 				$tree->push(collect($parent));
 				$tree = $tree->merge(
 					// RECURSION!
-					$this->ancestors($parent, $levels - 1, $root)
+					$this->ancestors($parent, is_null($levels) ? null : $levels - 1, $root)
 				);
 			}
 		}
diff --git a/app/Rules/ValidClassParentAttachment.php b/app/Rules/ValidClassParentAttachment.php
@@ -45,6 +45,7 @@ public function __construct(Academic_Class $class=null, Collection $tree=null)
 	{
 		$this->class = $class;
 		$this->class_is_root = is_null($this->class) || $this->class->id == 0;
+		// check if class is root, if not, set tree to be an instance of NodesAndConnections else null
 		$this->tree = (is_null($tree) and !$this->class_is_root) ? $this->getTree() : $tree;
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ public function descendants(Topic $topic = null, int $levels = null, $root = nul`
`66`	`66`	`$tree->push(collect($child));`
`67`	`67`	`$tree = $tree->merge(`
`68`	`68`	`// RECURSION!`
`69`		`- $this->descendants($child, $levels - 1, $root)`
	`69`	`+ $this->descendants($child, is_null($levels) ? null : $levels - 1, $root)`
`70`	`70`	`);`
`71`	`71`	`}`
`72`	`72`	`}`
`@@ -114,7 +114,7 @@ public function ancestors(Topic $topic = null, int $levels = null, $root = null)`
`114`	`114`	`$tree->push(collect($parent));`
`115`	`115`	`$tree = $tree->merge(`
`116`	`116`	`// RECURSION!`
`117`		`- $this->ancestors($parent, $levels - 1, $root)`
	`117`	`+ $this->ancestors($parent, is_null($levels) ? null : $levels - 1, $root)`
`118`	`118`	`);`
`119`	`119`	`}`
`120`	`120`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@ public function __construct(Academic_Class $class=null, Collection $tree=null)`
`45`	`45`	`{`
`46`	`46`	`$this->class = $class;`
`47`	`47`	`$this->class_is_root = is_null($this->class) \|\| $this->class->id == 0;`
	`48`	`+ // check if class is root, if not, set tree to be an instance of NodesAndConnections else null`
`48`	`49`	`$this->tree = (is_null($tree) and !$this->class_is_root) ? $this->getTree() : $tree;`
`49`	`50`	`}`
`50`	`51`