Merge pull request #3794 from MGatner/builder-table

Builder Tables

Author: paulbalandan

system/Database/BaseBuilder.php

@@ -185,6 +185,15 @@ class BaseBuilder
 	 */
 	protected $db;
 
+	/**
+	 * Name of the primary table for this instance.
+	 * Tracked separately because $QBFrom gets escaped
+	 * and prefixed.
+	 *
+	 * @var string
+	 */
+	protected $tableName;
+
 	/**
 	 * ORDER BY random keyword
 	 *
@@ -286,6 +295,7 @@ public function __construct($tableName, ConnectionInterface &$db, array $options
 
 		$this->db = $db;
 
+		$this->tableName = $tableName;
 		$this->from($tableName);
 
 		if (! empty($options))
@@ -330,6 +340,18 @@ public function testMode(bool $mode = true)
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * Gets the name of the primary table.
+	 *
+	 * @return string
+	 */
+	public function getTable(): string
+	{
+		return $this->tableName;
+	}
+
+	//--------------------------------------------------------------------
+
 	/**
 	 * Returns an array of bind values and their
 	 * named parameters for binding in the Query object later.

system/Model.php

@@ -1394,12 +1394,19 @@ public function protect(bool $protect = true)
 	 * @param string $table
 	 *
 	 * @return BaseBuilder
-	 * @throws ModelException ;
+	 * @throws ModelException
 	 */
-	protected function builder(string $table = null)
+	public function builder(string $table = null)
 	{
+		// Check for an existing Builder
 		if ($this->builder instanceof BaseBuilder)
 		{
+			// Make sure the requested table matches the builder
+			if ($table && $this->builder->getTable() !== $table)
+			{
+				return $this->db->table($table);
+			}
+
 			return $this->builder;
 		}
 
@@ -1419,9 +1426,15 @@ protected function builder(string $table = null)
 			$this->db = Database::connect($this->DBGroup);
 		}
 
-		$this->builder = $this->db->table($table);
+		$builder = $this->db->table($table);
+
+		// Only consider it "shared" if the table is correct
+		if ($table === $this->table)
+		{
+			$this->builder = $builder;
+		}
 
-		return $this->builder;
+		return $builder;
 	}
 
 	/**
@@ -1973,10 +1986,7 @@ public function __call(string $name, array $params)
 			$result = $builder->{$name}(...$params);
 		}
 
-		// Don't return the builder object unless specifically requested
-		//, since that will interrupt the usability flow
-		// and break intermingling of model and builder methods.
-		if ($name !== 'builder' && empty($result))
+		if (empty($result))
 		{
 			if (! method_exists($this->builder(), $name))
 			{
@@ -1988,7 +1998,7 @@ public function __call(string $name, array $params)
 			return $result;
 		}
 
-		if ($name !== 'builder' && ! $result instanceof BaseBuilder)
+		if (! $result instanceof BaseBuilder)
 		{
 			return $result;
 		}

tests/system/Database/Builder/BaseTest.php

@@ -26,4 +26,23 @@ public function testDbReturnsConnection()
 
 		$this->assertInstanceOf(MockConnection::class, $result);
 	}
+
+	//--------------------------------------------------------------------
+
+	public function testGetTableReturnsTable()
+	{
+		$builder = $this->db->table('jobs');
+
+		$result = $builder->getTable();
+		$this->assertEquals('jobs', $result);
+	}
+
+	public function testGetTableIgnoresFrom()
+	{
+		$builder = $this->db->table('jobs');
+
+		$builder->from('foo');
+		$result = $builder->getTable();
+		$this->assertEquals('jobs', $result);
+	}
 }

tests/system/Database/Live/ModelTest.php

@@ -2487,19 +2487,6 @@ public function testUndefinedModelMethod()
 		$model->undefinedMethodCall();
 	}
 
-	public function testUndefinedMethodInBuilder()
-	{
-		$model = new JobModel($this->db);
-
-		$model->find(1);
-
-		$this->expectException(BadMethodCallException::class);
-		$this->expectExceptionMessage('Call to undefined method Tests\Support\Models\JobModel::getBindings');
-
-		$binds = $model->builder()
-			->getBindings();
-	}
-
 	/**
 	 * @dataProvider provideAggregateAndGroupBy
 	 */
@@ -2643,4 +2630,37 @@ public function testSetAllowedFields()
 		$model->setAllowedFields($allowed2);
 		$this->assertSame($allowed2, $this->getPrivateProperty($model, 'allowedFields'));
 	}
+
+	//--------------------------------------------------------------------
+
+	public function testBuilderUsesModelTable()
+	{
+		$model   = new UserModel($this->db);
+		$builder = $model->builder();
+
+		$this->assertEquals('user', $builder->getTable());
+	}
+
+	public function testBuilderRespectsTableParameter()
+	{
+		$model    = new UserModel($this->db);
+		$builder1 = $model->builder('jobs');
+		$builder2 = $model->builder();
+
+		$this->assertEquals('jobs', $builder1->getTable());
+		$this->assertEquals('user', $builder2->getTable());
+	}
+
+	public function testBuilderWithParameterIgnoresShared()
+	{
+		$model = new UserModel($this->db);
+
+		$builder1 = $model->builder();
+		$builder2 = $model->builder('jobs');
+		$builder3 = $model->builder();
+
+		$this->assertEquals('user', $builder1->getTable());
+		$this->assertEquals('jobs', $builder2->getTable());
+		$this->assertEquals('user', $builder3->getTable());
+	}
 }

user_guide_src/source/models/model.rst

@@ -670,7 +670,10 @@ need it::
 
 	$builder = $userModel->builder();
 
-This builder is already set up with the model's $table.
+This builder is already set up with the model's $table. If you need access to another table
+you can pass it in as a parameter, but be aware that this will not return a shared instance::
+
+	$groupBuilder = $userModel->builder('groups');
 
 You can also use Query Builder methods and the Model's CRUD methods in the same chained call, allowing for
 very elegant use::