Bugfix nested reindex overwrite

Author: MGatner

src/Model.php

@@ -17,6 +17,9 @@ class Model extends \CodeIgniter\Model
 	// Array of tables to block from loading relations
 	protected $without = [];
 
+	// Whether to reindex results by the primary key
+	protected $reindex = true;
+	
 	// Call the CI model constructor then check for and load the schema
 	public function __construct(ConnectionInterface &$db = null, ValidationInterface $validation = null)
 	{
@@ -90,7 +93,48 @@ public function without($tables)
 
 		return $this;
 	}
+	
+	/**
+	 * Reset per-query variables.
+	 *
+	 * @return $this
+	 */
+	public function resetTmp()
+	{
+		unset($this->tmpWith, $this->tmpWithout, $this->tmpReindex);
+		
+		return $this;
+	}
 
+	/**
+	 * Enable/disable result reindexing.
+	 *
+	 * @param bool    $bool
+	 *
+	 * @return $this
+	 */
+	public function reindex(bool $bool = true)
+	{
+		$this->reindex = $bool;
+		
+		return $this;
+	}
+
+	/**
+	 * Intercept join requests to disable reindexing.
+	 *
+	 * @return $this
+	 */	
+	public function join(...$params)
+	{
+		$this->tmpReindex = false;
+		
+		// Pass through to the builder
+		$this->builder()->join(...$params);
+		
+		return $this;
+	}
+	
 	//--------------------------------------------------------------------
 	// FINDERS EXTENSIONS
 	//--------------------------------------------------------------------
@@ -165,14 +209,14 @@ protected function addRelated($rows): ?array
 		// If there were no matches then reset per-query data and quit
 		if (empty($rows))
 		{
-			unset($this->tmpWith, $this->tmpWithout);
+			$this->tmpReset();
 			return $rows;
 		}
 
 		// Likewise for empty singletons
 		if (count($rows) == 1 && reset($rows) == null)
 		{
-			unset($this->tmpWith, $this->tmpWithout);
+			$this->tmpReset();
 			return $rows;
 		}
 
@@ -186,15 +230,21 @@ protected function addRelated($rows): ?array
 		{
 			$this->tmpWithout = $this->without;
 		}
+		// If no tmpReindex was set then use this model's default
+		if (! isset($this->tmpReindex))
+		{
+			$this->tmpReindex = $this->reindex;
+		}
 
 		// Remove any blocked tables from the request
 		$this->tmpWith = array_diff($this->tmpWith, $this->tmpWithout);
 
 		// If tmpWith ends up empty then reset and quit
 		if (empty($this->tmpWith))
 		{
-			unset($this->tmpWith, $this->tmpWithout);
-			return $this->simpleReindex($rows);
+			$rows = $this->tmpReindex ? $this->simpleReindex($rows) : $rows;
+			$this->tmpReset();
+			return $rows;
 		}
 
 		// Make sure the schema is loaded
@@ -210,7 +260,7 @@ protected function addRelated($rows): ?array
 			$relations[$tableName] = $this->findRelated($tableName, $ids);
 		}
 
-		// Reindex $rows by this model's primary key and inject related items
+		// Inject related items
 		$return = [];
 		foreach ($rows as $item)
 		{
@@ -257,11 +307,19 @@ protected function addRelated($rows): ?array
 				}
 			}
 
-			$return[$id] = $item;
+			if ($this->tmpReindex)
+			{
+				$return[$id] = $item;
+			}
+			else
+			{
+				$return[] = $item;
+			}
 		}
 
 		// Clear old data and reset per-query properties
-		unset($rows, $this->tmpWith, $this->tmpWithout);
+		unset($rows);
+		$this->resetTmp();
 
 		return $return;
 	}
@@ -310,6 +368,9 @@ public function findRelated($tableName, $ids): array
 			// Check for another Relations model to prevent nesting loops
 			if ($builder instanceof self)
 			{
+				// Don't reindex (we'll do our own below)
+				$builder->reindex(false);
+
 				// If nesting is allowed we need to disable the target table
 				if (self::$config->allowNesting)
 				{
@@ -389,7 +450,7 @@ public function findRelated($tableName, $ids): array
 
 		// Clean up
 		unset($table, $relation, $builder);
-
+		
 		// Reindex the results by the originating ID (this model's primary key)
 		$return = [];
 		if ($returnType == 'array')
@@ -416,15 +477,15 @@ public function findRelated($tableName, $ids): array
 	}
 
 	/**
-	 * Reindexes $rows from a finder by their primary KEY_AS_FILENAME
+	 * Reindexes $rows from a finder by their primary key
 	 * Mostly used for consistent return format when no relations are requested
 	 * If multiple rows have the same primary (e.g. a join) it returns the originals
 	 *
 	 * @param array  $rows  Array of rows from the finder
 	 *
 	 * @return array
 	 */
-	protected function simpleReindex($rows): array
+	public function simpleReindex($rows): array
 	{
 		if (empty($rows))
 		{

tests/database/RelationsTest.php

@@ -20,6 +20,13 @@ public function testReindex()
         $this->assertEquals([1, 3, 4], array_keys($factories));
 	}
 
+	public function testNotReindex()
+	{
+		$factories = $this->factories->with(false)->reindex(false)->findAll();
+		
+        $this->assertEquals([0, 1, 2], array_keys($factories));
+	}
+	
 	public function testWithExplicit()
 	{
 		$worker = $this->workers->with('factories')->find(1);
@@ -48,7 +55,7 @@ public function testNestedRelations()
 	{
 		$servicer = $this->servicers->with('machines')->find(1);
 		$factory  = $this->factories->with(false)->find(1);
-		
+
         $this->assertEquals($factory, $servicer->machines[1]->factory);
 	}
 
@@ -60,4 +67,16 @@ public function testNestedRelationsNotTooDeep()
         $this->assertEquals($factory, $factories[1]->machines[1]->factory);
         $this->assertObjectNotHasAttribute('machines', $factories[1]->machines[1]->factory);
 	}
+	
+	public function testBelongsToNested()
+	{
+		$machines  = $this->machines->findAll();
+		$factories = $this->factories->with(false)->findAll();
+
+        $this->assertEquals($factories[1], $machines[1]->factory);
+
+        $this->assertEquals($factories[1], $machines[3]->factory);
+
+        $this->assertEquals($factories[3], $machines[6]->factory);
+	}
 }