Merge pull request #54 from Hi-Folks/feat/get-float

Add getFloat and getFloatStrict

Author: roberto-butti

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.1.1 - 2026-01-04
+- Adding `getFloat()` method for returing casted float value (nullable).
+- Adding `getFloatStrict()` method for returning strict float (not nullable).
+
 ## 1.1.0 - 2026-01-02
 - Add Symfony HttpClient support for loading JSON from URL. Thanks to @sonnymilton
 - Update to PHP 8.5 support.

README.md

@@ -326,6 +326,42 @@ $data1->getIntStrict("0.author.idx"); // Returns 0 because the field doesn't exi
 $data1->getIntStrict("0.author.idx", 44); // Returns 44 because the field doesn't exists, and you set a default, in this case 44
 ```
 
+### The `getFloat()` method
+
+The `getFloat()` method retrieves the value of a specified field as a float from a data block. If the field does not exist or is null, it returns a default value, which can be customized (`null` by default).
+
+**Parameters:**
+
+- `$path` (string): The path to the field (e.g., `"0.author.score"`).
+- `$default` (null|float): (Optional) The default value to return if the field doesn't exist. Defaults to null.
+- `$charNestedKey` (string): The character separator for nested field names. The default is `"."`.
+
+**Example usage:**
+
+```php
+$data1->getFloat("0.author.score"); // Returns the field value as a float, for example 4.75
+$data1->getFloat("0.author.notexists"); // Returns null because the field doesn't exist
+$data1->getFloat("0.author.notexists", 1.5); // Returns 1.5 because the field doesn't exist, and you set a default
+```
+
+### The `getFloatStrict()` method
+
+The `getFloatStrict()` method retrieves the value of a specified field as a float from a data block. If the field does not exist or is null, it returns a default value, which can be customized (`0.0` by default).
+
+**Parameters:**
+
+- `$path` (string): The path to the field (e.g., `"0.author.score"`).
+- `$default` (float): (Optional) The default value to return if the field doesn't exist. Defaults to `0.0`.
+- `$charNestedKey` (string): The character separator for nested field names. The default is `"."`.
+
+**Example usage:**
+
+```php
+$data1->getFloatStrict("0.author.score"); // Returns the field value as a float, for example 4.75
+$data1->getFloatStrict("0.author.notexists"); // Returns 0.0 because the field doesn't exist, and the method is strict
+$data1->getFloatStrict("0.author.notexists", 1.5); // Returns 1.5 because the field doesn't exist, and you set a default
+```
+
 ### The `getBoolean()` method
 
 The `getBoolean()` method retrieves the value of a specified field as a boolean from a data block. If the field does not exist or is null, it returns a default value, which can be customized (null by default).

src/Traits/TypeableBlock.php

@@ -27,7 +27,6 @@ public function getString(
         }
 
         return $defaultValue;
-
     }
 
     /**
@@ -51,7 +50,6 @@ public function getStringStrict(
         }
 
         return $defaultValue;
-
     }
 
     /**
@@ -60,8 +58,11 @@ public function getStringStrict(
      * @param int|null $defaultValue the default integer value returned if no value is found
      * @param non-empty-string $charNestedKey for nested field the . character is the default
      */
-    public function getInt(int|string $key, ?int $defaultValue = null, string $charNestedKey = "."): ?int
-    {
+    public function getInt(
+        int|string $key,
+        ?int $defaultValue = null,
+        string $charNestedKey = ".",
+    ): ?int {
         $returnValue = $this->get($key, null, $charNestedKey);
 
         if (is_scalar($returnValue)) {
@@ -77,8 +78,11 @@ public function getInt(int|string $key, ?int $defaultValue = null, string $charN
      * @param int $defaultValue the default integer value returned if no value is found
      * @param non-empty-string $charNestedKey for nested field the . character is the default
      */
-    public function getIntStrict(int|string $key, int $defaultValue = 0, string $charNestedKey = "."): int
-    {
+    public function getIntStrict(
+        int|string $key,
+        int $defaultValue = 0,
+        string $charNestedKey = ".",
+    ): int {
         $returnValue = $this->get($key, $defaultValue, $charNestedKey);
 
         if ($returnValue === null) {
@@ -130,4 +134,48 @@ public function getBooleanStrict(
 
         return $defaultValue;
     }
+
+    /**
+     * Return a forced float value from the get() method
+     * @param int|string $key the field key, can be nested for example "0.author.score"
+     * @param float|null $defaultValue the default float value returned if no value is found
+     * @param non-empty-string $charNestedKey for nested field the . character is the default
+     */
+    public function getFloat(
+        int|string $key,
+        ?float $defaultValue = null,
+        string $charNestedKey = ".",
+    ): ?float {
+        $returnValue = $this->get($key, null, $charNestedKey);
+
+        if (is_scalar($returnValue)) {
+            return floatval($returnValue);
+        }
+
+        return $defaultValue;
+    }
+
+    /**
+     * Return a forced float value from the get() method
+     * @param int|string $key the field key, can be nested for example "0.author.score"
+     * @param float $defaultValue the default float value returned if no value is found
+     * @param non-empty-string $charNestedKey for nested field the . character is the default
+     */
+    public function getFloatStrict(
+        int|string $key,
+        float $defaultValue = 0.0,
+        string $charNestedKey = ".",
+    ): float {
+        $returnValue = $this->get($key, $defaultValue, $charNestedKey);
+
+        if ($returnValue === null) {
+            return $defaultValue;
+        }
+
+        if (is_scalar($returnValue)) {
+            return floatval($returnValue);
+        }
+
+        return $defaultValue;
+    }
 }