returns date-time as immutable object Nette\Database\DateTime (BC bre…

…ak) [Closes #270]
nette · May 7, 2024 · b67e76d · b67e76d
1 parent 1e897af
commit b67e76d
Show file tree

Hide file tree

Showing 13 changed files with 72 additions and 21 deletions.
diff --git a/src/Database/DateTime.php b/src/Database/DateTime.php
@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * This file is part of the Nette Framework (https://nette.org)
+ * Copyright (c) 2004 David Grudl (https://davidgrudl.com)
+ */
+
+declare(strict_types=1);
+
+namespace Nette\Database;
+
+
+/**
+ * Date Time.
+ */
+final class DateTime extends \DateTimeImmutable implements \JsonSerializable
+{
+	/**
+	 * Returns JSON representation in ISO 8601 (used by JavaScript).
+	 */
+	public function jsonSerialize(): string
+	{
+		return $this->format('c');
+	}
+
+
+	/**
+	 * Returns the date and time in the format 'Y-m-d H:i:s.u'.
+	 */
+	public function __toString(): string
+	{
+		return $this->format('Y-m-d H:i:s.u');
+	}
+}
diff --git a/src/Database/Helpers.php b/src/Database/Helpers.php
@@ -202,7 +202,7 @@ public static function detectType(string $type): string
 
 
 	/** @internal */
-	public static function normalizeRow(array $row, ResultSet $resultSet): array
+	public static function normalizeRow(array $row, ResultSet $resultSet, $dateTimeClass = DateTime::class): array
 	{
 		foreach ($resultSet->getColumnTypes() as $key => $type) {
 			$value = $row[$key];
@@ -224,10 +224,10 @@ public static function normalizeRow(array $row, ResultSet $resultSet): array
 			} elseif ($type === IStructure::FIELD_DATETIME || $type === IStructure::FIELD_DATE) {
 				$row[$key] = str_starts_with($value, '0000-00')
 					? null
-					: new Nette\Utils\DateTime($value);
+					: new $dateTimeClass($value);
 
 			} elseif ($type === IStructure::FIELD_TIME) {
-				$row[$key] = (new Nette\Utils\DateTime($value))->setDate(1, 1, 1);
+				$row[$key] = (new $dateTimeClass($value))->setDate(1, 1, 1);
 
 			} elseif ($type === IStructure::FIELD_TIME_INTERVAL) {
 				preg_match('#^(-?)(\d+)\D(\d+)\D(\d+)(\.\d+)?$#D', $value, $m);
@@ -236,7 +236,7 @@ public static function normalizeRow(array $row, ResultSet $resultSet): array
 				$row[$key]->invert = (int) (bool) $m[1];
 
 			} elseif ($type === IStructure::FIELD_UNIX_TIMESTAMP) {
-				$row[$key] = Nette\Utils\DateTime::from($value);
+				$row[$key] = (new $dateTimeClass)->setTimestamp($value);
 			}
 		}
 

diff --git a/src/Database/Table/ActiveRow.php b/src/Database/Table/ActiveRow.php
@@ -61,7 +61,7 @@ public function toArray(): array
 
 	/**
 	 * Returns primary key value.
-	 * @return mixed possible int, string, array, object (Nette\Utils\DateTime)
+	 * @return mixed possible int, string, array, object (Nette\Database\DateTime)
 	 */
 	public function getPrimary(bool $throw = true): mixed
 	{

diff --git a/tests/Database/DateTime.phpt b/tests/Database/DateTime.phpt
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+use Nette\Database\DateTime;
+use Tester\Assert;
+
+require __DIR__ . '/../bootstrap.php';
+
+
+date_default_timezone_set('Europe/Prague');
+
+// to string
+Assert::same('1978-01-23 11:40:00.000000', (string) new DateTime('1978-01-23 11:40'));
+
+// JSON
+Assert::same('"1978-01-23T11:40:00+01:00"', json_encode(new DateTime('1978-01-23 11:40')));
diff --git a/tests/Database/Explorer/Selection.fetchPairs().phpt b/tests/Database/Explorer/Selection.fetchPairs().phpt
@@ -41,7 +41,7 @@ test('', function () use ($explorer) {
 	$explorer->table('author')->get(12)->update(['born' => new DateTime('2002-02-02')]);
 	$list = $explorer->table('author')->where('born IS NOT NULL')->order('born')->fetchPairs('born', 'name');
 	Assert::same([
-		'2002-02-02 00:00:00' => 'David Grudl',
-		'2002-02-20 00:00:00' => 'Jakub Vrana',
+		'2002-02-02 00:00:00.000000' => 'David Grudl',
+		'2002-02-20 00:00:00.000000' => 'Jakub Vrana',
 	], $list);
 });
diff --git a/tests/Database/Explorer/Selection.insert().phpt b/tests/Database/Explorer/Selection.insert().phpt
@@ -22,7 +22,7 @@ $book = $explorer->table('author')->insert([
 // id = 14
 
 Assert::equal('eddard stark', $book->name);
-Assert::equal(new Nette\Utils\DateTime('2011-11-11'), $book->born);
+Assert::equal(new Nette\Database\DateTime('2011-11-11'), $book->born);
 
 
 $books = $explorer->table('book');

diff --git a/tests/Database/Explorer/bugs/bug216.phpt b/tests/Database/Explorer/bugs/bug216.phpt
@@ -22,4 +22,4 @@ $book = $explorer->table('author')->insert([
 
 Assert::type(Nette\Database\Table\ActiveRow::class, $book);
 Assert::equal('eddard stark', $book->name);
-Assert::equal(new Nette\Utils\DateTime('2011-11-11'), $book->born);
+Assert::equal(new Nette\Database\DateTime('2011-11-11'), $book->born);
diff --git a/tests/Database/ResultSet.fetchAssoc().phpt b/tests/Database/ResultSet.fetchAssoc().phpt
@@ -51,7 +51,7 @@ test('', function () use ($connection) {
 	$pairs = $connection->query('UPDATE author SET born = ? WHERE id = 12', new DateTime('2002-02-02'));
 	$pairs = $connection->query('SELECT * FROM author WHERE born IS NOT NULL ORDER BY born')->fetchAssoc('born=name');
 	Assert::same([
-		'2002-02-02 00:00:00' => 'David Grudl',
-		'2002-02-20 00:00:00' => 'Jakub Vrana',
+		'2002-02-02 00:00:00.000000' => 'David Grudl',
+		'2002-02-20 00:00:00.000000' => 'Jakub Vrana',
 	], $pairs);
 });
diff --git a/tests/Database/ResultSet.fetchPairs().phpt b/tests/Database/ResultSet.fetchPairs().phpt
@@ -70,8 +70,8 @@ test('', function () use ($connection) {
 	$pairs = $connection->query('UPDATE author SET born = ? WHERE id = 12', new DateTime('2002-02-02'));
 	$pairs = $connection->query('SELECT * FROM author WHERE born IS NOT NULL ORDER BY born')->fetchPairs('born', 'name');
 	Assert::same([
-		'2002-02-02 00:00:00' => 'David Grudl',
-		'2002-02-20 00:00:00' => 'Jakub Vrana',
+		'2002-02-02 00:00:00.000000' => 'David Grudl',
+		'2002-02-20 00:00:00.000000' => 'Jakub Vrana',
 	], $pairs);
 });
 
@@ -125,8 +125,8 @@ $pairs = $connection->query('UPDATE author SET born = ? WHERE id = 11', new Date
 $pairs = $connection->query('UPDATE author SET born = ? WHERE id = 12', new DateTime('2002-02-02'));
 $pairs = $connection->query('SELECT * FROM author WHERE born IS NOT NULL ORDER BY born')->fetchPairs('born', 'name');
 Assert::same([
-	'2002-02-02 00:00:00' => 'David Grudl',
-	'2002-02-20 00:00:00' => 'Jakub Vrana',
+	'2002-02-02 00:00:00.000000' => 'David Grudl',
+	'2002-02-20 00:00:00.000000' => 'Jakub Vrana',
 ], $pairs);
 
 

diff --git a/tests/Database/ResultSet.normalizeRow.mysql.phpt b/tests/Database/ResultSet.normalizeRow.mysql.phpt
@@ -7,7 +7,7 @@
 
 declare(strict_types=1);
 
-use Nette\Utils\DateTime;
+use Nette\Database\DateTime;
 use Tester\Assert;
 
 require __DIR__ . '/connect.inc.php'; // create $connection

diff --git a/tests/Database/ResultSet.normalizeRow.postgre.phpt b/tests/Database/ResultSet.normalizeRow.postgre.phpt
@@ -7,7 +7,7 @@
 
 declare(strict_types=1);
 
-use Nette\Utils\DateTime;
+use Nette\Database\DateTime;
 use Tester\Assert;
 
 require __DIR__ . '/connect.inc.php'; // create $connection

diff --git a/tests/Database/ResultSet.normalizeRow.sqlite.phpt b/tests/Database/ResultSet.normalizeRow.sqlite.phpt
@@ -7,7 +7,7 @@
 
 declare(strict_types=1);
 
-use Nette\Utils\DateTime;
+use Nette\Database\DateTime;
 use Tester\Assert;
 
 require __DIR__ . '/connect.inc.php'; // create $connection

diff --git a/tests/Database/ResultSet.normalizeRow.sqlsrv.phpt b/tests/Database/ResultSet.normalizeRow.sqlsrv.phpt
@@ -7,7 +7,7 @@
 
 declare(strict_types=1);
 
-use Nette\Utils\DateTime;
+use Nette\Database\DateTime;
 use Tester\Assert;
 
 require __DIR__ . '/connect.inc.php'; // create $connection
@@ -131,13 +131,13 @@ function isTimestamp($str)
 
 
 $row = (array) $connection->query('SELECT [datetimeoffset], CAST([sql_variant] AS int) AS [sql_variant], [timestamp] FROM types2 WHERE id = 1')->fetch();
-Assert::type('DateTime', $row['datetimeoffset']);
+Assert::type(DateTime::class, $row['datetimeoffset']);
 Assert::same($row['datetimeoffset']->format('Y-m-d H:i:s P'), '2012-10-13 10:10:10 +02:00');
 Assert::same($row['sql_variant'], 123456);
 Assert::true(isTimestamp($row['timestamp']));
 
 $row = (array) $connection->query('SELECT [datetimeoffset], CAST([sql_variant] AS varchar) AS [sql_variant], [timestamp] FROM types2 WHERE id = 2')->fetch();
-Assert::type('DateTime', $row['datetimeoffset']);
+Assert::type(DateTime::class, $row['datetimeoffset']);
 Assert::same($row['datetimeoffset']->format('Y-m-d H:i:s P'), '0001-01-01 00:00:00 +00:00');
 Assert::same($row['sql_variant'], 'abcd');
 Assert::true(isTimestamp($row['timestamp']));