add timezone option to StringToDateTimeTransformer.php

Ehyiah · Mar 15, 2024 · 439782c · 439782c
1 parent f6dc6fb
commit 439782c
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -165,9 +165,9 @@ If you pick as examples the ```DateTimeTransformer``` : It is said as an <u>open
 |                     |                                                           |                                                        |                                                                                                                              |
 
 ### Narrow-minded:
-|         Transformer         |                  transform                  |                   reverseTransform                   |                                                                         options                                                                         |
-|:---------------------------:|:-------------------------------------------:|:----------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------:|
-| StringToDateTimeTransformer |             string to DateTime              |                  DateTime to string                  |                       ```format``` (use to transform the string with the provided format)<br/> example  ```'format' => 'Y/m/d'```                       |
-| StringToBooleanTransformer  |              string to Boolean              |                  Boolean to string                   | ```trueValue``` or ```falseValue``` (used in reverseTransform only)    ```'trueValue' => 'MyCustomTrueValue'``` <br/><br/> ```strict``` : true or false |
-|  StringToEnumTransformer    | Keep original value (enum or array of enum) | string or array of strings to enum or array of enum  |                                      ```enum``` the class of the enum example : ```'enum' => MyEnum::class```                                           |
-|                             |                                             |                                                      |                                                                                                                                                         |
+|         Transformer         |                  transform                  |                   reverseTransform                   |                                                                                                        options                                                                                                         |
+|:---------------------------:|:-------------------------------------------:|:----------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| StringToDateTimeTransformer |             string to DateTime              |                  DateTime to string                  | ```format``` (use to transform the string with the provided format)<br/> example  ```'format' => 'Y/m/d'```    <br/> ```timezone``` a valid DateTimeZone object example : ```'timezone' => new DateTimeZone('UTC')```  |
+| StringToBooleanTransformer  |              string to Boolean              |                  Boolean to string                   |                                ```trueValue``` or ```falseValue``` (used in reverseTransform only)    ```'trueValue' => 'MyCustomTrueValue'``` <br/><br/> ```strict``` : true or false                                 |
+|  StringToEnumTransformer    | Keep original value (enum or array of enum) | string or array of strings to enum or array of enum  |                                                                        ```enum``` the class of the enum example : ```'enum' => MyEnum::class```                                                                        |
+|                             |                                             |                                                      |                                                                                                                                                                                                                        |
diff --git a/src/Transformer/StringToDateTimeTransformer.php b/src/Transformer/StringToDateTimeTransformer.php
@@ -31,7 +31,11 @@ public function transform(mixed $data, array $options, object $targetObject, obj
             throw new WrongDataTypeTransformerException('Data is supposed to be a string to use transform : ' . self::class . ' ' . gettype($data) . ' provided');
         }
 
-        return new DateTime($data);
+        if (isset($options['timezone'])) {
+            $timezone = $options['timezone'];
+        }
+
+        return new DateTime($data, $timezone ?? null);
     }
 
     /**

diff --git a/tests/Unit/Transformers/StringToDateTimeTransformerTest.php b/tests/Unit/Transformers/StringToDateTimeTransformerTest.php
@@ -4,6 +4,7 @@
 
 use DateTime;
 use DateTimeInterface;
+use DateTimeZone;
 use Ehyiah\MappingBundle\Tests\Dummy\DummyMappedObject;
 use Ehyiah\MappingBundle\Tests\Dummy\DummyTargetObject;
 use Ehyiah\MappingBundle\Transformer\StringToDateTimeTransformer;
@@ -28,6 +29,30 @@ public function testTransform(): void
         $this->assertInstanceOf(DateTimeInterface::class, $result);
     }
 
+    /**
+     * @covers ::transform
+     */
+    public function testTransformWithDateTimeZone(): void
+    {
+        $transformer = new StringToDateTimeTransformer();
+
+        $data = '2025-12-12';
+
+        $result = $transformer->transform($data, ['timezone' => new DateTimeZone('UTC')], new DummyTargetObject(), new DummyMappedObject());
+
+        $timezone = $result->getTimezone()->getName();
+
+        $this->assertInstanceOf(DateTimeInterface::class, $result);
+        $this->assertSame('UTC', $timezone);
+
+        $result = $transformer->transform($data, ['timezone' => new DateTimeZone('Europe/Tallinn')], new DummyTargetObject(), new DummyMappedObject());
+
+        $timezone = $result->getTimezone()->getName();
+
+        $this->assertInstanceOf(DateTimeInterface::class, $result);
+        $this->assertSame('Europe/Tallinn', $timezone);
+    }
+
     /**
      * @covers ::reverseTransform
      */