float/double add third parameter to define fixed numbers of decimals.…

… In json this param force to cast the result as a string. fix #1415
schmittjoh · Jan 6, 2023 · 0a242c4 · 0a242c4
1 parent ebe4ee3
commit 0a242c4
Show file tree

Hide file tree

Showing 6 changed files with 86 additions and 10 deletions.
diff --git a/doc/reference/annotations.rst b/doc/reference/annotations.rst
@@ -361,6 +361,11 @@ Available Types:
 |                                                            | Rounding Mode.                                   |
 |                                                            | (HALF_UP, HALF_DOWN, HALF_EVEN HALF_ODD)         |
 +------------------------------------------------------------+--------------------------------------------------+
+| double<2, 'HALF_DOWN', 2> or float<2, 'HALF_DOWN', 2>      | Primitive double with percision,                 |
+| double<2, 'HALF_DOWN', 3> or float<2, 'HALF_DOWN', 3>      | Rounding Mode and fixed decimals (default 1).    |
+|                                                            | (HALF_UP, HALF_DOWN, HALF_EVEN HALF_ODD)         |
+|                                                            | NOTE: for json the value is cast to string       |
++------------------------------------------------------------+--------------------------------------------------+
 | string                                                     | Primitive string                                 |
 +------------------------------------------------------------+--------------------------------------------------+
 | array                                                      | An array with arbitrary keys, and values.        |

diff --git a/src/JsonSerializationVisitor.php b/src/JsonSerializationVisitor.php
@@ -70,15 +70,20 @@ public function visitInteger(int $data, array $type)
      */
     public function visitDouble(float $data, array $type)
     {
+        $dataResult = $data;
         $percision = $type['params'][0] ?? null;
-        if (!is_int($percision)) {
-            return $data;
+        if ($percision) {
+            $roundMode = $type['params'][1] ?? null;
+            $roundMode = $this->mapRoundMode($roundMode);
+            $dataResult = round($dataResult, $percision, $roundMode);
         }
 
-        $roundMode = $type['params'][1] ?? null;
-        $roundMode = $this->mapRoundMode($roundMode);
+        $decimalsNumbers = $type['params'][2] ?? null;
+        if ($decimalsNumbers !== null) {
+            $dataResult = number_format($dataResult, $decimalsNumbers, '.', '');
+        }
 
-        return round($data, $percision, $roundMode);
+        return $dataResult;
     }
 
     /**

diff --git a/src/XmlSerializationVisitor.php b/src/XmlSerializationVisitor.php
@@ -179,14 +179,26 @@ public function visitInteger(int $data, array $type)
      */
     public function visitDouble(float $data, array $type)
     {
+        $dataResult = $data;
         $percision = $type['params'][0] ?? null;
-        if (is_int($percision)) {
+        if ($percision) {
             $roundMode = $type['params'][1] ?? null;
             $roundMode = $this->mapRoundMode($roundMode);
-            $data = round($data, $percision, $roundMode);
+            $dataResult = round($dataResult, $percision, $roundMode);
         }
 
-        return $this->document->createTextNode(var_export((float) $data, true));
+        $decimalsNumbers = $type['params'][2] ?? null;
+        if ($decimalsNumbers === null) {
+            $parts = explode('.', (string) $dataResult);
+            if (count($parts) < 2 || !$parts[1]) {
+                $decimalsNumbers = 1;
+            }
+        }
+        if ($decimalsNumbers !== null) {
+            $dataResult = number_format($dataResult, $decimalsNumbers, '.', '');
+        }
+
+        return $this->document->createTextNode((string) $dataResult);
     }
 
     /**

diff --git a/tests/Fixtures/ObjectWithFloatProperty.php b/tests/Fixtures/ObjectWithFloatProperty.php
@@ -43,18 +43,45 @@ class ObjectWithFloatProperty
     #[Type(name: 'double<2, "HALF_UP">')]
     private $floatingPointHalfUp;
 
+    /**
+     * @Type("double<2,null,2>")
+     * @var float
+     */
+    #[Type(name: 'double<2, null, 2>')]
+    private $floatingPointFixedDecimals;
+
+    /**
+     * @Type("double<2,null,1>")
+     * @var float
+     */
+    #[Type(name: 'double<2, null, 1>')]
+    private $floatingPointFixedDecimalsLess;
+
+    /**
+     * @Type("double<2,null,3>")
+     * @var float
+     */
+    #[Type(name: 'double<2, null, 3>')]
+    private $floatingPointFixedDecimalsMore;
+
     public function __construct(
         float $floatingPointUnchanged,
         float $floatingPointHalfDown,
         float $floatingPointHalfEven,
         float $floatingPointHalfOdd,
-        float $floatingPointHalfUp
+        float $floatingPointHalfUp,
+        float $floatingPointFixedDecimals,
+        float $floatingPointFixedDecimalsLess,
+        float $floatingPointFixedDecimalsMore
     ) {
         $this->floatingPointUnchanged = $floatingPointUnchanged;
         $this->floatingPointHalfDown = $floatingPointHalfDown;
         $this->floatingPointHalfEven = $floatingPointHalfEven;
         $this->floatingPointHalfOdd = $floatingPointHalfOdd;
         $this->floatingPointHalfUp = $floatingPointHalfUp;
+        $this->floatingPointFixedDecimals = $floatingPointFixedDecimals;
+        $this->floatingPointFixedDecimalsLess = $floatingPointFixedDecimalsLess;
+        $this->floatingPointFixedDecimalsMore = $floatingPointFixedDecimalsMore;
     }
 
     public function getFloatingPointUnchanged(): float
@@ -81,4 +108,19 @@ public function getFloatingPointHalfUp(): float
     {
         return $this->floatingPointHalfUp;
     }
+
+    public function getFloatingPointFixedDecimals(): float
+    {
+        return $this->floatingPointFixedDecimals;
+    }
+
+    public function getFloatingPointFixedDecimalsLess(): float
+    {
+        return $this->floatingPointFixedDecimalsLess;
+    }
+
+    public function getFloatingPointFixedDecimalsMore(): float
+    {
+        return $this->floatingPointFixedDecimalsMore;
+    }
 }
diff --git a/tests/Serializer/JsonSerializationTest.php b/tests/Serializer/JsonSerializationTest.php
@@ -453,6 +453,9 @@ public function testSerialisationWithPercisionForFloat(): void
             1.555,
             1.15,
             1.15,
+            1.555,
+            1.5,
+            1.555,
             1.555
         );
 
@@ -464,7 +467,10 @@ public function testSerialisationWithPercisionForFloat(): void
             . '"floating_point_half_down":1.55,'
             . '"floating_point_half_even":1.2,'
             . '"floating_point_half_odd":1.1,'
-            . '"floating_point_half_up":1.56'
+            . '"floating_point_half_up":1.56,'
+            . '"floating_point_fixed_decimals":"1.50",'
+            . '"floating_point_fixed_decimals_less":"1.6",'
+            . '"floating_point_fixed_decimals_more":"1.560"'
             . '}',
             $result
         );

diff --git a/tests/Serializer/XmlSerializationTest.php b/tests/Serializer/XmlSerializationTest.php
@@ -577,6 +577,9 @@ public function testSerialisationWithPercisionForFloat(): void
             1.555,
             1.15,
             1.15,
+            1.555,
+            1.5,
+            1.555,
             1.555
         );
 
@@ -590,6 +593,9 @@ public function testSerialisationWithPercisionForFloat(): void
               <floating_point_half_even>1.2</floating_point_half_even>
               <floating_point_half_odd>1.1</floating_point_half_odd>
               <floating_point_half_up>1.56</floating_point_half_up>
+              <floating_point_fixed_decimals>1.50</floating_point_fixed_decimals>
+              <floating_point_fixed_decimals_less>1.6</floating_point_fixed_decimals_less>
+              <floating_point_fixed_decimals_more>1.560</floating_point_fixed_decimals_more>
             </result>',
             $result
         );