Apply suggested changes

Author: patel-vansh

system/DataCaster/Cast/FloatCast.php

@@ -38,17 +38,13 @@ public static function get(
             return (float) $value;
         }
 
-        $mode = PHP_ROUND_HALF_UP; // Default mode
-
-        if (isset($params[1])) {
-            $mode = match (strtolower($params[1])) {
-                'up'    => PHP_ROUND_HALF_UP,
-                'down'  => PHP_ROUND_HALF_DOWN,
-                'even'  => PHP_ROUND_HALF_EVEN,
-                'odd'   => PHP_ROUND_HALF_ODD,
-                default => throw CastException::forInvalidFloatRoundingMode($params[1]),
-            };
-        }
+        $mode = match (strtolower($params[1] ?? 'up')) {
+            'up'    => PHP_ROUND_HALF_UP,
+            'down'  => PHP_ROUND_HALF_DOWN,
+            'even'  => PHP_ROUND_HALF_EVEN,
+            'odd'   => PHP_ROUND_HALF_ODD,
+            default => throw CastException::forInvalidFloatRoundingMode($params[1]),
+        };
 
         return round((float) $value, $precision, $mode);
     }

system/Entity/Cast/FloatCast.php

@@ -25,17 +25,13 @@ public static function get($value, array $params = []): float
             return (float) $value;
         }
 
-        $mode = PHP_ROUND_HALF_UP; // Default mode
-
-        if (isset($params[1])) {
-            $mode = match (strtolower($params[1])) {
-                'up'    => PHP_ROUND_HALF_UP,
-                'down'  => PHP_ROUND_HALF_DOWN,
-                'even'  => PHP_ROUND_HALF_EVEN,
-                'odd'   => PHP_ROUND_HALF_ODD,
-                default => throw CastException::forInvalidFloatRoundingMode($params[1]),
-            };
-        }
+        $mode = match (strtolower($params[1] ?? 'up')) {
+            'up'    => PHP_ROUND_HALF_UP,
+            'down'  => PHP_ROUND_HALF_DOWN,
+            'even'  => PHP_ROUND_HALF_EVEN,
+            'odd'   => PHP_ROUND_HALF_ODD,
+            default => throw CastException::forInvalidFloatRoundingMode($params[1]),
+        };
 
         return round((float) $value, $precision, $mode);
     }

system/Entity/Exceptions/CastException.php

@@ -125,11 +125,9 @@ public static function forInvalidEnumType(string $expectedClass, string $actualC
 
     /**
      * Thrown when an invalid rounding mode is provided for float casting.
-     *
-     * @return static
      */
-    public static function forInvalidFloatRoundingMode(string $mode)
+    public static function forInvalidFloatRoundingMode(string $mode): static
     {
-        return new static(lang('Cast.floatInvalidRoundingMode', [$mode]));
+        return new static(lang('Cast.invalidFloatRoundingMode', [$mode]));
     }
 }

system/Language/en/Cast.php

@@ -27,5 +27,5 @@
     'jsonErrorSyntax'          => 'Syntax error, malformed JSON.',
     'jsonErrorUnknown'         => 'Unknown error.',
     'jsonErrorUtf8'            => 'Malformed UTF-8 characters, possibly incorrectly encoded.',
-    'floatInvalidRoundingMode' => 'Invalid rounding mode "{0}" for float casting.',
+    'invalidFloatRoundingMode' => 'Invalid rounding mode "{0}" for float casting.',
 ];

tests/system/Entity/EntityTest.php

@@ -419,6 +419,36 @@ public function testCastFloat(): void
         $this->assertEqualsWithDelta(3.6, $entity->second, PHP_FLOAT_EPSILON);
     }
 
+    public function testCastFloatWithPrecision(): void
+    {
+        $entity = $this->getCastEntity();
+
+        $entity->fourteenth = 3.1415926535;
+
+        $this->assertIsFloat($entity->fourteenth);
+        $this->assertEqualsWithDelta(3.14, $entity->fourteenth, PHP_FLOAT_EPSILON);
+
+        $entity->fourteenth = '3.1415926535';
+
+        $this->assertIsFloat($entity->fourteenth);
+        $this->assertEqualsWithDelta(3.14, $entity->fourteenth, PHP_FLOAT_EPSILON);
+    }
+
+    public function testCastFloatWithPrecisionAndRoundingMode(): void
+    {
+        $entity = $this->getCastEntity();
+
+        $entity->fifteenth = 3.145;
+
+        $this->assertIsFloat($entity->fifteenth);
+        $this->assertEqualsWithDelta(3.14, $entity->fifteenth, PHP_FLOAT_EPSILON);
+
+        $entity->fifteenth = '3.135';
+
+        $this->assertIsFloat($entity->fifteenth);
+        $this->assertEqualsWithDelta(3.13, $entity->fifteenth, PHP_FLOAT_EPSILON);
+    }
+
     public function testCastDouble(): void
     {
         $entity = $this->getCastEntity();
@@ -1750,6 +1780,8 @@ private function getCastEntity($data = null): object
                 'eleventh'   => 'json-array',
                 'twelfth'    => 'csv',
                 'thirteenth' => 'uri',
+                'fourteenth' => 'float[2]',
+                'fifteenth'  => 'float[2,down]',
             ];
 
             public function setSeventh(string $seventh): void

user_guide_src/source/changelogs/v4.8.0.rst

@@ -246,14 +246,12 @@ Validation
 
 - Custom rule methods that set an error via the ``&$error`` reference parameter now support the ``{field}``, ``{param}``, and ``{value}`` placeholders, consistent with language-file and ``setRule()``/``setRules()`` error messages.
 
-Entities
-========
-
-- **Float and Double Casting:** Added support for precision and rounding mode when casting to float or double in entities.
-
 Others
 ======
 
+- **Float and Double Casting:** Added support for precision and rounding mode when casting to float or double in entities.
+- Float and Double casting now throws ``CastException::forInvalidFloatRoundingMode()`` if an rounding mode other than up, down, even or odd is provided.
+
 ***************
 Message Changes
 ***************

user_guide_src/source/models/model.rst

@@ -380,6 +380,20 @@ of type to mark the field as nullable, i.e., ``?int``, ``?datetime``.
 |``enum``       | Enum           | string/int type           |
 +---------------+----------------+---------------------------+
 
+float
+-----
+
+Casting as ``float`` will convert the value to a float type in PHP.
+This is best used with database columns that are of a float or numeric type.
+
+You can also pass arguments to the ``float`` type to specify the number
+of decimal places to round to as well as the rounding mode (up, down, even or odd).
+
+.. literalinclude:: model/067.php
+
+.. note:: Prior to v4.8.0 the ``float`` type did not support any parameters.
+    It simply converted the value to a float type in PHP without rounding.
+
 csv
 ---
 

user_guide_src/source/models/model/067.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace App\Models;
+
+use CodeIgniter\Model;
+
+class TransactionModel extends Model
+{
+    // ...
+    protected array $casts = [
+        'id'        => 'int',
+        'currency'  => 'string',
+        'amount'    => 'float[2,even]',
+    ];
+    // ...
+}