Merge pull request #208 from spatie/feature/default-locale

Add default locale
spatie · Feb 21, 2024 · e7bb90a · e7bb90a
2 parents 0e10361 + 6ed9873
commit e7bb90a
Show file tree

Hide file tree

Showing 24 changed files with 170 additions and 129 deletions.
diff --git a/lang/bahrain/en/holidays.json b/lang/bahrain/en/holidays.json
diff --git a/lang/bangladesh/en/holidays.json b/lang/bangladesh/en/holidays.json
diff --git a/lang/egypt/en/holidays.json b/lang/egypt/en/holidays.json
diff --git a/lang/iran/fa/holidays.json b/lang/iran/fa/holidays.json
diff --git a/lang/montenegro/sr/holidays.json b/lang/montenegro/sr/holidays.json
diff --git a/lang/switzerland/de/holidays.json b/lang/switzerland/de/holidays.json
diff --git a/src/Concerns/Translatable.php b/src/Concerns/Translatable.php
@@ -6,10 +6,15 @@
 
 trait Translatable
 {
-    protected function translate(string $country, string $name, ?string $locale = null): string
+    public function translate(string $country, string $name, ?string $locale = null): string
     {
         if ($locale === null) {
             return $name;
+
+        }
+
+        if ($locale === $this->defaultLocale()) {
+            return $name;
         }
 
         $countryName = strtolower($country);

diff --git a/src/Contracts/HasTranslations.php b/src/Contracts/HasTranslations.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Spatie\Holidays\Contracts;
+
+interface HasTranslations
+{
+    public function defaultLocale(): string;
+
+    public function translate(string $country, string $name, ?string $locale = null): string;
+}
diff --git a/src/Countries/Albania.php b/src/Countries/Albania.php
@@ -3,15 +3,24 @@
 namespace Spatie\Holidays\Countries;
 
 use Carbon\CarbonImmutable;
+use Spatie\Holidays\Concerns\Translatable;
+use Spatie\Holidays\Contracts\HasTranslations;
 use Spatie\Holidays\Exceptions\InvalidYear;
 
-class Albania extends Country
+class Albania extends Country implements HasTranslations
 {
+    use Translatable;
+
     public function countryCode(): string
     {
         return 'al';
     }
 
+    public function defaultLocale(): string
+    {
+        return 'al';
+    }
+
     protected function allHolidays(int $year): array
     {
         return array_merge([

diff --git a/src/Countries/Azerbaijan.php b/src/Countries/Azerbaijan.php
@@ -3,14 +3,23 @@
 namespace Spatie\Holidays\Countries;
 
 use Carbon\CarbonImmutable;
+use Spatie\Holidays\Concerns\Translatable;
+use Spatie\Holidays\Contracts\HasTranslations;
 
-class Azerbaijan extends Country
+class Azerbaijan extends Country implements HasTranslations
 {
+    use Translatable;
+
     public function countryCode(): string
     {
         return 'az';
     }
 
+    public function defaultLocale(): string
+    {
+        return 'az';
+    }
+
     protected function allHolidays(int $year): array
     {
         return array_merge([
@@ -31,7 +40,6 @@ protected function allHolidays(int $year): array
     /** @return array<string, CarbonImmutable> */
     protected function variableHolidays(int $year): array
     {
-        // does not change according to the standard
         return [];
     }
 }
diff --git a/src/Countries/Bahrain.php b/src/Countries/Bahrain.php
@@ -4,10 +4,14 @@
 
 use Carbon\CarbonImmutable;
 use Carbon\CarbonInterface;
+use Spatie\Holidays\Concerns\Translatable;
+use Spatie\Holidays\Contracts\HasTranslations;
 use Spatie\Holidays\Exceptions\InvalidYear;
 
-class Bahrain extends Country
+class Bahrain extends Country implements HasTranslations
 {
+    use Translatable;
+
     protected const EID_AL_FITR_HOLIDAYS = [
         2020 => '05-24',
         2021 => '05-13',
@@ -139,6 +143,11 @@ public function countryCode(): string
         return 'bh';
     }
 
+    public function defaultLocale(): string
+    {
+        return 'en';
+    }
+
     protected function allHolidays(int $year): array
     {
         $variableHolidays = $this->variableHolidays($year);

diff --git a/src/Countries/Bangladesh.php b/src/Countries/Bangladesh.php
@@ -3,14 +3,23 @@
 namespace Spatie\Holidays\Countries;
 
 use Carbon\CarbonImmutable;
+use Spatie\Holidays\Concerns\Translatable;
+use Spatie\Holidays\Contracts\HasTranslations;
 
-class Bangladesh extends Country
+class Bangladesh extends Country implements HasTranslations
 {
+    use Translatable;
+
     public function countryCode(): string
     {
         return 'bd';
     }
 
+    public function defaultLocale(): string
+    {
+        return 'en';
+    }
+
     protected function allHolidays(int $year): array
     {
         return array_merge([

diff --git a/src/Countries/Belarus.php b/src/Countries/Belarus.php
@@ -3,14 +3,23 @@
 namespace Spatie\Holidays\Countries;
 
 use Carbon\CarbonImmutable;
+use Spatie\Holidays\Concerns\Translatable;
+use Spatie\Holidays\Contracts\HasTranslations;
 
-class Belarus extends Country
+class Belarus extends Country implements HasTranslations
 {
+    use Translatable;
+
     public function countryCode(): string
     {
         return 'by';
     }
 
+    public function defaultLocale(): string
+    {
+        return 'be';
+    }
+
     protected function allHolidays(int $year): array
     {
         return array_merge([

diff --git a/src/Countries/Belgium.php b/src/Countries/Belgium.php
@@ -3,14 +3,23 @@
 namespace Spatie\Holidays\Countries;
 
 use Carbon\CarbonImmutable;
+use Spatie\Holidays\Concerns\Translatable;
+use Spatie\Holidays\Contracts\HasTranslations;
 
-class Belgium extends Country
+class Belgium extends Country implements HasTranslations
 {
+    use Translatable;
+
     public function countryCode(): string
     {
         return 'be';
     }
 
+    public function defaultLocale(): string
+    {
+        return 'nl';
+    }
+
     protected function allHolidays(int $year): array
     {
         return array_merge([

diff --git a/src/Countries/Country.php b/src/Countries/Country.php
@@ -3,14 +3,12 @@
 namespace Spatie\Holidays\Countries;
 
 use Carbon\CarbonImmutable;
-use Spatie\Holidays\Concerns\Translatable;
+use Spatie\Holidays\Contracts\HasTranslations;
 use Spatie\Holidays\Exceptions\InvalidCountry;
 use Spatie\Holidays\Exceptions\InvalidYear;
 
 abstract class Country
 {
-    use Translatable;
-
     abstract public function countryCode(): string;
 
     /** @return array<string, string|CarbonImmutable> */
@@ -33,7 +31,9 @@ public function get(int $year, ?string $locale = null): array
                 }
             }
 
-            $name = $this->translate(basename(str_replace('\\', '/', static::class)), $name, $locale);
+            if ($this instanceof HasTranslations) {
+                $name = $this->translate(basename(str_replace('\\', '/', static::class)), $name, $locale);
+            }
 
             $translatedHolidays[$name] = $date;
         }

diff --git a/src/Countries/Egypt.php b/src/Countries/Egypt.php
@@ -4,10 +4,14 @@
 
 use Carbon\CarbonImmutable;
 use Carbon\CarbonInterface;
+use Spatie\Holidays\Concerns\Translatable;
+use Spatie\Holidays\Contracts\HasTranslations;
 use Spatie\Holidays\Exceptions\InvalidYear;
 
-class Egypt extends Country
+class Egypt extends Country implements HasTranslations
 {
+    use Translatable;
+
     protected const EID_AL_FITR_HOLIDAYS = [
         2005 => '11-04',
         2006 => '10-24',
@@ -229,6 +233,11 @@ public function countryCode(): string
         return 'eg';
     }
 
+    public function defaultLocale(): string
+    {
+        return 'en';
+    }
+
     protected function allHolidays(int $year): array
     {
         $fixedHolidays = $this->fixedHolidays($year);

diff --git a/src/Countries/Finland.php b/src/Countries/Finland.php
@@ -4,14 +4,23 @@
 
 use Carbon\CarbonImmutable;
 use Carbon\CarbonInterface;
+use Spatie\Holidays\Concerns\Translatable;
+use Spatie\Holidays\Contracts\HasTranslations;
 
-class Finland extends Country
+class Finland extends Country implements HasTranslations
 {
+    use Translatable;
+
     public function countryCode(): string
     {
         return 'fi';
     }
 
+    public function defaultLocale(): string
+    {
+        return 'fi';
+    }
+
     protected function allHolidays(int $year): array
     {
         return array_merge(