Always represent message timestamps as DateTime objects

clue · clue · commit 1a5b1a76ba34 · 2019-03-20T16:44:13.000+01:00
diff --git a/examples/04-connect.php b/examples/04-connect.php
@@ -63,7 +63,7 @@
         if ($type === Protocol::REQUEST_RPCCALL && $message[1] === '2displayMsg(Message)') {
             $in = $message[2];
             assert($in instanceof Message);
-            echo date(DATE_ISO8601, $in->timestamp) . ' in ' . $in->bufferInfo->name . ' by ' . explode('!', $in->sender)[0] . ': ' . $in->contents . PHP_EOL;
+            echo $in->timestamp->format(DATE_ISO8601) . ' in ' . $in->bufferInfo->name . ' by ' . explode('!', $in->sender)[0] . ': ' . $in->contents . PHP_EOL;
 
             return;
         }
diff --git a/examples/05-backlog.php b/examples/05-backlog.php
@@ -67,7 +67,7 @@
                 echo json_encode(
                     array(
                         'id' => $in->id,
-                        'date' => date(\DATE_ATOM, $in->timestamp),
+                        'date' => $in->timestamp->format(\DATE_ATOM),
                         'channel' => $in->bufferInfo->name,
                         'sender' => explode('!', $in->sender)[0],
                         'contents' => $in->contents
diff --git a/src/Io/Protocol.php b/src/Io/Protocol.php
@@ -74,9 +74,16 @@ public function __construct()
                 return $reader->readUInt();
             },
             'Message' => function (Reader $reader) {
+                $readTimestamp = function () use ($reader) {
+                    // create DateTime object with local time zone from unix timestamp
+                    $d = new \DateTime('@' . $reader->readUint());
+                    $d->setTimeZone(new \DateTimeZone(date_default_timezone_get()));
+                    return $d;
+                };
+
                 return new Message(
                     $reader->readUInt(),
-                    $reader->readUInt(),
+                    $readTimestamp(),
                     $reader->readUInt(),
                     $reader->readUChar(),
                     $reader->readQUserTypeByName('BufferInfo'),
diff --git a/src/Models/Message.php b/src/Models/Message.php
@@ -39,7 +39,7 @@ class Message
     public $id;
 
     /**
-     * @var int UNIX timestamp
+     * @var \DateTime
      */
     public $timestamp;
 
@@ -72,15 +72,15 @@ class Message
      * [Internal] Instantiation is handled internally and should not be called manually.
      *
      * @param int        $id
-     * @param int        $timestamp  UNIX timestamp
+     * @param \DateTime  $timestamp
      * @param int        $type       single type constant, see self::TYPE_* constants
      * @param int        $flags      bitmask of flag constants, see self::FLAG_* constants
      * @param BufferInfo $bufferInfo
      * @param string     $sender     sender in the form `nick!user@host` or only `host` or empty string
      * @param string     $contents
      * @internal
      */
-    public function __construct($id, $timestamp, $type, $flags, BufferInfo $bufferInfo, $sender, $contents)
+    public function __construct($id, \DateTime $timestamp, $type, $flags, BufferInfo $bufferInfo, $sender, $contents)
     {
         $this->id = $id;
         $this->timestamp = $timestamp;
diff --git a/tests/FunctionalTest.php b/tests/FunctionalTest.php
@@ -263,6 +263,7 @@ public function testRequestBacklogReceivesBacklog()
         }
 
         $this->assertTrue($newest instanceof Message);
+        $this->assertInstanceOf('DateTime', $newest->timestamp);
 
         $client->close();
     }
diff --git a/tests/Models/MessageTest.php b/tests/Models/MessageTest.php
@@ -9,7 +9,7 @@ public function testChatMessage()
         $buffer = $this->getMockBuilder('Clue\React\Quassel\Models\BufferInfo')->disableOriginalConstructor()->getMock();
         $message = new Message(
             1000,
-            1528039705,
+            new DateTime('@1528039705'),
             Message::TYPE_PLAIN,
             Message::FLAG_NONE,
             $buffer,
@@ -18,7 +18,7 @@ public function testChatMessage()
         );
 
         $this->assertSame(1000, $message->id);
-        $this->assertSame(1528039705, $message->timestamp);
+        $this->assertSame(1528039705, $message->timestamp->getTimestamp());
         $this->assertSame(Message::TYPE_PLAIN, $message->type);
         $this->assertSame(Message::FLAG_NONE, $message->flags);
         $this->assertSame($buffer, $message->bufferInfo);
@@ -31,7 +31,7 @@ public function testJoinMessage()
         $buffer = $this->getMockBuilder('Clue\React\Quassel\Models\BufferInfo')->disableOriginalConstructor()->getMock();
         $message = new Message(
             999,
-            1528039704,
+            new DateTime('@1528039704'),
             Message::TYPE_JOIN,
             Message::FLAG_NONE,
             $buffer,
@@ -40,7 +40,7 @@ public function testJoinMessage()
         );
 
         $this->assertSame(999, $message->id);
-        $this->assertSame(1528039704, $message->timestamp);
+        $this->assertSame(1528039704, $message->timestamp->getTimestamp());
         $this->assertSame(Message::TYPE_JOIN, $message->type);
         $this->assertSame(Message::FLAG_NONE, $message->flags);
         $this->assertSame($buffer, $message->bufferInfo);

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@`
`63`	`63`	`if ($type === Protocol::REQUEST_RPCCALL && $message[1] === '2displayMsg(Message)') {`
`64`	`64`	`$in = $message[2];`
`65`	`65`	`assert($in instanceof Message);`
`66`		`- echo date(DATE_ISO8601, $in->timestamp) . ' in ' . $in->bufferInfo->name . ' by ' . explode('!', $in->sender)[0] . ': ' . $in->contents . PHP_EOL;`
	`66`	`+ echo $in->timestamp->format(DATE_ISO8601) . ' in ' . $in->bufferInfo->name . ' by ' . explode('!', $in->sender)[0] . ': ' . $in->contents . PHP_EOL;`
`67`	`67`
`68`	`68`	`return;`
`69`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -263,6 +263,7 @@ public function testRequestBacklogReceivesBacklog()`
`263`	`263`	`}`
`264`	`264`
`265`	`265`	`$this->assertTrue($newest instanceof Message);`
	`266`	`+ $this->assertInstanceOf('DateTime', $newest->timestamp);`
`266`	`267`
`267`	`268`	`$client->close();`
`268`	`269`	`}`