PHPC-2286 Implement UTCDateTime::toDateTimeImmutable (#1611)

* Implement UTCDateTime::toDateTimeImmutable
* Refactor UTCDateTime::toDateTime functions

Author: GromNaN

src/BSON/UTCDateTime.c

@@ -126,6 +126,25 @@ static HashTable* php_phongo_utcdatetime_get_properties_hash(phongo_compat_objec
 	return props;
 }
 
+static void php_phongo_utcdatetime_to_php_date(zval* return_value, const zval* this, zend_class_entry* ce)
+{
+	php_phongo_utcdatetime_t* intern;
+	php_date_obj*             datetime_obj;
+	char*                     sec;
+	size_t                    sec_len;
+
+	intern = Z_UTCDATETIME_OBJ_P(this);
+
+	object_init_ex(return_value, ce);
+	datetime_obj = Z_PHPDATE_P(return_value);
+
+	sec_len = spprintf(&sec, 0, "@%" PRId64, intern->milliseconds / 1000);
+	php_date_initialize(datetime_obj, sec, sec_len, NULL, NULL, 0);
+	efree(sec);
+
+	datetime_obj->time->us = (intern->milliseconds % 1000) * 1000;
+}
+
 /* Construct a new BSON UTCDateTime type from either the current time,
    milliseconds since the epoch, or a DateTimeInterface object. Defaults to the
    current time. */
@@ -211,23 +230,17 @@ static PHP_METHOD(MongoDB_BSON_UTCDateTime, __toString)
 /* Returns a DateTime object representing this UTCDateTime */
 static PHP_METHOD(MongoDB_BSON_UTCDateTime, toDateTime)
 {
-	php_phongo_utcdatetime_t* intern;
-	php_date_obj*             datetime_obj;
-	char*                     sec;
-	size_t                    sec_len;
-
-	intern = Z_UTCDATETIME_OBJ_P(getThis());
-
 	PHONGO_PARSE_PARAMETERS_NONE();
 
-	object_init_ex(return_value, php_date_get_date_ce());
-	datetime_obj = Z_PHPDATE_P(return_value);
+	php_phongo_utcdatetime_to_php_date(return_value, getThis(), php_date_get_date_ce());
+}
 
-	sec_len = spprintf(&sec, 0, "@%" PRId64, intern->milliseconds / 1000);
-	php_date_initialize(datetime_obj, sec, sec_len, NULL, NULL, 0);
-	efree(sec);
+/* Returns a DateTimeImmutable object representing this UTCDateTime */
+static PHP_METHOD(MongoDB_BSON_UTCDateTime, toDateTimeImmutable)
+{
+	PHONGO_PARSE_PARAMETERS_NONE();
 
-	datetime_obj->time->us = (intern->milliseconds % 1000) * 1000;
+	php_phongo_utcdatetime_to_php_date(return_value, getThis(), php_date_get_immutable_ce());
 }
 
 static PHP_METHOD(MongoDB_BSON_UTCDateTime, jsonSerialize)

src/BSON/UTCDateTime.stub.php

@@ -18,6 +18,8 @@ final public function __construct($milliseconds = null) {}
 
     final public function toDateTime(): \DateTime {}
 
+    final public function toDateTimeImmutable(): \DateTimeImmutable {}
+
     final public function __toString(): string {}
 
     final public static function __set_state(array $properties): UTCDateTime {}

src/BSON/UTCDateTime_arginfo.h

@@ -7,11 +7,13 @@ date.timezone=America/Los_Angeles
 
 $utcdatetime = new MongoDB\BSON\UTCDateTime("1416445411987");
 $datetime = $utcdatetime->toDateTime();
+var_dump(get_class($datetime));
 var_dump($datetime->format(DATE_RSS));
 
 ?>
 ===DONE===
 <?php exit(0); ?>
 --EXPECT--
+string(8) "DateTime"
 string(31) "Thu, 20 Nov 2014 01:03:31 +0000"
 ===DONE===

tests/bson/bson-utcdatetime-todatetime-001.phpt

@@ -7,11 +7,13 @@ date.timezone=UTC
 
 $utcdatetime = new MongoDB\BSON\UTCDateTime("1416445411987");
 $datetime = $utcdatetime->toDateTime();
+var_dump(get_class($datetime));
 echo $datetime->format('U.u'), "\n";
 
 ?>
 ===DONE===
 <?php exit(0); ?>
 --EXPECT--
+string(8) "DateTime"
 1416445411.987000
 ===DONE===

tests/bson/bson-utcdatetime-todatetime-002.phpt

@@ -0,0 +1,19 @@
+--TEST--
+MongoDB\BSON\UTCDateTime::toDateTimeImmutable()
+--INI--
+date.timezone=America/Los_Angeles
+--FILE--
+<?php
+
+$utcdatetime = new MongoDB\BSON\UTCDateTime("1416445411987");
+$datetime = $utcdatetime->toDateTimeImmutable();
+var_dump(get_class($datetime));
+var_dump($datetime->format(DATE_RSS));
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+string(17) "DateTimeImmutable"
+string(31) "Thu, 20 Nov 2014 01:03:31 +0000"
+===DONE===

tests/bson/bson-utcdatetime-todatetimeimmutable-001.phpt

@@ -0,0 +1,19 @@
+--TEST--
+MongoDB\BSON\UTCDateTime::toDateTimeImmutable() dumping seconds and microseconds
+--INI--
+date.timezone=UTC
+--FILE--
+<?php
+
+$utcdatetime = new MongoDB\BSON\UTCDateTime("1416445411987");
+$datetime = $utcdatetime->toDateTimeImmutable();
+var_dump(get_class($datetime));
+echo $datetime->format('U.u'), "\n";
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+string(17) "DateTimeImmutable"
+1416445411.987000
+===DONE===