rename Query::sql() to getSQL()

codemasher · codemasher · commit feff84f54b3a · 2024-08-27T20:33:21.000+02:00
diff --git a/src/Query/AlterDatabase.php b/src/Query/AlterDatabase.php
@@ -23,7 +23,7 @@ public function name(string $dbname):static{
 		return $this->setName($dbname);
 	}
 
-	protected function getSQL():array{
+	protected function sql():array{
 		return []; // @todo
 	}
 
diff --git a/src/Query/AlterTable.php b/src/Query/AlterTable.php
@@ -24,7 +24,7 @@ public function name(string $tablename):static{
 		return $this->setName($tablename);
 	}
 
-	protected function getSQL():array{
+	protected function sql():array{
 		return []; // @todo
 	}
 
diff --git a/src/Query/CreateDatabase.php b/src/Query/CreateDatabase.php
@@ -32,7 +32,7 @@ public function ifNotExists():static{
 	}
 
 	/** @inheritdoc */
-	protected function getSQL():array{
+	protected function sql():array{
 		return $this->dialect->createDatabase($this->name, $this->ifNotExists, $this->charset);
 	}
 
diff --git a/src/Query/CreateTable.php b/src/Query/CreateTable.php
@@ -42,7 +42,7 @@ public function ifNotExists():static{
 		return $this->setIfNotExists();
 	}
 
-	protected function getSQL():array{
+	protected function sql():array{
 		return $this->dialect->createTable($this->name, $this->cols, $this->primaryKey, $this->ifNotExists, $this->temp, $this->dir);
 	}
 
diff --git a/src/Query/Delete.php b/src/Query/Delete.php
@@ -44,7 +44,7 @@ public function offset(int $offset):static{
 		return $this->setOffset($offset);
 	}
 
-	protected function getSQL():array{
+	protected function sql():array{
 		return $this->dialect->delete($this->name, $this->getWhere());
 	}
 
diff --git a/src/Query/DropDatabase.php b/src/Query/DropDatabase.php
@@ -28,7 +28,7 @@ public function ifExists():static{
 	}
 
 	/** @inheritdoc */
-	protected function getSQL():array{
+	protected function sql():array{
 		return $this->dialect->dropDatabase($this->name, $this->ifExists);
 	}
 
diff --git a/src/Query/DropTable.php b/src/Query/DropTable.php
@@ -29,7 +29,7 @@ public function ifExists():static{
 	}
 
 	/** @inheritdoc */
-	protected function getSQL():array{
+	protected function sql():array{
 		return $this->dialect->dropTable($this->name, $this->ifExists);
 	}
 
diff --git a/src/Query/Insert.php b/src/Query/Insert.php
@@ -42,7 +42,7 @@ public function values(iterable $values):static{
 		return $this;
 	}
 
-	protected function getSQL():array{
+	protected function sql():array{
 
 		if(empty($this->bindValues)){
 			throw new QueryException('no values given');
diff --git a/src/Query/Query.php b/src/Query/Query.php
@@ -13,7 +13,7 @@
 
 interface Query{
 
-	public function sql(bool|null $multi = null):string;
+	public function getSQL(bool|null $multi = null):string;
 
 	/**
 	 * @throws \chillerlan\Database\Query\QueryException
diff --git a/src/Query/Select.php b/src/Query/Select.php
@@ -53,7 +53,7 @@ public function cached(int|null $ttl = null):static{
 		return $this->setCached($ttl);
 	}
 
-	protected function getSQL():array{
+	protected function sql():array{
 
 		if(empty($this->from)){
 			throw new QueryException('no FROM expression specified');
diff --git a/src/Query/ShowCreateTable.php b/src/Query/ShowCreateTable.php
@@ -17,7 +17,7 @@ public function name(string $name):static{
 		return $this->setName($name);
 	}
 
-	protected function getSQL():array{
+	protected function sql():array{
 		return $this->dialect->showCreateTable($this->name);
 	}
 
diff --git a/src/Query/ShowDatabases.php b/src/Query/ShowDatabases.php
@@ -13,7 +13,7 @@
 
 class ShowDatabases extends StatementAbstract implements Query{
 
-	protected function getSQL():array{
+	protected function sql():array{
 		return $this->dialect->showDatabases(); // @todo? WHERE
 	}
 
diff --git a/src/Query/ShowTables.php b/src/Query/ShowTables.php
@@ -33,7 +33,7 @@ public function closeBracket():static{
 		return $this->setCloseBracket();
 	}
 
-	protected function getSQL():array{
+	protected function sql():array{
 		return $this->dialect->showTables($this->name, $this->pattern, $this->getWhere());
 	}
 
diff --git a/src/Query/StatementAbstract.php b/src/Query/StatementAbstract.php
@@ -143,7 +143,7 @@ protected function setWhere(mixed $val1, mixed $val2, string|null $operator = nu
 
 				}
 				else if($val2 instanceof Query){
-					$where[] = $operator.'('.$val2->sql().')';
+					$where[] = $operator.'('.$val2->getSQL().')';
 
 					if($val2 instanceof BindValues){
 						$this->bindValues = array_merge($this->bindValues, $val2->getBindValues());
@@ -157,7 +157,7 @@ protected function setWhere(mixed $val1, mixed $val2, string|null $operator = nu
 				$where[] = $operator;
 
 				if($val2 instanceof Query){
-					$where[] = '('.$val2->sql().')';
+					$where[] = '('.$val2->getSQL().')';
 
 					if($val2 instanceof BindValues){
 						$this->bindValues = array_merge($this->bindValues, $val2->getBindValues());
@@ -246,22 +246,22 @@ protected function getWhere():string{
 	/**
 	 * @throws \chillerlan\Database\Query\QueryException
 	 */
-	protected function getSQL():array{
-		throw new QueryException('getSQL() not supported/implemented');
+	protected function sql():array{
+		throw new QueryException('sql() not supported/implemented');
 	}
 
 	/**
 	 * @throws \chillerlan\Database\Query\QueryException
 	 */
-	public function sql(bool|null $multi = null):string{
+	public function getSQL(bool|null $multi = null):string{
 
 		if(!$this instanceof Query){
 			throw new QueryException('Query not supported');
 		}
 
 		$this->multi = $multi ?? false;
 
-		$sql = trim(implode(' ', $this->getSQL()));
+		$sql = trim(implode(' ', $this->sql()));
 
 		// this should only happen on a corrupt dialect implementation
 		if(empty($sql)){
@@ -351,7 +351,7 @@ public function executeQuery(string|null $index = null):Result{
 			throw new QueryException('Query not supported');
 		}
 
-		$sql    = $this->sql(false);
+		$sql    = $this->getSQL(false);
 		$values = $this instanceof BindValues ? $this->getBindValues() : null;
 
 		$this->logger->debug('QueryTrait::executeQuery()', ['method' => __METHOD__, 'sql' => $sql, 'val' => $values, 'index' => $index]);
@@ -372,7 +372,7 @@ public function executeMultiQuery(array|null $values = null, Closure|null $callb
 			throw new QueryException('MultiQuery not supported');
 		}
 
-		$sql = $this->sql(true);
+		$sql = $this->getSQL(true);
 
 		if($values !== null && $callback !== null){
 			$this->logger->debug('MultiQueryTrait::executeMultiQuery()', ['method' => __METHOD__, 'sql' => $sql, 'val' => $values]);
diff --git a/src/Query/Truncate.php b/src/Query/Truncate.php
@@ -22,7 +22,7 @@ public function table(string $name):static{
 		return $this->setName($name);
 	}
 
-	protected function getSQL():array{
+	protected function sql():array{
 		return $this->dialect->truncate($this->name);
 	}
 
diff --git a/src/Query/Update.php b/src/Query/Update.php
@@ -48,7 +48,7 @@ public function offset(int $offset):static{
 		return $this->setOffset($offset);
 	}
 
-	protected function getSQL():array{
+	protected function sql():array{
 
 		if(empty($this->set)){
 			throw new QueryException('no fields to update specified');
@@ -62,7 +62,7 @@ public function set(array $set, bool|null $bind = null):static{
 		foreach($set as $k => $v){
 
 			if($v instanceof Statement){
-				$this->set[] = $this->dialect->quote($k).' = ('.$v->sql().')';
+				$this->set[] = $this->dialect->quote($k).' = ('.$v->getSQL().')';
 
 				if($v instanceof BindValues){
 					$this->bindValues = array_merge($this->bindValues, $v->getBindValues());
diff --git a/tests/Query/QueryTestAbstract.php b/tests/Query/QueryTestAbstract.php
@@ -213,7 +213,7 @@ public function testSelectCached():void{
 
 		$r           = $this->db->select->from([$this::TABLE])->cached(2);
 		$getCacheKey = $this->getMethod('cacheKey');
-		$cacheKey    = $getCacheKey->invokeArgs($this->db, [$r->sql(), [], 'hash']);
+		$cacheKey    = $getCacheKey->invokeArgs($this->db, [$r->getSQL(), [], 'hash']);
 
 		// uncached
 		$this::assertFalse($this->cache->has($cacheKey));
@@ -228,22 +228,22 @@ public function testSelectCached():void{
 
 		// raw uncached
 		$this::assertFalse($this->cache->has($cacheKey));
-		$this->db->rawCached($r->sql(), 'hash', true, 1);
+		$this->db->rawCached($r->getSQL(), 'hash', true, 1);
 
 		// cached
 		$this::assertTrue($this->cache->has($cacheKey));
-		$this->db->rawCached($r->sql(), 'hash', true, 1);
+		$this->db->rawCached($r->getSQL(), 'hash', true, 1);
 
 		sleep(2);
 #		$this->cache->clear();
 
 		// prepared uncached
 		$this::assertFalse($this->cache->has($cacheKey));
-		$this->db->preparedCached($r->sql(), [], 'hash', true, 1);
+		$this->db->preparedCached($r->getSQL(), [], 'hash', true, 1);
 
 		// cached
 		$this::assertTrue($this->cache->has($cacheKey));
-		$this->db->preparedCached($r->sql(), [], 'hash', true, 1);
+		$this->db->preparedCached($r->getSQL(), [], 'hash', true, 1);
 	}
 
 	public function testShowDatabases():void{
@@ -294,70 +294,70 @@ public function testCreateDatabaseNoNameException():void{
 		$this->expectException(QueryException::class);
 		$this->expectExceptionMessage('no name specified');
 
-		$this->db->create->database('')->sql();
+		$this->db->create->database('')->getSQL();
 	}
 
 	public function testCreateTableNoNameException():void{
 		$this->expectException(QueryException::class);
 		$this->expectExceptionMessage('no name specified');
 
-		$this->db->create->table('')->sql();
+		$this->db->create->table('')->getSQL();
 	}
 
 	public function testDropDatabaseNoNameException():void{
 		$this->expectException(QueryException::class);
 		$this->expectExceptionMessage('no name specified');
 
-		$this->db->drop->database('')->sql();
+		$this->db->drop->database('')->getSQL();
 	}
 
 	public function testDropTableNoNameException():void{
 		$this->expectException(QueryException::class);
 		$this->expectExceptionMessage('no name specified');
 
-		$this->db->drop->table('')->sql();
+		$this->db->drop->table('')->getSQL();
 	}
 
 	public function testInsertTableNoNameException():void{
 		$this->expectException(QueryException::class);
 		$this->expectExceptionMessage('no name specified');
 
-		$this->db->insert->into('')->sql();
+		$this->db->insert->into('')->getSQL();
 	}
 
 	public function testInsertInvalidDataException():void{
 		$this->expectException(QueryException::class);
 		$this->expectExceptionMessage('no values given');
 
-		$this->db->insert->into('foo')->values([])->sql();
+		$this->db->insert->into('foo')->values([])->getSQL();
 	}
 
 	public function testSelectEmptyFromException():void{
 		$this->expectException(QueryException::class);
 		$this->expectExceptionMessage('no FROM expression specified');
 
-		$this->db->select->from([])->sql();
+		$this->db->select->from([])->getSQL();
 	}
 
 	public function testUpdateNoTableException():void{
 		$this->expectException(QueryException::class);
 		$this->expectExceptionMessage('no name specified');
 
-		$this->db->update->table('')->sql();
+		$this->db->update->table('')->getSQL();
 	}
 
 	public function testUpdateNoSetException():void{
 		$this->expectException(QueryException::class);
 		$this->expectExceptionMessage('no fields to update specified');
 
-		$this->db->update->table('foo')->set([])->sql();
+		$this->db->update->table('foo')->set([])->getSQL();
 	}
 
 	public function testDeleteNoTableException():void{
 		$this->expectException(QueryException::class);
 		$this->expectExceptionMessage('no name specified');
 
-		$this->db->delete->from('')->sql();
+		$this->db->delete->from('')->getSQL();
 	}
 
 }

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public function name(string $dbname):static{`
`23`	`23`	`return $this->setName($dbname);`
`24`	`24`	`}`
`25`	`25`
`26`		`- protected function getSQL():array{`
	`26`	`+ protected function sql():array{`
`27`	`27`	`return []; // @todo`
`28`	`28`	`}`
`29`	`29`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public function name(string $tablename):static{`
`24`	`24`	`return $this->setName($tablename);`
`25`	`25`	`}`
`26`	`26`
`27`		`- protected function getSQL():array{`
	`27`	`+ protected function sql():array{`
`28`	`28`	`return []; // @todo`
`29`	`29`	`}`
`30`	`30`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public function ifNotExists():static{`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`/** @inheritdoc */`
`35`		`- protected function getSQL():array{`
	`35`	`+ protected function sql():array{`
`36`	`36`	`return $this->dialect->createDatabase($this->name, $this->ifNotExists, $this->charset);`
`37`	`37`	`}`
`38`	`38`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public function ifNotExists():static{`
`42`	`42`	`return $this->setIfNotExists();`
`43`	`43`	`}`
`44`	`44`
`45`		`- protected function getSQL():array{`
	`45`	`+ protected function sql():array{`
`46`	`46`	`return $this->dialect->createTable($this->name, $this->cols, $this->primaryKey, $this->ifNotExists, $this->temp, $this->dir);`
`47`	`47`	`}`
`48`	`48`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ public function offset(int $offset):static{`
`44`	`44`	`return $this->setOffset($offset);`
`45`	`45`	`}`
`46`	`46`
`47`		`- protected function getSQL():array{`
	`47`	`+ protected function sql():array{`
`48`	`48`	`return $this->dialect->delete($this->name, $this->getWhere());`
`49`	`49`	`}`
`50`	`50`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public function ifExists():static{`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`/** @inheritdoc */`
`31`		`- protected function getSQL():array{`
	`31`	`+ protected function sql():array{`
`32`	`32`	`return $this->dialect->dropDatabase($this->name, $this->ifExists);`
`33`	`33`	`}`
`34`	`34`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public function ifExists():static{`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`/** @inheritdoc */`
`32`		`- protected function getSQL():array{`
	`32`	`+ protected function sql():array{`
`33`	`33`	`return $this->dialect->dropTable($this->name, $this->ifExists);`
`34`	`34`	`}`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public function values(iterable $values):static{`
`42`	`42`	`return $this;`
`43`	`43`	`}`
`44`	`44`
`45`		`- protected function getSQL():array{`
	`45`	`+ protected function sql():array{`
`46`	`46`
`47`	`47`	`if(empty($this->bindValues)){`
`48`	`48`	`throw new QueryException('no values given');`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public function cached(int\|null $ttl = null):static{`
`53`	`53`	`return $this->setCached($ttl);`
`54`	`54`	`}`
`55`	`55`
`56`		`- protected function getSQL():array{`
	`56`	`+ protected function sql():array{`
`57`	`57`
`58`	`58`	`if(empty($this->from)){`
`59`	`59`	`throw new QueryException('no FROM expression specified');`