returns date-time as immutable object Nette\Database\DateTime (BC break) [Closes #270]

Author: dg

src/Database/DateTime.php

@@ -0,0 +1,49 @@
+<?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;
+
+use Nette;
+
+
+/**
+ * Date Time.
+ */
+final class DateTime extends \DateTimeImmutable implements \JsonSerializable
+{
+	use Nette\SmartObject;
+
+	public function __construct(string|int $time = 'now')
+	{
+		if (is_numeric($time)) {
+			$time = (new self('@' . $time))
+				->setTimezone(new \DateTimeZone(date_default_timezone_get()))
+				->format('Y-m-d H:i:s.u');
+		}
+		parent::__construct($time);
+	}
+
+
+	/**
+	 * 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'.
+	 */
+	public function __toString(): string
+	{
+		return $this->format('Y-m-d H:i:s');
+	}
+}

src/Database/ResultSet.php

@@ -147,7 +147,7 @@ public function normalizeRow(array $row): array
 				|| $type === IStructure::FIELD_DATE
 				|| $type === IStructure::FIELD_TIME
 			) {
-				$row[$key] = new Nette\Utils\DateTime($value);
+				$row[$key] = new DateTime($value);
 
 			} elseif ($type === IStructure::FIELD_TIME_INTERVAL) {
 				preg_match('#^(-?)(\d+)\D(\d+)\D(\d+)(\.\d+)?$#D', $value, $m);
@@ -156,7 +156,7 @@ public function normalizeRow(array $row): array
 				$row[$key]->invert = (int) (bool) $m[1];
 
 			} elseif ($type === IStructure::FIELD_UNIX_TIMESTAMP) {
-				$row[$key] = Nette\Utils\DateTime::from($value);
+				$row[$key] = new DateTime($value);
 			}
 		}
 

src/Database/Table/ActiveRow.php

@@ -65,7 +65,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
 	{

tests/Database/DateTime.phpt

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+use Nette\Database\DateTime;
+use Tester\Assert;
+
+require __DIR__ . '/../bootstrap.php';
+
+
+date_default_timezone_set('Europe/Prague');
+
+// timestamp
+Assert::same('1978-01-23 11:40:00', (string) new DateTime(254_400_000));
+Assert::same(254_400_000, (new DateTime(254_400_000))->getTimestamp());
+
+Assert::same('2050-08-13 11:40:00', (string) new DateTime(254_400_0000));
+Assert::same(is_int(2_544_000_000) ? 2_544_000_000 : '2544000000', (new DateTime(2_544_000_000))->getTimestamp()); // 64 bit
+
+// to string
+Assert::same('1978-01-23 11:40:00', (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')));

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

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

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

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']));

tests/Database/Table/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');

tests/Database/Table/bugs/bug216.phpt

@@ -43,4 +43,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);