Database - Make sql query mixed instead of string since most nosql da…

…tabases use arrays
codeigniter4 · Jan 15, 2021 · 1a9415a · 1a9415a
1 parent 6ee89af
commit 1a9415a
Show file tree

Hide file tree

Showing 15 changed files with 55 additions and 59 deletions.
diff --git a/system/Database/BaseConnection.php b/system/Database/BaseConnection.php
@@ -586,11 +586,11 @@ public function addTableAlias(string $table)
 	/**
 	 * Executes the query against the database.
 	 *
-	 * @param string $sql
+	 * @param mixed $sql
 	 *
 	 * @return mixed
 	 */
-	abstract protected function execute(string $sql);
+	abstract protected function execute($sql);
 
 	//--------------------------------------------------------------------
 
@@ -602,16 +602,14 @@ abstract protected function execute(string $sql);
 	 * Should automatically handle different connections for read/write
 	 * queries if needed.
 	 *
-	 * @param string  $sql
-	 * @param mixed   ...$binds
-	 * @param boolean $setEscapeFlags
-	 * @param string  $queryClass
+	 * @param mixed       $sql
+	 * @param mixed       ...$binds
+	 * @param boolean     $setEscapeFlags
+	 * @param string|null $queryClass
 	 *
 	 * @return BaseResult|Query|false
-	 *
-	 * @todo BC set $queryClass default as null in 4.1
 	 */
-	public function query(string $sql, $binds = null, bool $setEscapeFlags = true, string $queryClass = '')
+	public function query($sql, $binds = null, bool $setEscapeFlags = true, string $queryClass = null)
 	{
 		$queryClass = $queryClass ?: $this->queryClass;
 
@@ -701,11 +699,11 @@ public function query(string $sql, $binds = null, bool $setEscapeFlags = true, s
 	 * is performed, nor are transactions handled. Simply takes a raw
 	 * query string and returns the database-specific result id.
 	 *
-	 * @param string $sql
+	 * @param mixed $sql
 	 *
 	 * @return mixed
 	 */
-	public function simpleQuery(string $sql)
+	public function simpleQuery($sql)
 	{
 		if (empty($this->connID))
 		{

diff --git a/system/Database/BasePreparedQuery.php b/system/Database/BasePreparedQuery.php
@@ -76,13 +76,13 @@ public function __construct(BaseConnection $db)
 	 * NOTE: This version is based on SQL code. Child classes should
 	 * override this method.
 	 *
-	 * @param string $sql
+	 * @param mixed  $sql
 	 * @param array  $options    Passed to the connection's prepare statement.
 	 * @param string $queryClass
 	 *
 	 * @return mixed
 	 */
-	public function prepare(string $sql, array $options = [], string $queryClass = 'CodeIgniter\\Database\\Query')
+	public function prepare($sql, array $options = [], string $queryClass = 'CodeIgniter\\Database\\Query')
 	{
 		// We only supports positional placeholders (?)
 		// in order to work with the execute method below, so we

diff --git a/system/Database/ConnectionInterface.php b/system/Database/ConnectionInterface.php
@@ -123,12 +123,12 @@ public function getVersion(): string;
 	 * Should automatically handle different connections for read/write
 	 * queries if needed.
 	 *
-	 * @param string $sql
-	 * @param mixed  ...$binds
+	 * @param mixed $sql
+	 * @param mixed ...$binds
 	 *
 	 * @return mixed
 	 */
-	public function query(string $sql, $binds = null);
+	public function query($sql, $binds = null);
 
 	//--------------------------------------------------------------------
 
@@ -137,11 +137,11 @@ public function query(string $sql, $binds = null);
 	 * is performed, nor are transactions handled. Simply takes a raw
 	 * query string and returns the database-specific result id.
 	 *
-	 * @param string $sql
+	 * @param mixed $sql
 	 *
 	 * @return mixed
 	 */
-	public function simpleQuery(string $sql);
+	public function simpleQuery($sql);
 
 	//--------------------------------------------------------------------
 

diff --git a/system/Database/MySQLi/Connection.php b/system/Database/MySQLi/Connection.php
@@ -295,11 +295,11 @@ public function getVersion(): string
 	/**
 	 * Executes the query against the database.
 	 *
-	 * @param string $sql
+	 * @param mixed $sql
 	 *
 	 * @return mixed
 	 */
-	public function execute(string $sql)
+	public function execute($sql)
 	{
 		while ($this->connID->more_results())
 		{

diff --git a/system/Database/MySQLi/PreparedQuery.php b/system/Database/MySQLi/PreparedQuery.php
@@ -26,13 +26,13 @@ class PreparedQuery extends BasePreparedQuery
 	 * NOTE: This version is based on SQL code. Child classes should
 	 * override this method.
 	 *
-	 * @param string $sql
-	 * @param array  $options Passed to the connection's prepare statement.
-	 *                        Unused in the MySQLi driver.
+	 * @param mixed $sql
+	 * @param array $options Passed to the connection's prepare statement.
+	 *                       Unused in the MySQLi driver.
 	 *
 	 * @return mixed
 	 */
-	public function _prepare(string $sql, array $options = [])
+	public function _prepare($sql, array $options = [])
 	{
 		// Mysqli driver doesn't like statements
 		// with terminating semicolons.

diff --git a/system/Database/Postgre/Connection.php b/system/Database/Postgre/Connection.php
@@ -159,11 +159,11 @@ public function getVersion(): string
 	/**
 	 * Executes the query against the database.
 	 *
-	 * @param string $sql
+	 * @param mixed $sql
 	 *
 	 * @return mixed
 	 */
-	public function execute(string $sql)
+	public function execute($sql)
 	{
 		try
 		{

diff --git a/system/Database/Postgre/PreparedQuery.php b/system/Database/Postgre/PreparedQuery.php
@@ -43,14 +43,14 @@ class PreparedQuery extends BasePreparedQuery
 	 * NOTE: This version is based on SQL code. Child classes should
 	 * override this method.
 	 *
-	 * @param string $sql
-	 * @param array  $options Passed to the connection's prepare statement.
-	 *                        Unused in the MySQLi driver.
+	 * @param mixed $sql
+	 * @param array $options Passed to the connection's prepare statement.
+	 *                       Unused in the MySQLi driver.
 	 *
 	 * @return mixed
 	 * @throws Exception
 	 */
-	public function _prepare(string $sql, array $options = [])
+	public function _prepare($sql, array $options = [])
 	{
 		$this->name = (string) random_int(1, 10000000000000000);
 

diff --git a/system/Database/PreparedQueryInterface.php b/system/Database/PreparedQueryInterface.php
@@ -32,12 +32,12 @@ public function execute(...$data);
 	 * Prepares the query against the database, and saves the connection
 	 * info necessary to execute the query later.
 	 *
-	 * @param string $sql
-	 * @param array  $options Passed to the connection's prepare statement.
+	 * @param mixed $sql
+	 * @param array $options Passed to the connection's prepare statement.
 	 *
 	 * @return mixed
 	 */
-	public function prepare(string $sql, array $options = []);
+	public function prepare($sql, array $options = []);
 
 	//--------------------------------------------------------------------
 

diff --git a/system/Database/Query.php b/system/Database/Query.php
@@ -101,13 +101,13 @@ public function __construct(ConnectionInterface &$db)
 	/**
 	 * Sets the raw query string to use for this statement.
 	 *
-	 * @param string  $sql
+	 * @param mixed   $sql
 	 * @param mixed   $binds
 	 * @param boolean $setEscape
 	 *
 	 * @return $this
 	 */
-	public function setQuery(string $sql, $binds = null, bool $setEscape = true)
+	public function setQuery($sql, $binds = null, bool $setEscape = true)
 	{
 		$this->originalQueryString = $sql;
 
@@ -166,9 +166,9 @@ public function setBinds(array $binds, bool $setEscape = true)
 	 * Returns the final, processed query string after binding, etal
 	 * has been performed.
 	 *
-	 * @return string
+	 * @return mixed
 	 */
-	public function getQuery(): string
+	public function getQuery()
 	{
 		if (empty($this->finalQueryString))
 		{

diff --git a/system/Database/QueryInterface.php b/system/Database/QueryInterface.php
@@ -22,13 +22,13 @@ interface QueryInterface
 	/**
 	 * Sets the raw query string to use for this statement.
 	 *
-	 * @param string  $sql
+	 * @param mixed   $sql
 	 * @param mixed   $binds
 	 * @param boolean $setEscape
 	 *
 	 * @return mixed
 	 */
-	public function setQuery(string $sql, $binds = null, bool $setEscape = true);
+	public function setQuery($sql, $binds = null, bool $setEscape = true);
 
 	//--------------------------------------------------------------------
 

diff --git a/system/Database/SQLSRV/Connection.php b/system/Database/SQLSRV/Connection.php
@@ -479,11 +479,11 @@ public function setDatabase(string $databaseName = null)
 	/**
 	 * Executes the query against the database.
 	 *
-	 * @param string $sql
+	 * @param mixed $sql
 	 *
 	 * @return mixed
 	 */
-	public function execute(string $sql)
+	public function execute($sql)
 	{
 		$stmt = ($this->scrollable === false || $this->isWriteType($sql)) ?
 			sqlsrv_query($this->connID, $sql) :

diff --git a/system/Database/SQLSRV/PreparedQuery.php b/system/Database/SQLSRV/PreparedQuery.php
@@ -41,13 +41,13 @@ class PreparedQuery extends BasePreparedQuery
 	 * NOTE: This version is based on SQL code. Child classes should
 	 * override this method.
 	 *
-	 * @param string $sql
-	 * @param array  $options Options takes an associative array;
+	 * @param mixed $sql
+	 * @param array $options Options takes an associative array;
 	 *
 	 * @return mixed
 	 * @throws Exception
 	 */
-	public function _prepare(string $sql, array $options = [])
+	public function _prepare($sql, array $options = [])
 	{
 		/* Prepare parameters for the query */
 		$queryString = $this->getQueryString();

diff --git a/system/Database/SQLite3/Connection.php b/system/Database/SQLite3/Connection.php
@@ -134,11 +134,11 @@ public function getVersion(): string
 	/**
 	 * Execute the query
 	 *
-	 * @param string $sql
+	 * @param mixed $sql
 	 *
 	 * @return mixed    \SQLite3Result object or bool
 	 */
-	public function execute(string $sql)
+	public function execute($sql)
 	{
 		try
 		{

diff --git a/system/Database/SQLite3/PreparedQuery.php b/system/Database/SQLite3/PreparedQuery.php
@@ -33,13 +33,13 @@ class PreparedQuery extends BasePreparedQuery
 	 * NOTE: This version is based on SQL code. Child classes should
 	 * override this method.
 	 *
-	 * @param string $sql
-	 * @param array  $options Passed to the connection's prepare statement.
-	 *                        Unused in the MySQLi driver.
+	 * @param mixed $sql
+	 * @param array $options Passed to the connection's prepare statement.
+	 *                       Unused in the MySQLi driver.
 	 *
 	 * @return mixed
 	 */
-	public function _prepare(string $sql, array $options = [])
+	public function _prepare($sql, array $options = [])
 	{
 		if (! ($this->statement = $this->db->connID->prepare($sql)))
 		{

diff --git a/system/Test/Mock/MockConnection.php b/system/Test/Mock/MockConnection.php
@@ -43,16 +43,14 @@ public function shouldReturn(string $method, $return)
 	 * Should automatically handle different connections for read/write
 	 * queries if needed.
 	 *
-	 * @param string  $sql
-	 * @param mixed   ...$binds
-	 * @param boolean $setEscapeFlags
-	 * @param string  $queryClass
+	 * @param mixed       $sql
+	 * @param mixed       ...$binds
+	 * @param boolean     $setEscapeFlags
+	 * @param string|null $queryClass
 	 *
 	 * @return BaseResult|Query|false
-	 *
-	 * @todo BC set $queryClass default as null in 4.1
 	 */
-	public function query(string $sql, $binds = null, bool $setEscapeFlags = true, string $queryClass = '')
+	public function query($sql, $binds = null, bool $setEscapeFlags = true, string $queryClass = null)
 	{
 		$queryClass = str_replace('Connection', 'Query', static::class);
 
@@ -155,11 +153,11 @@ public function getVersion(): string
 	/**
 	 * Executes the query against the database.
 	 *
-	 * @param string $sql
+	 * @param mixed $sql
 	 *
 	 * @return mixed
 	 */
-	protected function execute(string $sql)
+	protected function execute($sql)
 	{
 		return $this->returnValues['execute'];
 	}