Locale fallback

azuyalabs · Sep 17, 2019 · 45577d3 · 45577d3
1 parent 3af5c4e
commit 45577d3
Show file tree

Hide file tree

Showing 132 changed files with 1,005 additions and 855 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -29,6 +29,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 - Code using class imports rather than Fully Qualified Class names.
 - Upgraded to PHPUnit 8.
 - Replaced the standard 'InvalidArgumentException' when an invalid year or holiday provider are given by a new exception for each of these two situations separately ('InvalidYearException' and 'ProviderNotFoundException'). This allows you to better distinguish which exception may occur when instantiating the Yasumi class. [\#95](https://github.com/azuyalabs/yasumi/pull/95) ([qneyrat](https://github.com/qneyrat))
+- Fallback support added to getName() to allow e.g. fallback from 'de_AT' to 'de'. [\#176](https://github.com/azuyalabs/yasumi/pull/176) ([c960657](https://github.com/c960657))
 
 ### Fixed
 - Late Summer Bank Holiday in 1968 and 1969 in United Kingdom [\#161](https://github.com/azuyalabs/yasumi/pull/161) ([c960657](https://github.com/c960657))

diff --git a/src/Yasumi/Holiday.php b/src/Yasumi/Holiday.php
@@ -160,7 +160,19 @@ public function jsonSerialize(): self
      */
     public function getName(): string
     {
-        return $this->translations[$this->displayLocale] ?? $this->translations[self::DEFAULT_LOCALE] ?? $this->shortName;
+        $locales = \array_merge(
+            [$locale ?? $this->displayLocale],
+            Yasumi::getParentLocales($this->displayLocale),
+            [self::DEFAULT_LOCALE]
+        );
+
+        foreach ($locales as $locale) {
+            if (isset($this->translations[$locale])) {
+                return $this->translations[$locale];
+            }
+        }
+
+        return $this->shortName;
     }
 
     /**

diff --git a/src/Yasumi/Provider/Australia.php b/src/Yasumi/Provider/Australia.php
@@ -71,15 +71,15 @@ public function initialize(): void
     private function calculateNewYearHolidays(): void
     {
         $newyearsday = new DateTime("$this->year-01-01", new DateTimeZone($this->timezone));
-        $this->calculateHoliday('newYearsDay', ['en_AU' => 'New Year\'s Day'], $newyearsday, false, false);
+        $this->calculateHoliday('newYearsDay', [], $newyearsday, false, false);
         switch ($newyearsday->format('w')) {
             case 0: // sunday
                 $newyearsday->add(new DateInterval('P1D'));
-                $this->calculateHoliday('newYearsHoliday', ['en_AU' => 'New Year\'s Holiday'], $newyearsday, false, false);
+                $this->calculateHoliday('newYearsHoliday', ['en' => 'New Year\'s Holiday'], $newyearsday, false, false);
                 break;
             case 6: // saturday
                 $newyearsday->add(new DateInterval('P2D'));
-                $this->calculateHoliday('newYearsHoliday', ['en_AU' => 'New Year\'s Holiday'], $newyearsday, false, false);
+                $this->calculateHoliday('newYearsHoliday', ['en' => 'New Year\'s Holiday'], $newyearsday, false, false);
                 break;
         }
     }
@@ -137,7 +137,7 @@ private function calculateAustraliaDay(): void
     {
         $date = new DateTime("$this->year-01-26", new DateTimeZone($this->timezone));
 
-        $this->calculateHoliday('australiaDay', ['en_AU' => 'Australia Day'], $date);
+        $this->calculateHoliday('australiaDay', ['en' => 'Australia Day'], $date);
     }
 
     /**
@@ -163,7 +163,7 @@ private function calculateAnzacDay(): void
         }
 
         $date = new DateTime("$this->year-04-25", new DateTimeZone($this->timezone));
-        $this->calculateHoliday('anzacDay', ['en_AU' => 'ANZAC Day'], $date, false, false);
+        $this->calculateHoliday('anzacDay', [], $date, false, false);
         $easter = $this->calculateEaster($this->year, $this->timezone);
 
         $easterMonday = $this->calculateEaster($this->year, $this->timezone);
@@ -172,7 +172,7 @@ private function calculateAnzacDay(): void
         $fDate = $date->format('Y-m-d');
         if ($fDate === $easter->format('Y-m-d') || $fDate === $easterMonday->format('Y-m-d')) {
             $easterMonday->add(new DateInterval('P1D'));
-            $this->calculateHoliday('easterTuesday', ['en_AU' => 'Easter Tuesday'], $easterMonday, false, false);
+            $this->calculateHoliday('easterTuesday', ['en' => 'Easter Tuesday'], $easterMonday, false, false);
         }
         unset($fDate);
     }
@@ -193,23 +193,23 @@ private function calculateChristmasDay(): void
     {
         $christmasDay = new DateTime("$this->year-12-25", new DateTimeZone($this->timezone));
         $boxingDay = new DateTime("$this->year-12-26", new DateTimeZone($this->timezone));
-        $this->calculateHoliday('christmasDay', ['en_AU' => 'Christmas Day'], $christmasDay, false, false);
-        $this->calculateHoliday('secondChristmasDay', ['en_AU' => 'Boxing Day'], $boxingDay, false, false);
+        $this->calculateHoliday('christmasDay', [], $christmasDay, false, false);
+        $this->calculateHoliday('secondChristmasDay', [], $boxingDay, false, false);
 
         switch ($christmasDay->format('w')) {
             case 0: // sunday
                 $christmasDay->add(new DateInterval('P2D'));
-                $this->calculateHoliday('christmasHoliday', ['en_AU' => 'Christmas Holiday'], $christmasDay, false, false);
+                $this->calculateHoliday('christmasHoliday', ['en' => 'Christmas Holiday'], $christmasDay, false, false);
                 break;
             case 5: // friday
                 $boxingDay->add(new DateInterval('P2D'));
-                $this->calculateHoliday('secondChristmasHoliday', ['en_AU' => 'Boxing Day Holiday'], $boxingDay, false, false);
+                $this->calculateHoliday('secondChristmasHoliday', ['en' => 'Boxing Day Holiday'], $boxingDay, false, false);
                 break;
             case 6: // saturday
                 $christmasDay->add(new DateInterval('P2D'));
                 $boxingDay->add(new DateInterval('P2D'));
-                $this->calculateHoliday('christmasHoliday', ['en_AU' => 'Christmas Holiday'], $christmasDay, false, false);
-                $this->calculateHoliday('secondChristmasHoliday', ['en_AU' => 'Boxing Day Holiday'], $boxingDay, false, false);
+                $this->calculateHoliday('christmasHoliday', ['en' => 'Christmas Holiday'], $christmasDay, false, false);
+                $this->calculateHoliday('secondChristmasHoliday', ['en' => 'Boxing Day Holiday'], $boxingDay, false, false);
                 break;
         }
     }

diff --git a/src/Yasumi/Provider/Australia/ACT.php b/src/Yasumi/Provider/Australia/ACT.php
@@ -77,7 +77,7 @@ private function easterSunday($year, $timezone, $locale, $type = null): Holiday
     {
         return new Holiday(
             'easter',
-            ['en_AU' => 'Easter Sunday'],
+            ['en' => 'Easter Sunday'],
             $this->calculateEaster($year, $timezone),
             $locale,
             $type ?? Holiday::TYPE_OFFICIAL
@@ -109,7 +109,7 @@ private function easterSaturday($year, $timezone, $locale, $type = null): Holida
     {
         return new Holiday(
             'easterSaturday',
-            ['en_AU' => 'Easter Saturday'],
+            ['en' => 'Easter Saturday'],
             $this->calculateEaster($year, $timezone)->sub(new DateInterval('P1D')),
             $locale,
             $type ?? Holiday::TYPE_OFFICIAL
@@ -135,7 +135,7 @@ private function calculateQueensBirthday(): void
     {
         $this->calculateHoliday(
             'queensBirthday',
-            ['en_AU' => "Queen's Birthday"],
+            ['en' => "Queen's Birthday"],
             new DateTime('second monday of june ' . $this->year, new DateTimeZone($this->timezone)),
             false,
             false
@@ -151,7 +151,7 @@ private function calculateLabourDay(): void
     {
         $date = new DateTime("first monday of october $this->year", new DateTimeZone($this->timezone));
 
-        $this->addHoliday(new Holiday('labourDay', ['en_AU' => 'Labour Day'], $date, $this->locale));
+        $this->addHoliday(new Holiday('labourDay', [], $date, $this->locale));
     }
 
     /**
@@ -166,7 +166,7 @@ private function calculateCanberraDay(): void
         } else {
             $date = new DateTime("second monday of march $this->year", new DateTimeZone($this->timezone));
         }
-        $this->addHoliday(new Holiday('canberraDay', ['en_AU' => 'Canberra Day'], $date, $this->locale));
+        $this->addHoliday(new Holiday('canberraDay', ['en' => 'Canberra Day'], $date, $this->locale));
     }
 
     /**
@@ -185,6 +185,6 @@ private function calculateReconciliationDay(): void
         if (1 !== $day) {
             $date = $date->add(0 === $day ? new DateInterval('P1D') : new DateInterval('P' . (8 - $day) . 'D'));
         }
-        $this->addHoliday(new Holiday('reconciliationDay', ['en_AU' => 'Reconciliation Day'], $date, $this->locale));
+        $this->addHoliday(new Holiday('reconciliationDay', ['en' => 'Reconciliation Day'], $date, $this->locale));
     }
 }
diff --git a/src/Yasumi/Provider/Australia/NSW.php b/src/Yasumi/Provider/Australia/NSW.php
@@ -44,7 +44,7 @@ public function initialize(): void
     {
         parent::initialize();
 
-        $this->addHoliday(new Holiday('easter', ['en_AU' => 'Easter Sunday'], $this->calculateEaster($this->year, $this->timezone), $this->locale));
+        $this->addHoliday(new Holiday('easter', [], $this->calculateEaster($this->year, $this->timezone), $this->locale));
         $this->addHoliday($this->easterSaturday($this->year, $this->timezone, $this->locale));
         $this->calculateQueensBirthday();
         $this->calculateLabourDay();
@@ -76,7 +76,7 @@ private function easterSaturday($year, $timezone, $locale, $type = null): Holida
     {
         return new Holiday(
             'easterSaturday',
-            ['en_AU' => 'Easter Saturday'],
+            ['en' => 'Easter Saturday'],
             $this->calculateEaster($year, $timezone)->sub(new DateInterval('P1D')),
             $locale,
             $type ?? Holiday::TYPE_OFFICIAL
@@ -102,7 +102,7 @@ private function calculateQueensBirthday(): void
     {
         $this->calculateHoliday(
             'queensBirthday',
-            ['en_AU' => "Queen's Birthday"],
+            ['en' => "Queen's Birthday"],
             new DateTime('second monday of june ' . $this->year, new DateTimeZone($this->timezone)),
             false,
             false
@@ -131,7 +131,7 @@ private function calculateBankHoliday(): void
     {
         $this->calculateHoliday(
             'bankHoliday',
-            ['en_AU' => 'Bank Holiday'],
+            ['en' => 'Bank Holiday'],
             new DateTime('first monday of august ' . $this->year, new DateTimeZone($this->timezone)),
             false,
             false,

diff --git a/src/Yasumi/Provider/Australia/NT.php b/src/Yasumi/Provider/Australia/NT.php
@@ -75,7 +75,7 @@ private function easterSaturday($year, $timezone, $locale, $type = null): Holida
     {
         return new Holiday(
             'easterSaturday',
-            ['en_AU' => 'Easter Saturday'],
+            ['en' => 'Easter Saturday'],
             $this->calculateEaster($year, $timezone)->sub(new DateInterval('P1D')),
             $locale,
             $type ?? Holiday::TYPE_OFFICIAL
@@ -101,7 +101,7 @@ private function calculateQueensBirthday(): void
     {
         $this->calculateHoliday(
             'queensBirthday',
-            ['en_AU' => "Queen's Birthday"],
+            ['en' => "Queen's Birthday"],
             new DateTime('second monday of june ' . $this->year, new DateTimeZone($this->timezone)),
             false,
             false
@@ -117,7 +117,7 @@ private function calculateMayDay(): void
     {
         $date = new DateTime("first monday of may $this->year", new DateTimeZone($this->timezone));
 
-        $this->addHoliday(new Holiday('mayDay', ['en_AU' => 'May Day'], $date, $this->locale));
+        $this->addHoliday(new Holiday('mayDay', ['en' => 'May Day'], $date, $this->locale));
     }
 
     /**
@@ -132,7 +132,7 @@ private function calculatePicnicDay(): void
     {
         $this->calculateHoliday(
             'picnicDay',
-            ['en_AU' => 'Picnic Day'],
+            ['en' => 'Picnic Day'],
             new DateTime('first monday of august ' . $this->year, new DateTimeZone($this->timezone)),
             false,
             false

diff --git a/src/Yasumi/Provider/Australia/Queensland.php b/src/Yasumi/Provider/Australia/Queensland.php
@@ -67,15 +67,15 @@ private function calculateQueensBirthday(): void
         if ($this->year < 2012 || 2013 === $this->year || 2014 === $this->year || 2015 === $this->year) {
             $this->calculateHoliday(
                 'queensBirthday',
-                ['en_AU' => "Queen's Birthday"],
+                ['en' => "Queen's Birthday"],
                 new DateTime('second monday of june ' . $this->year, new DateTimeZone($this->timezone)),
                 false,
                 false
             );
         } else {
             $this->calculateHoliday(
                 'queensBirthday',
-                ['en_AU' => "Queen's Birthday"],
+                ['en' => "Queen's Birthday"],
                 new DateTime('first monday of october ' . $this->year, new DateTimeZone($this->timezone)),
                 false,
                 false

diff --git a/src/Yasumi/Provider/Australia/Queensland/Brisbane.php b/src/Yasumi/Provider/Australia/Queensland/Brisbane.php
@@ -72,6 +72,6 @@ private function calculatePeoplesDay(): void
             $date = $date->add(new DateInterval('P7D'));
         }
         $date = $date->add(new DateInterval('P5D'));
-        $this->addHoliday(new Holiday('peoplesDay', ['en_AU' => 'Ekka People\'s Day'], $date, $this->locale));
+        $this->addHoliday(new Holiday('peoplesDay', ['en' => 'Ekka People\'s Day'], $date, $this->locale));
     }
 }
diff --git a/src/Yasumi/Provider/Australia/SA.php b/src/Yasumi/Provider/Australia/SA.php
@@ -83,7 +83,7 @@ private function easterSaturday($year, $timezone, $locale, $type = null): Holida
     {
         return new Holiday(
             'easterSaturday',
-            ['en_AU' => 'Easter Saturday'],
+            ['en' => 'Easter Saturday'],
             $this->calculateEaster($year, $timezone)->sub(new DateInterval('P1D')),
             $locale,
             $type ?? Holiday::TYPE_OFFICIAL
@@ -109,7 +109,7 @@ private function calculateQueensBirthday(): void
     {
         $this->calculateHoliday(
             'queensBirthday',
-            ['en_AU' => "Queen's Birthday"],
+            ['en' => "Queen's Birthday"],
             new DateTime('second monday of june ' . $this->year, new DateTimeZone($this->timezone)),
             false,
             false
@@ -125,7 +125,7 @@ private function calculateLabourDay(): void
     {
         $date = new DateTime("first monday of october $this->year", new DateTimeZone($this->timezone));
 
-        $this->addHoliday(new Holiday('labourDay', ['en_AU' => 'Labour Day'], $date, $this->locale));
+        $this->addHoliday(new Holiday('labourDay', ['en' => 'Labour Day'], $date, $this->locale));
     }
 
     /**
@@ -142,15 +142,15 @@ private function calculateAdelaideCupDay(): void
             if ($this->year < 2006) {
                 $this->calculateHoliday(
                     'adelaideCup',
-                    ['en_AU' => 'Adelaide Cup'],
+                    ['en' => 'Adelaide Cup'],
                     new DateTime('third monday of may ' . $this->year, new DateTimeZone($this->timezone)),
                     false,
                     false
                 );
             } else {
                 $this->calculateHoliday(
                     'adelaideCup',
-                    ['en_AU' => 'Adelaide Cup'],
+                    ['en' => 'Adelaide Cup'],
                     new DateTime('second monday of march ' . $this->year, new DateTimeZone($this->timezone)),
                     false,
                     false
@@ -167,27 +167,27 @@ private function calculateAdelaideCupDay(): void
     private function calculateProclamationDay(): void
     {
         $christmasDay = new DateTime("$this->year-12-25", new DateTimeZone($this->timezone));
-        $this->calculateHoliday('christmasDay', ['en_AU' => 'Christmas Day'], $christmasDay, false, false);
+        $this->calculateHoliday('christmasDay', [], $christmasDay, false, false);
         switch ($christmasDay->format('w')) {
             case 0: // sunday
                 $christmasDay->add(new DateInterval('P1D'));
-                $this->calculateHoliday('christmasHoliday', ['en_AU' => 'Christmas Holiday'], $christmasDay, false, false);
+                $this->calculateHoliday('christmasHoliday', ['en' => 'Christmas Holiday'], $christmasDay, false, false);
                 $proclamationDay = $christmasDay->add(new DateInterval('P1D'));
-                $this->calculateHoliday('proclamationDay', ['en_AU' => 'Proclamation Day'], $proclamationDay, false, false);
+                $this->calculateHoliday('proclamationDay', ['en' => 'Proclamation Day'], $proclamationDay, false, false);
                 break;
             case 5: // friday
                 $proclamationDay = $christmasDay->add(new DateInterval('P3D'));
-                $this->calculateHoliday('proclamationDay', ['en_AU' => 'Proclamation Day'], $proclamationDay, false, false);
+                $this->calculateHoliday('proclamationDay', ['en' => 'Proclamation Day'], $proclamationDay, false, false);
                 break;
             case 6: // saturday
                 $christmasDay->add(new DateInterval('P2D'));
-                $this->calculateHoliday('christmasHoliday', ['en_AU' => 'Christmas Holiday'], $christmasDay, false, false);
+                $this->calculateHoliday('christmasHoliday', ['en' => 'Christmas Holiday'], $christmasDay, false, false);
                 $proclamationDay = $christmasDay->add(new DateInterval('P1D'));
-                $this->calculateHoliday('proclamationDay', ['en_AU' => 'Proclamation Day'], $proclamationDay, false, false);
+                $this->calculateHoliday('proclamationDay', ['en' => 'Proclamation Day'], $proclamationDay, false, false);
                 break;
             default: // monday-thursday
                 $proclamationDay = $christmasDay->add(new DateInterval('P1D'));
-                $this->calculateHoliday('proclamationDay', ['en_AU' => 'Proclamation Day'], $proclamationDay, false, false);
+                $this->calculateHoliday('proclamationDay', ['en' => 'Proclamation Day'], $proclamationDay, false, false);
                 break;
         }
     }

diff --git a/src/Yasumi/Provider/Australia/Tasmania.php b/src/Yasumi/Provider/Australia/Tasmania.php
@@ -57,7 +57,7 @@ private function calculateEightHoursDay(): void
     {
         $date = new DateTime("second monday of march $this->year", new DateTimeZone($this->timezone));
 
-        $this->addHoliday(new Holiday('eightHourDay', ['en_AU' => 'Eight Hour Day'], $date, $this->locale));
+        $this->addHoliday(new Holiday('eightHourDay', ['en' => 'Eight Hour Day'], $date, $this->locale));
     }
 
     /**
@@ -79,7 +79,7 @@ private function calculateQueensBirthday(): void
     {
         $this->calculateHoliday(
             'queensBirthday',
-            ['en_AU' => 'Queen\'s Birthday'],
+            ['en' => 'Queen\'s Birthday'],
             new DateTime('second monday of june ' . $this->year, new DateTimeZone($this->timezone)),
             false,
             false
@@ -98,7 +98,7 @@ private function calculateRecreationDay(): void
     {
         $this->calculateHoliday(
             'recreationDay',
-            ['en_AU' => 'Recreation Day'],
+            ['en' => 'Recreation Day'],
             new DateTime('first monday of november ' . $this->year, new DateTimeZone($this->timezone)),
             false,
             false

diff --git a/src/Yasumi/Provider/Australia/Tasmania/CentralNorth.php b/src/Yasumi/Provider/Australia/Tasmania/CentralNorth.php
@@ -54,6 +54,6 @@ private function calculateDevonportShow(): void
     {
         $date = new DateTime($this->year . '-12-02', new DateTimeZone($this->timezone));
         $date = $date->modify('previous friday');
-        $this->addHoliday(new Holiday('devonportShow', ['en_AU' => 'Devonport Show'], $date, $this->locale));
+        $this->addHoliday(new Holiday('devonportShow', ['en' => 'Devonport Show'], $date, $this->locale));
     }
 }
diff --git a/src/Yasumi/Provider/Australia/Tasmania/FlindersIsland.php b/src/Yasumi/Provider/Australia/Tasmania/FlindersIsland.php
@@ -55,6 +55,6 @@ private function calculateFlindersIslandShow(): void
     {
         $date = new DateTime('third saturday of october ' . $this->year, new DateTimeZone($this->timezone));
         $date = $date->sub(new DateInterval('P1D'));
-        $this->addHoliday(new Holiday('flindersIslandShow', ['en_AU' => 'Flinders Island Show'], $date, $this->locale));
+        $this->addHoliday(new Holiday('flindersIslandShow', ['en' => 'Flinders Island Show'], $date, $this->locale));
     }
 }
diff --git a/src/Yasumi/Provider/Australia/Tasmania/KingIsland.php b/src/Yasumi/Provider/Australia/Tasmania/KingIsland.php
@@ -53,7 +53,7 @@ private function calculateKingIslandShow(): void
     {
         $this->calculateHoliday(
             'kingIslandShow',
-            ['en_AU' => 'King Island Show'],
+            ['en' => 'King Island Show'],
             new DateTime('first tuesday of march ' . $this->year, new DateTimeZone($this->timezone)),
             false,
             false