Merge pull request #1217 from nowackipawel/patch-8

Optional parameter for resetSelect() call in Builder's countAll();

Author: lonnieezell

system/Database/BaseBuilder.php

@@ -1386,19 +1386,23 @@ public function getCompiledSelect($reset = true)
 	 *
 	 * @param    int $limit     The limit clause
 	 * @param    int $offset    The offset clause
-	 * @param    bool   $returnSQL If true, returns the generate SQL, otherwise executes the query.
+	 * @param    bool $returnSQL If true, returns the generate SQL, otherwise executes the query.
+	 * @param    bool $reset     Are we want to clear query builder values?
 	 *
 	 * @return    ResultInterface
 	 */
-	public function get(int $limit = null, int $offset = 0, $returnSQL = false)
+	public function get(int $limit = null, int $offset = 0, $returnSQL = false, $reset = true)
 	{
 		if ( ! is_null($limit))
 		{
 			$this->limit($limit, $offset);
 		}
 		$result = $returnSQL ? $this->getCompiledSelect() : $this->db->query($this->compileSelect(), $this->binds);
 
-		$this->resetSelect();
+		if($reset == true)
+		{
+			$this->resetSelect();
+		}
 
 		return $result;
 	}
@@ -1411,11 +1415,12 @@ public function get(int $limit = null, int $offset = 0, $returnSQL = false)
 	 * Generates a platform-specific query string that counts all records in
 	 * the specified database
 	 *
-	 * @param    bool $test Are we running automated tests?
+	 * @param    bool $reset Are we want to clear query builder values?
+	 * @param    bool $test  Are we running automated tests?
 	 *
 	 * @return    int
 	 */
-	public function countAll($test = false)
+	public function countAll($reset = true, $test = false)
 	{
 		$table = $this->QBFrom[0];
 
@@ -1434,7 +1439,11 @@ public function countAll($test = false)
 		}
 
 		$query = $query->getRow();
-		$this->resetSelect();
+		
+		if ($reset === true)
+		{
+			$this->resetSelect();
+		}
 
 		return (int) $query->numrows;
 	}
@@ -1457,6 +1466,7 @@ public function countAllResults($reset = true, $test = false)
 		// ORDER BY usage is often problematic here (most notably
 		// on Microsoft SQL Server) and ultimately unnecessary
 		// for selecting COUNT(*) ...
+		$orderby = [];
 		if ( ! empty($this->QBOrderBy))
 		{
 			$orderby = $this->QBOrderBy;
@@ -1480,7 +1490,7 @@ public function countAllResults($reset = true, $test = false)
 		// If we've previously reset the QBOrderBy values, get them back
 		elseif ( ! isset($this->QBOrderBy))
 		{
-			$this->QBOrderBy = $orderby;
+			$this->QBOrderBy = $orderby??[];
 		}
 
 		$row = (! $result instanceof ResultInterface)

tests/system/Database/Builder/CountTest.php

@@ -24,7 +24,7 @@ public function testCountAll()
 
 		$expectedSQL   = "SELECT COUNT(*) AS \"numrows\" FROM \"jobs\"";
 
-		$this->assertEquals($expectedSQL, $builder->countAll(true));
+		$this->assertEquals($expectedSQL, $builder->countAll(true, true));
 	}
 
 	//--------------------------------------------------------------------
@@ -33,7 +33,7 @@ public function testCountAllResults()
 	{
 		$builder = new BaseBuilder('jobs', $this->db);
 
-		$answer = $builder->where('id >', 3)->countAllResults(null, true);
+		$answer = $builder->where('id >', 3)->countAllResults(false, true);
 
 		$expectedSQL   = "SELECT COUNT(*) AS \"numrows\" FROM \"jobs\" WHERE \"id\" > :id:";
 

user_guide_src/source/database/query_builder.rst

@@ -511,29 +511,34 @@ The second parameter lets you set a result offset.
 
 	$builder->limit(10, 20);  // Produces: LIMIT 20, 10 (in MySQL.  Other databases have slightly different syntax)
 
+
 **$builder->countAllResults()**
 
 Permits you to determine the number of rows in a particular Query
 Builder query. Queries will accept Query Builder restrictors such as
 ``where()``, ``orWhere()``, ``like()``, ``orLike()``, etc. Example::
 
-	echo $builder->countAllResults('my_table');  // Produces an integer, like 25
+	echo $builder->countAllResults();  // Produces an integer, like 25
 	$builder->like('title', 'match');
 	$builder->from('my_table');
 	echo $builder->countAllResults(); // Produces an integer, like 17
 
 However, this method also resets any field values that you may have passed
 to ``select()``. If you need to keep them, you can pass ``FALSE`` as the
-second parameter::
+first parameter.
 
-	echo $builder->countAllResults('my_table', FALSE);
+	echo $builder->countAllResults(false); // Produces an integer, like 17
 
 **$builder->countAll()**
 
 Permits you to determine the number of rows in a particular table.
-Submit the table name in the first parameter. Example::
+Example::
 
-	echo $builder->countAll('my_table');  // Produces an integer, like 25
+	echo $builder->countAll();  // Produces an integer, like 25
+	
+As is in countAllResult method, this method resets any field values that you may have passed
+to ``select()`` as well. If you need to keep them, you can pass ``FALSE`` as the
+first parameter.
 
 **************
 Query grouping
@@ -994,6 +999,15 @@ Class Reference
 		Generates a platform-specific query string that counts
 		all records returned by an Query Builder query.
 
+	.. php:method:: countAll([$reset = TRUE])
+
+		:param	bool	$reset: Whether to reset values for SELECTs
+		:returns:	Number of rows in the query result
+		:rtype:	int
+
+		Generates a platform-specific query string that counts
+		all records returned by an Query Builder query.
+
 	.. php:method:: get([$limit = NULL[, $offset = NULL]])
 
 		:param	int	$limit: The LIMIT clause