Rename most function to align with SQL keywords

technicalguru · technicalguru · commit ba85b0e67327 · 2021-10-30T11:51:01.000+02:00
diff --git a/src/TgDatabase/Criterion/QueryImpl.php b/src/TgDatabase/Criterion/QueryImpl.php
@@ -47,7 +47,7 @@ public function clone() {
 	  * Resets the result class.
 	  * Useful when using #setColumns() as this method erases the result class.
 	  */
-	public function setResultClass(string $name) {
+	public function setResultClass(?string $name) {
 		$this->resultClassName = $name;
 		return $this;
 	}
@@ -56,41 +56,56 @@ public function setResultClass(string $name) {
 	  * Add a restriction to constrain the results to be retrieved.
 	  * @return Query - this query for method chaining.
 	  */
-	public function add(Criterion ...$criterions) {
+	public function where(Criterion ...$criterions) {
 		foreach ($criterions AS $criterion) $this->criterions[] = $criterion;
 		return $this;
 	}
 
+	/**
+	  * Add a restriction to constrain the results to be retrieved.
+	  * @return Query - this query for method chaining.
+	  */
+	public function add(Criterion ...$criterions) {
+		return call_user_func_array(array($this, 'where'), $criterions);
+	}
+
 	/**
 	  * Add an ordering to the result set.
 	  */
-	public function addOrder(Order ...$orders) {
+	public function orderBy(Order ...$orders) {
 		foreach ($orders AS $order) $this->orders[] = $order;
 		return $this;
 	}
 
+	/**
+	  * Add an ordering to the result set.
+	  */
+	public function addOrder(Order ...$orders) {
+		return call_user_func_array(array($this, 'orderBy'), $orders);
+	}
+
 	/**
 	  * Set projection for the query.
 	  * Attention! This class removes any result class name from the query. Use #setResultClass() after calling.
 	  * @deprecated Use #setColumns() instead
 	  */
 	public function setProjection(Expression ...$expressions) {
-		return call_user_func_array(array($this, 'setColumns'), $expressions);
+		return call_user_func_array(array($this, 'setSelect'), $expressions);
 	}
 
 	/**
 	  * Set select columns for the query.
 	  * Attention! This class removes any result class name from the query. Use #setResultClass() after calling.
 	  */
-	public function setColumns(Expression ...$expressions) {
+	public function setSelect(Expression ...$expressions) {
 		$this->columns = array();
-		return call_user_func_array(array($this, 'addColumns'), $expressions);
+		return call_user_func_array(array($this, 'select'), $expressions);
 	}
 
 	/**
 	  * Add select columns for the query.
 	  */
-	public function addColumns(Expression ...$expressions) {
+	public function select(Expression ...$expressions) {
 		foreach ($expressions AS $c) {
 			if ($c != NULL) $this->columns[] = $c;
 		}
@@ -144,9 +159,9 @@ public function getAlias() {
 	/**
 	  * Create a new join query.
 	  */
-	public function createJoinedQuery($tableName, $alias, $joinCriterion) {
+	public function createJoin($tableName, $alias, $joinCriterion) {
 		$rc = new QueryImpl($this->database, $tableName, NULL, $alias);
-		$this->addCriteria($rc, $joinCriterion);
+		$this->join($rc, $joinCriterion);
 		return $rc;
 	}
 
@@ -155,13 +170,13 @@ public function createJoinedQuery($tableName, $alias, $joinCriterion) {
 	  * @deprecated
 	  */
 	public function createCriteria($tableName, $alias, $joinCriterion) {
-		return $this->createJoinedQuery($tableName, $alias, $joinCriterion);
+		return $this->createJoin($tableName, $alias, $joinCriterion);
 	}
 
 	/**
 	  * Add a new join query.
 	  */
-	public function addJoinedQuery(Query $query, $joinCriterion) {
+	public function join(Query $query, $joinCriterion) {
 		$this->subqueries[] = array($query, $joinCriterion);
 		return $this;
 	}
@@ -171,7 +186,7 @@ public function addJoinedQuery(Query $query, $joinCriterion) {
 	  * @deprecated
 	  */
 	public function addCriteria(Query $query, $joinCriterion) {
-		return $this->addJoinedQuery($query, $joinCriterion);
+		return $this->join($query, $joinCriterion);
 	}
 
 	/**
@@ -190,7 +205,7 @@ public function list($throwException = FALSE) {
 	 * Count the results.
 	 */
 	public function count($throwException = FALSE) {
-		$query  = $this->clone()->setProjection(Projections::alias(Projections::rowCount(), 'cnt'));
+		$query  = $this->clone()->setProjection(Projections::alias(Projections::rowCount(), 'cnt'))->setResultClass(NULL);
 		$record = $query->first();
 		if ($query->hasError()) {
 			if ($throwException) {
@@ -250,6 +265,12 @@ public function getSelectSql() {
 		    $rc .= ' '.trim($join);
 		}
 		
+		// WHERE clauses
+		$where = $this->getWhereClause();
+		if ($where != NULL) {
+			$rc .= ' WHERE '.$where;
+		}
+		
 		// GROUP BY
 		$group = $this->getGroupByClause();
 		if ($group != NULL) {
@@ -262,12 +283,6 @@ public function getSelectSql() {
 			}
 		}
 		
-		// WHERE clauses
-		$where = $this->getWhereClause();
-		if ($where != NULL) {
-			$rc .= ' WHERE '.$where;
-		}
-		
 		// ORDER BY clauses
 		$orderBy = $this->getOrderByClause();
 		if ($orderBy != NULL) {
diff --git a/src/TgDatabase/DAO.php b/src/TgDatabase/DAO.php
@@ -105,12 +105,12 @@ public function createQuery($alias = NULL, $restrictions = array(), $order = arr
 		// Add restrictions
 		$restrictions = Restrictions::toRestrictions($restrictions);
 		if (Restrictions::$hasDeprecatedUse) $this->warnDeprecation();
-		if ($restrictions != NULL) $query->add($restrictions);
+		if ($restrictions != NULL) $query->where($restrictions);
 
 		// Add orders
 		if (!is_array($order)) $order = array($order);
 		foreach ($order AS $o) {
-			$query->addOrder(Order::toOrder($o));
+			$query->orderBy(Order::toOrder($o));
 			if (Order::$hasDeprecatedUse) $this->warnDeprecation();
 		}
 
diff --git a/src/TgDatabase/Query.php b/src/TgDatabase/Query.php
@@ -22,24 +22,36 @@ public function setResultClass(string $name);
 	  */
 	public function add(Criterion ...$criterion);
 
+	/**
+	  * Add a restriction to constrain the results to be retrieved.
+	  * @return Query - this query for method chaining.
+	  */
+	public function where(Criterion ...$criterion);
+
 	/**
 	  * Add an ordering to the result set.
 	  * @return Query - this query for method chaining.
 	  */
 	public function addOrder(Order ...$order);
 
+	/**
+	  * Add an ordering to the result set.
+	  * @return Query - this query for method chaining.
+	  */
+	public function orderBy(Order ...$order);
+
 	/**
 	  * Add select columns for the query.
 	  * @return Query - this query for method chaining.
 	  */
-	public function addColumns(Expression ...$expressions);
+	public function select(Expression ...$expressions);
 
 	/**
 	  * Set select columns for the query.
 	  * Attention! This class removes any result class name from the query. Use #setResultClass() after calling.
 	  * @return Query - this query for method chaining.
 	  */
-	public function setColumns(Expression ...$expressions);
+	public function setSelect(Expression ...$expressions);
 
 	/**
 	  * Add projections for the query.
@@ -76,7 +88,7 @@ public function setMaxResults(int $maxResults);
 	/**
 	  * Create a new join query.
 	  */
-	public function createJoinedQuery($tableName, $alias, $joinCriterion);
+	public function createJoin($tableName, $alias, $joinCriterion);
 
 	/**
 	  * Create a new join query.
@@ -88,7 +100,7 @@ public function createCriteria($tableName, $alias, $joinCriterion);
 	  * Add a new join query.
 	  * @return Query - this query for method chaining.
 	  */
-	public function addJoinedQuery(Query $query, $joinCriterion);
+	public function join(Query $query, $joinCriterion);
 
 	/**
 	  * Add a new join query.
diff --git a/tests/TgDatabase/Criterion/QueryImplTest.php b/tests/TgDatabase/Criterion/QueryImplTest.php
@@ -21,8 +21,8 @@ public function testSimple(): void {
         $database = TestHelper::getDatabase();
         if ($database != NULL) {
             $query = new QueryImpl($database, 'dual');
-            $query->add(Restrictions::eq('aName', 'aValue'));
-            $query->addOrder(Order::asc('anotherName'));
+            $query->where(Restrictions::eq('aName', 'aValue'));
+            $query->orderBy(Order::asc('anotherName'));
             $this->assertEquals('SELECT * FROM `dual` WHERE (`aName` = \'aValue\') ORDER BY `anotherName`', $query->getSelectSql());
         }
     }
@@ -41,7 +41,7 @@ public function testSimpleProjection(): void {
         $database = TestHelper::getDatabase();
         if ($database != NULL) {
             $query = new QueryImpl($database, 'dual');
-            $query->setProjection(Projections::rowCount('cnt'));
+            $query->select(Projections::rowCount('cnt'));
             $this->assertEquals('SELECT COUNT(*) AS `cnt` FROM `dual`', $query->getSelectSql());
         }
     }
@@ -50,7 +50,7 @@ public function testSetColumns(): void {
         $database = TestHelper::getDatabase();
         if ($database != NULL) {
             $query = new QueryImpl($database, 'dual');
-            $query->setColumns(Projections::property('column1'), Projections::property('column2'));
+            $query->select(Projections::property('column1'), Projections::property('column2'));
             $this->assertEquals('SELECT `column1`, `column2` FROM `dual`', $query->getSelectSql());
         }
     }
@@ -59,7 +59,7 @@ public function testCombineColumns(): void {
         $database = TestHelper::getDatabase();
         if ($database != NULL) {
             $query = new QueryImpl($database, 'dual');
-            $query->setColumns(Projections::properties('column1', 'column2'));
+            $query->select(Projections::properties('column1', 'column2'));
             $this->assertEquals('SELECT `column1`, `column2` FROM `dual`', $query->getSelectSql());
         }
     }
@@ -68,7 +68,7 @@ public function testAddColumns(): void {
         $database = TestHelper::getDatabase();
         if ($database != NULL) {
             $query = new QueryImpl($database, 'dual');
-            $query->addColumns(Projections::property('column1'))->addColumns(Projections::property('column2'));
+            $query->select(Projections::property('column1'))->select(Projections::property('column2'));
             $this->assertEquals('SELECT `column1`, `column2` FROM `dual`', $query->getSelectSql());
         }
     }
@@ -77,7 +77,7 @@ public function testJoin(): void {
         $database = TestHelper::getDatabase();
         if ($database != NULL) {
             $query = new QueryImpl($database, 'dual', NULL, 'a');
-            $query->createJoinedQuery('otherTable', 'b', Restrictions::eqProperty(array('a', 'details'), array('b', 'uid')));
+            $query->createJoin('otherTable', 'b', Restrictions::eqProperty(array('a', 'details'), array('b', 'uid')));
             $this->assertEquals('SELECT `a`.* FROM `dual` AS `a` INNER JOIN `otherTable` AS `b` ON `a`.`details` = `b`.`uid`', $query->getSelectSql());
         }
     }
@@ -151,7 +151,7 @@ public function testDeleteWhereSql(): void {
         $database = TestHelper::getDatabase();
         if ($database != NULL) {
             $query = new QueryImpl($database, 'dual');
-            $query->add(Restrictions::eq('attr3', 'value3'));
+            $query->where(Restrictions::eq('attr3', 'value3'));
             $this->assertEquals("DELETE FROM `dual` WHERE (`attr3` = 'value3')", $query->getDeleteSql());
         }
     }
@@ -161,10 +161,10 @@ public function testGroupBySql(): void {
         if ($database != NULL) {
             $query = new QueryImpl($database, 'dual');
             $query
-				->addColumns(Projections::property('attr1'), Projections::rowCount('cnt'))
-				->add(Restrictions::eq('attr3', 'value3'))
+				->select(Projections::property('attr1'), Projections::rowCount('cnt'))
+				->where(Restrictions::eq('attr3', 'value3'))
 				->groupBy(Projections::property('attr1'));
-            $this->assertEquals("SELECT `attr1`, COUNT(*) AS `cnt` FROM `dual` GROUP BY `attr1` WHERE (`attr3` = 'value3')", $query->getSelectSql());
+            $this->assertEquals("SELECT `attr1`, COUNT(*) AS `cnt` FROM `dual` WHERE (`attr3` = 'value3') GROUP BY `attr1`", $query->getSelectSql());
         }
     }
 
@@ -173,11 +173,11 @@ public function testHavingSql(): void {
         if ($database != NULL) {
             $query = new QueryImpl($database, 'dual');
             $query
-				->addColumns(Projections::property('attr1'), Projections::rowCount('cnt'))
-				->add(Restrictions::eq('attr3', 'value3'))
+				->select(Projections::property('attr1'), Projections::rowCount('cnt'))
+				->where(Restrictions::eq('attr3', 'value3'))
 				->groupBy(Projections::property('attr1'))
 				->having(Restrictions::eq('attr1', 'value1'));
-            $this->assertEquals("SELECT `attr1`, COUNT(*) AS `cnt` FROM `dual` GROUP BY `attr1` HAVING (`attr1` = 'value1') WHERE (`attr3` = 'value3')", $query->getSelectSql());
+            $this->assertEquals("SELECT `attr1`, COUNT(*) AS `cnt` FROM `dual` WHERE (`attr3` = 'value3') GROUP BY `attr1` HAVING (`attr1` = 'value1')", $query->getSelectSql());
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -21,8 +21,8 @@ public function testSimple(): void {`
`21`	`21`	`$database = TestHelper::getDatabase();`
`22`	`22`	`if ($database != NULL) {`
`23`	`23`	`$query = new QueryImpl($database, 'dual');`
`24`		`- $query->add(Restrictions::eq('aName', 'aValue'));`
`25`		`- $query->addOrder(Order::asc('anotherName'));`
	`24`	`+ $query->where(Restrictions::eq('aName', 'aValue'));`
	`25`	`+ $query->orderBy(Order::asc('anotherName'));`
`26`	`26`	$this->assertEquals('SELECT * FROM `dual` WHERE (`aName` = \'aValue\') ORDER BY `anotherName`', $query->getSelectSql());
`27`	`27`	`}`
`28`	`28`	`}`
`@@ -41,7 +41,7 @@ public function testSimpleProjection(): void {`
`41`	`41`	`$database = TestHelper::getDatabase();`
`42`	`42`	`if ($database != NULL) {`
`43`	`43`	`$query = new QueryImpl($database, 'dual');`
`44`		`- $query->setProjection(Projections::rowCount('cnt'));`
	`44`	`+ $query->select(Projections::rowCount('cnt'));`
`45`	`45`	$this->assertEquals('SELECT COUNT(*) AS `cnt` FROM `dual`', $query->getSelectSql());
`46`	`46`	`}`
`47`	`47`	`}`
`@@ -50,7 +50,7 @@ public function testSetColumns(): void {`
`50`	`50`	`$database = TestHelper::getDatabase();`
`51`	`51`	`if ($database != NULL) {`
`52`	`52`	`$query = new QueryImpl($database, 'dual');`
`53`		`- $query->setColumns(Projections::property('column1'), Projections::property('column2'));`
	`53`	`+ $query->select(Projections::property('column1'), Projections::property('column2'));`
`54`	`54`	$this->assertEquals('SELECT `column1`, `column2` FROM `dual`', $query->getSelectSql());
`55`	`55`	`}`
`56`	`56`	`}`
`@@ -59,7 +59,7 @@ public function testCombineColumns(): void {`
`59`	`59`	`$database = TestHelper::getDatabase();`
`60`	`60`	`if ($database != NULL) {`
`61`	`61`	`$query = new QueryImpl($database, 'dual');`
`62`		`- $query->setColumns(Projections::properties('column1', 'column2'));`
	`62`	`+ $query->select(Projections::properties('column1', 'column2'));`
`63`	`63`	$this->assertEquals('SELECT `column1`, `column2` FROM `dual`', $query->getSelectSql());
`64`	`64`	`}`
`65`	`65`	`}`
`@@ -68,7 +68,7 @@ public function testAddColumns(): void {`
`68`	`68`	`$database = TestHelper::getDatabase();`
`69`	`69`	`if ($database != NULL) {`
`70`	`70`	`$query = new QueryImpl($database, 'dual');`
`71`		`- $query->addColumns(Projections::property('column1'))->addColumns(Projections::property('column2'));`
	`71`	`+ $query->select(Projections::property('column1'))->select(Projections::property('column2'));`
`72`	`72`	$this->assertEquals('SELECT `column1`, `column2` FROM `dual`', $query->getSelectSql());
`73`	`73`	`}`
`74`	`74`	`}`
`@@ -77,7 +77,7 @@ public function testJoin(): void {`
`77`	`77`	`$database = TestHelper::getDatabase();`
`78`	`78`	`if ($database != NULL) {`
`79`	`79`	`$query = new QueryImpl($database, 'dual', NULL, 'a');`
`80`		`- $query->createJoinedQuery('otherTable', 'b', Restrictions::eqProperty(array('a', 'details'), array('b', 'uid')));`
	`80`	`+ $query->createJoin('otherTable', 'b', Restrictions::eqProperty(array('a', 'details'), array('b', 'uid')));`
`81`	`81`	$this->assertEquals('SELECT `a`.* FROM `dual` AS `a` INNER JOIN `otherTable` AS `b` ON `a`.`details` = `b`.`uid`', $query->getSelectSql());
`82`	`82`	`}`
`83`	`83`	`}`
`@@ -151,7 +151,7 @@ public function testDeleteWhereSql(): void {`
`151`	`151`	`$database = TestHelper::getDatabase();`
`152`	`152`	`if ($database != NULL) {`
`153`	`153`	`$query = new QueryImpl($database, 'dual');`
`154`		`- $query->add(Restrictions::eq('attr3', 'value3'));`
	`154`	`+ $query->where(Restrictions::eq('attr3', 'value3'));`
`155`	`155`	$this->assertEquals("DELETE FROM `dual` WHERE (`attr3` = 'value3')", $query->getDeleteSql());
`156`	`156`	`}`
`157`	`157`	`}`
`@@ -161,10 +161,10 @@ public function testGroupBySql(): void {`
`161`	`161`	`if ($database != NULL) {`
`162`	`162`	`$query = new QueryImpl($database, 'dual');`
`163`	`163`	`$query`
`164`		`- ->addColumns(Projections::property('attr1'), Projections::rowCount('cnt'))`
`165`		`- ->add(Restrictions::eq('attr3', 'value3'))`
	`164`	`+ ->select(Projections::property('attr1'), Projections::rowCount('cnt'))`
	`165`	`+ ->where(Restrictions::eq('attr3', 'value3'))`
`166`	`166`	`->groupBy(Projections::property('attr1'));`
`167`		- $this->assertEquals("SELECT `attr1`, COUNT(*) AS `cnt` FROM `dual` GROUP BY `attr1` WHERE (`attr3` = 'value3')", $query->getSelectSql());
	`167`	+ $this->assertEquals("SELECT `attr1`, COUNT(*) AS `cnt` FROM `dual` WHERE (`attr3` = 'value3') GROUP BY `attr1`", $query->getSelectSql());
`168`	`168`	`}`
`169`	`169`	`}`
`170`	`170`
`@@ -173,11 +173,11 @@ public function testHavingSql(): void {`
`173`	`173`	`if ($database != NULL) {`
`174`	`174`	`$query = new QueryImpl($database, 'dual');`
`175`	`175`	`$query`
`176`		`- ->addColumns(Projections::property('attr1'), Projections::rowCount('cnt'))`
`177`		`- ->add(Restrictions::eq('attr3', 'value3'))`
	`176`	`+ ->select(Projections::property('attr1'), Projections::rowCount('cnt'))`
	`177`	`+ ->where(Restrictions::eq('attr3', 'value3'))`
`178`	`178`	`->groupBy(Projections::property('attr1'))`
`179`	`179`	`->having(Restrictions::eq('attr1', 'value1'));`
`180`		- $this->assertEquals("SELECT `attr1`, COUNT(*) AS `cnt` FROM `dual` GROUP BY `attr1` HAVING (`attr1` = 'value1') WHERE (`attr3` = 'value3')", $query->getSelectSql());
	`180`	+ $this->assertEquals("SELECT `attr1`, COUNT(*) AS `cnt` FROM `dual` WHERE (`attr3` = 'value3') GROUP BY `attr1` HAVING (`attr1` = 'value1')", $query->getSelectSql());
`181`	`181`	`}`
`182`	`182`	`}`
`183`	`183`