Deprecating number_formated() and number_fr()

CHANGELOG.md

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+10.3.2 (2025-02-09)
+-------------------
+
+- Deprecated `number_formated()` helper in favor of `number_formatted()`
+- Deprecated `number_fr()` helper in favor of `number_formatted()`
+
+
 10.3.1 (2024-10-17)
 -------------------
 

README.md

@@ -13,8 +13,9 @@ Includes a set of useful tools for the Laravel framework.
     - [linebreaks()](#linebreaks)
     - [nl_to_p()](#nl_to_p)
     - [nl_to_br()](#nl_to_br)
-    - [number_formated()](#number_formated)
-    - [number_fr()](#number_fr)
+    - [number_formatted()](#number_formatted)
+    - [~~number_formated()~~](#number_formated)
+    - [~~number_fr()~~](#number_fr)
     - [compute_dec_to_time()](#compute_dec_to_time)
     - [convert_dec_to_time()](#convert_dec_to_time)
     - [human_readable_bytes_size()](#human_readable_bytes_size)
@@ -177,9 +178,9 @@ nl_to_br($str)
 // a text with <br> new lines <br><br> again <br><br><br> and again
 ```
 
-### number_formated()
+### number_formatted()
 
-Returns a number in current language format.
+Returns a number in current application language format.
 
 ```php
 $number = '123456789.101112';
@@ -190,9 +191,15 @@ $numberFormated = number_formated($number, 2);
 // en: 123,456,789.10
 ```
 
-### number_fr()
+### ~~number_formated()~~
+
+Deprecated : the `number_formated()` helper should no longer be used, `number_formatted()` should be used instead.
+
+
+### ~~number_fr()~~
+
+Deprecated : the `number_fr()` helper should no longer be used, `number_formatted()` should be used instead.
 
-Returns a number in french format.
 
 ### compute_dec_to_time()
 

composer.json

@@ -19,9 +19,9 @@
         "laravel/framework": "^10.0 || ^11.0"
     },
     "require-dev": {
-        "laravel/pint": "^1.18.1",
-        "driftingly/rector-laravel": "^1.2.4",
-        "rector/rector": "^1.2.5"
+        "laravel/pint": "^1.20.0",
+        "driftingly/rector-laravel": "^2.0.2",
+        "rector/rector": "^2.0.8"
     },
     "autoload": {
         "psr-4": {

rector.php

@@ -28,7 +28,7 @@
     ])
 
     // Up from PHP 5.3 to 8.2
-    //->withPhpSets()
+    // ->withPhpSets()
 
     // only PHP 8.2
     ->withPhpSets(php82: true)

src/helpers.php

@@ -145,7 +145,7 @@ function nl_to_p(string $str): string
         $str = preg_replace("/\n{2,}/", "\n\n", $str);
 
         // Replace multiple linebreaks by paragraphs
-        $str = preg_replace('/\n(\s*\n)+/', '</p><p>', $str);
+        $str = preg_replace('/\n(\s*\n)+/', '</p><p>', (string) $str);
 
         // Replace the single linebreaks by <br> elements
         $str = nl2br((string) $str, false);
@@ -164,11 +164,11 @@ function nl_to_br(string $str, bool $useXhtml = false): string
     }
 }
 
-if (! function_exists('number_formated')) {
+if (! function_exists('number_formatted')) {
     /**
      * Returns a number in current language format.
      */
-    function number_formated(float|string $value, int $decimals = 0): string
+    function number_formatted(float|string $value, int $decimals = 0): string
     {
         return number_format((float) $value, $decimals,
             trans('number.decimals_separator'),
@@ -177,12 +177,32 @@ function number_formated(float|string $value, int $decimals = 0): string
     }
 }
 
+if (! function_exists('number_formated')) {
+    /**
+     * Returns a number in current language format.
+     *
+     * @deprecated in 10.3.2 use number_formatted() instead
+     * @see number_formatted()
+     */
+    function number_formated(float|string $value, int $decimals = 0): string
+    {
+        trigger_error('The number_formated() helper should no longer be used, number_formatted() should be used instead.', E_USER_DEPRECATED);
+
+        return number_formatted($value, $decimals);
+    }
+}
+
 if (! function_exists('number_fr')) {
     /**
      * Returns a number in french format.
+     *
+     * @deprecated in 10.3.2 use number_formatted() instead
+     * @see number_formatted()
      */
     function number_fr(float|string $value, int $decimals = 0): string
     {
+        trigger_error('The number_fr() helper should no longer be used, number_formatted() should be used instead.', E_USER_DEPRECATED);
+
         return number_format($value, $decimals, ',', ' ');
     }
 }
@@ -358,7 +378,7 @@ function is_valid_model(string $modelClass): bool
      */
     function semverToId(string $version): int
     {
-        trigger_error('The semverToId() helper should no longer be used, semver_to_id() should be used instead.', E_USER_WARNING);
+        trigger_error('The semverToId() helper should no longer be used, semver_to_id() should be used instead.', E_USER_DEPRECATED);
 
         return semver_to_id($version);
     }