enhance currency formatting with effective locale handling and update settings migration

Author: simbabimba-dev

app/Helpers/CurrencyHelper.php

@@ -11,27 +11,57 @@ private function convertForDisplay($amount)
         return $amount / 1000;
     }
 
-    public function formatForDisplay($amount, $decimals = 2, $locale = null, $ignoreOverride = false)
+    /**
+     * Gets the effective locale to use for formatting, considering global overrides.
+     *
+     * @param string|null $locale The requested locale
+     * @param bool $ignoreOverride Whether to ignore the global override setting
+     * @return string The effective locale to use
+     */
+    private function getEffectiveLocale($locale = null, $ignoreOverride = false)
     {
-        $locale = $locale ?: str_replace('_', '-', app()->getLocale());
+        $effectiveLocale = $locale ?: str_replace('_', '-', app()->getLocale());
 
         if (!$ignoreOverride) {
             $override = resolve(\App\Settings\GeneralSettings::class)->currency_format_override ?? null;
-            if ($override) {
-                $locale = $override;
+            if ($override && $override !== '') {
+                $effectiveLocale = $override;
             }
         }
 
+        return $effectiveLocale;
+    }
+
+    /**
+     * Formats a currency amount for display.
+     *
+     * @param mixed $amount The amount to format.
+     * @param int $decimals Number of decimal places to use.
+     * @param string|null $locale The locale to use for formatting (defaults to current application locale).
+     * @param bool $ignoreOverride When true, bypasses the global currency format override setting.
+     * @return string The formatted currency string.
+     */
+    public function formatForDisplay($amount, $decimals = 2, $locale = null, $ignoreOverride = false)
+    {
+        $locale = $this->getEffectiveLocale($locale, $ignoreOverride);
+
         $display = $this->convertForDisplay($amount);
 
+        // Bulgarian ('bg') locale: For numbers <= 9999, use comma as decimal separator and no thousands separator.
+        // This follows common Bulgarian formatting conventions for small numbers, as per CLDR and local usage.
+        // source: https://forum.opencart.com/viewtopic.php?t=144907
         if ($locale === 'bg' && $display <= 9999) {
             return number_format($display, $decimals, ',', '');
         }
 
-        if ($locale === 'es' && $display < 10000) {
+        // Spanish ('es') locale: For numbers <= 9999, use comma as decimal separator and no thousands separator.
+        // This matches Spanish formatting standards for small numbers, as seen in CLDR and government guidelines.
+        if ($locale === 'es' && $display <= 9999) {
             return number_format($display, $decimals, ',', '');
         }
 
+        // Polish ('pl') locale: For numbers <= 9999, use comma as decimal separator and no thousands separator.
+        // This reflects Polish conventions for small numbers, according to CLDR and local financial documents.
         if ($locale === 'pl' && $display <= 9999) {
             return number_format($display, $decimals, ',', '');
         }
@@ -54,13 +84,7 @@ public function prepareForDatabase($amount)
 
     public function formatToCurrency(int $amount, $currency_code, $locale = null,)
     {
-        $locale = $locale ?: str_replace('_', '-', app()->getLocale());
-
-        // overriding users locale with global override
-        $override = resolve(\App\Settings\GeneralSettings::class)->currency_format_override ?? null;
-        if ($override) {
-            $locale = $override;
-        }
+        $locale = $this->getEffectiveLocale($locale, false);
 
         $formatter = new NumberFormatter($locale, NumberFormatter::CURRENCY);
 

app/Http/Controllers/PreferencesController.php

@@ -24,7 +24,8 @@ public function index(Request $request)
         $generalSettings = $this->generalSettings;
 
         $currencyOverrideAlert = null;
-        if ($generalSettings->currency_format_override) {
+        // Only show alert when an override is actively set (non-empty string)
+        if ($generalSettings->currency_format_override && $generalSettings->currency_format_override !== '') {
             $currencyOverrideAlert = __('Global currency format override is enabled. All currency and number displays use :locale formatting. Your language preference does not affect currency formatting.', ['locale' => $generalSettings->currency_format_override]);
         }
 

app/Settings/GeneralSettings.php

@@ -3,13 +3,13 @@
 namespace App\Settings;
 
 use Spatie\LaravelSettings\Settings;
-
+use App\Helpers\CurrencyHelper;
 class GeneralSettings extends Settings
 {
     public bool $store_enabled = false;
     public ?float $sales_tax = null;
     public string $credits_display_name = 'Credits';
-    public ?string $currency_format_override = 'en';
+    public ?string $currency_format_override = null;
     public ?string $recaptcha_version = null;
     public ?string $recaptcha_site_key = null;
     public ?string $recaptcha_secret_key = null;
@@ -70,11 +70,11 @@ public static function getCurrencyFormatOptions()
     {
         $options = [];
         $locales = config('app.available_locales');
-        $helper = new \App\Helpers\CurrencyHelper();
+        $helper = app(CurrencyHelper::class);
 
         foreach ($locales as $locale) {
             // Format a sample amount (1234.56 in database units = 1234560)
-            $sample = $helper->formatForDisplay(1234560, 2, $locale);
+            $sample = $helper->formatForDisplay(1234560, 2, $locale, true);
             $options[$locale] = "$locale: $sample";
         }
 

database/settings/2025_10_29_102720_add_currency_format_override_to_general_settings.php

@@ -6,6 +6,6 @@
 {
     public function up(): void
     {
-        $this->migrator->add('general.currency_format_override', 'en');
+        $this->migrator->add('general.currency_format_override', '');
     }
 };