ResultSet: changed empty result return type of fetch() and fetchField() methods from FALSE to NULL [BC Break]

Author: foxycode

src/Database/Connection.php

@@ -213,7 +213,7 @@ public function preprocess($sql, ...$params)
 	/**
 	 * Shortcut for query()->fetch()
 	 * @param  string
-	 * @return Row
+	 * @return Row|NULL
 	 */
 	public function fetch($sql, ...$params)
 	{

src/Database/Context.php

@@ -131,7 +131,7 @@ public function getConventions()
 	/**
 	 * Shortcut for query()->fetch()
 	 * @param  string
-	 * @return Row
+	 * @return Row|NULL
 	 */
 	public function fetch($sql, ...$params)
 	{

src/Database/IRowContainer.php

@@ -18,7 +18,7 @@ interface IRowContainer extends \Traversable
 
 	/**
 	 * Fetches single row object.
-	 * @return IRow|bool if there is no row
+	 * @return IRow|NULL if there is no row
 	 */
 	function fetch();
 

src/Database/ResultSet.php

@@ -239,7 +239,7 @@ public function valid()
 			return TRUE;
 		}
 
-		return $this->fetch() !== FALSE;
+		return $this->fetch() !== NULL;
 	}
 
 
@@ -254,7 +254,7 @@ public function fetch()
 		$data = $this->pdoStatement ? $this->pdoStatement->fetch() : NULL;
 		if (!$data) {
 			$this->pdoStatement->closeCursor();
-			return FALSE;
+			return NULL;
 
 		} elseif ($this->result === NULL && count($data) !== $this->pdoStatement->columnCount()) {
 			$duplicates = Helpers::findDuplicates($this->pdoStatement);
@@ -276,12 +276,12 @@ public function fetch()
 	/**
 	 * Fetches single field.
 	 * @param  int
-	 * @return mixed|FALSE
+	 * @return mixed
 	 */
 	public function fetchField($column = 0)
 	{
 		$row = $this->fetch();
-		return $row ? $row[$column] : FALSE;
+		return $row ? $row[$column] : NULL;
 	}
 
 

src/Database/Table/ActiveRow.php

@@ -183,7 +183,7 @@ public function update($data)
 					->wherePrimary($tmp + $primary);
 			}
 			$selection->select('*');
-			if (($row = $selection->fetch()) === FALSE) {
+			if (($row = $selection->fetch()) === NULL) {
 				throw new Nette\InvalidStateException('Database refetch failed; row does not exist!');
 			}
 			$this->data = $row->data;

src/Database/Table/IRowContainer.php

@@ -15,7 +15,7 @@
 /**
  * Container of database result fetched into IRow objects.
  *
- * @method     IRow|bool  fetch() Fetches single row object.
+ * @method     IRow|NULL  fetch() Fetches single row object.
  * @method     IRow[]     fetchAll() Fetches all rows.
  */
 interface IRowContainer extends Database\IRowContainer

src/Database/Table/Selection.php

@@ -170,7 +170,7 @@ public function getSql()
 	/**
 	 * Loads cache of previous accessed columns and returns it.
 	 * @internal
-	 * @return array|false
+	 * @return array|bool
 	 */
 	public function getPreviousAccessedColumns()
 	{
@@ -201,7 +201,7 @@ public function getSqlBuilder()
 	/**
 	 * Returns row specified by primary key.
 	 * @param  mixed primary key
-	 * @return IRow or FALSE if there is no such row
+	 * @return IRow|NULL if there is no such row
 	 */
 	public function get($key)
 	{
@@ -218,14 +218,14 @@ public function fetch()
 		$this->execute();
 		$return = current($this->data);
 		next($this->data);
-		return $return;
+		return $return === FALSE ? NULL : $return;
 	}
 
 
 	/**
 	 * Fetches single field.
 	 * @param  string|NULL
-	 * @return mixed|FALSE
+	 * @return mixed
 	 */
 	public function fetchField($column = NULL)
 	{
@@ -238,7 +238,7 @@ public function fetchField($column = NULL)
 			return $column ? $row[$column] : array_values($row->toArray())[0];
 		}
 
-		return FALSE;
+		return NULL;
 	}
 
 
@@ -1004,7 +1004,7 @@ public function rewind()
 	}
 
 
-	/** @return IRow */
+	/** @return IRow|bool */
 	public function current()
 	{
 		if (($key = current($this->keys)) !== FALSE) {

tests/Database/Context.transaction.phpt

@@ -28,5 +28,5 @@ test(function () use ($context) {
 	$context->query('DELETE FROM book');
 	$context->commit();
 
-	Assert::false($context->fetchField('SELECT id FROM book WHERE id = ', 3));
+	Assert::null($context->fetchField('SELECT id FROM book WHERE id = ', 3));
 });

tests/Database/ResultSet.fetch().phpt

@@ -76,3 +76,10 @@ test(function () use ($context, $driverName) {
 		$res->fetch();
 	}, E_USER_NOTICE, $message);
 });
+
+
+test(function () use ($context, $driverName) {
+	$res = $context->query('SELECT id FROM author WHERE id = ?', 666);
+
+	Assert::null($res->fetch());
+});

tests/Database/ResultSet.fetchField().phpt

@@ -21,3 +21,10 @@ test(function () use ($context) {
 	Assert::same(12, $res->fetchField(1));
 	Assert::same('Geek', $res->fetchField('name'));
 });
+
+
+test(function () use ($context) {
+	$res = $context->query('SELECT id FROM author WHERE id = ?', 666);
+
+	Assert::null($res->fetchField());
+});