Updated inline documentation to include correction Exception throws.

Signed-off-by: Sacha Telgenhof <[email protected]>
crossan007 · Jan 22, 2018 · f088c88 · f088c88
1 parent 42c1f5e
commit f088c88
Show file tree

Hide file tree

Showing 95 changed files with 164 additions and 23 deletions.
diff --git a/src/Yasumi/Provider/AbstractProvider.php b/src/Yasumi/Provider/AbstractProvider.php
@@ -332,6 +332,7 @@ public function getYear()
      * @throws \Yasumi\Exception\UnknownLocaleException
      * @throws \RuntimeException
      * @throws \InvalidArgumentException
+     * @throws \ReflectionException
      *
      * @covers AbstractProvider::anotherTime
      */
@@ -351,6 +352,7 @@ public function next($shortName)
      * @throws InvalidArgumentException when the given name is blank or empty.
      * @throws \Yasumi\Exception\UnknownLocaleException
      * @throws \RuntimeException
+     * @throws \ReflectionException
      */
     private function anotherTime($year, $shortName)
     {
@@ -390,6 +392,7 @@ public function getHoliday($shortName)
      * @throws \Yasumi\Exception\UnknownLocaleException
      * @throws \RuntimeException
      * @throws \InvalidArgumentException
+     * @throws \ReflectionException
      *
      * @covers AbstractProvider::anotherTime
      */

diff --git a/src/Yasumi/Provider/Australia.php b/src/Yasumi/Provider/Australia.php
@@ -37,6 +37,7 @@ class Australia extends AbstractProvider
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {
@@ -69,6 +70,7 @@ public function initialize()
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function calculateAustraliaDay()
     {
@@ -88,6 +90,7 @@ public function calculateAustraliaDay()
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function calculateHoliday(
         $shortName,
@@ -120,6 +123,7 @@ public function calculateHoliday(
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function calculateNewYearHolidays()
     {
@@ -142,6 +146,7 @@ public function calculateNewYearHolidays()
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function calculateAnzacDay()
     {
@@ -164,6 +169,7 @@ public function calculateAnzacDay()
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function calculateChristmasDay()
     {
@@ -199,6 +205,7 @@ public function calculateChristmasDay()
      * @link https://www.timeanddate.com/holidays/australia/queens-birthday
      *
      * @throws \InvalidArgumentException
+     * @throws \Exception
      */
     public function calculateQueensBirthday()
     {

diff --git a/src/Yasumi/Provider/Australia/Victoria.php b/src/Yasumi/Provider/Australia/Victoria.php
@@ -34,6 +34,7 @@ class Victoria extends Australia
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {
@@ -45,6 +46,9 @@ public function initialize()
         $this->calculateAFLGrandFinalDay();
     }
 
+    /**
+     * @throws \Exception
+     */
     public function calculateChristmasDay()
     {
         $christmasDay = new DateTime("$this->year-12-25", new DateTimeZone($this->timezone));

diff --git a/src/Yasumi/Provider/Austria.php b/src/Yasumi/Provider/Austria.php
@@ -34,6 +34,7 @@ class Austria extends AbstractProvider
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/Belgium.php b/src/Yasumi/Provider/Belgium.php
@@ -34,6 +34,7 @@ class Belgium extends AbstractProvider
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/Brazil.php b/src/Yasumi/Provider/Brazil.php
@@ -35,6 +35,7 @@ class Brazil extends AbstractProvider
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/ChristianHolidays.php b/src/Yasumi/Provider/ChristianHolidays.php
@@ -69,6 +69,7 @@ public function easter($year, $timezone, $locale, $type = Holiday::TYPE_OFFICIAL
      *
      * @throws \Yasumi\Exception\UnknownLocaleException
      * @throws \InvalidArgumentException
+     * @throws \Exception
      */
     public function easterMonday($year, $timezone, $locale, $type = Holiday::TYPE_OFFICIAL)
     {
@@ -100,6 +101,7 @@ public function easterMonday($year, $timezone, $locale, $type = Holiday::TYPE_OF
      *
      * @throws \Yasumi\Exception\UnknownLocaleException
      * @throws \InvalidArgumentException
+     * @throws \Exception
      */
     public function ascensionDay($year, $timezone, $locale, $type = Holiday::TYPE_OFFICIAL)
     {
@@ -128,6 +130,7 @@ public function ascensionDay($year, $timezone, $locale, $type = Holiday::TYPE_OF
      *
      * @throws \Yasumi\Exception\UnknownLocaleException
      * @throws \InvalidArgumentException
+     * @throws \Exception
      */
     public function pentecost($year, $timezone, $locale, $type = Holiday::TYPE_OFFICIAL)
     {
@@ -156,6 +159,7 @@ public function pentecost($year, $timezone, $locale, $type = Holiday::TYPE_OFFIC
      *
      * @throws \Yasumi\Exception\UnknownLocaleException
      * @throws \InvalidArgumentException
+     * @throws \Exception
      */
     public function pentecostMonday($year, $timezone, $locale, $type = Holiday::TYPE_OFFICIAL)
     {
@@ -187,6 +191,7 @@ public function pentecostMonday($year, $timezone, $locale, $type = Holiday::TYPE
      *
      * @throws \Yasumi\Exception\UnknownLocaleException
      * @throws \InvalidArgumentException
+     * @throws \Exception
      */
     public function corpusChristi($year, $timezone, $locale, $type = Holiday::TYPE_OTHER)
     {
@@ -363,6 +368,7 @@ public function assumptionOfMary($year, $timezone, $locale, $type = Holiday::TYP
      *
      * @throws \Yasumi\Exception\UnknownLocaleException
      * @throws \InvalidArgumentException
+     * @throws \Exception
      */
     public function goodFriday($year, $timezone, $locale, $type = Holiday::TYPE_OFFICIAL)
     {
@@ -421,6 +427,7 @@ public function epiphany($year, $timezone, $locale, $type = Holiday::TYPE_OFFICI
      *
      * @throws \Yasumi\Exception\UnknownLocaleException
      * @throws \InvalidArgumentException
+     * @throws \Exception
      */
     public function ashWednesday($year, $timezone, $locale, $type = Holiday::TYPE_OFFICIAL)
     {
@@ -545,6 +552,7 @@ public function stJosephsDay($year, $timezone, $locale, $type = Holiday::TYPE_OF
      *
      * @throws \Yasumi\Exception\UnknownLocaleException
      * @throws \InvalidArgumentException
+     * @throws \Exception
      */
     public function maundyThursday($year, $timezone, $locale, $type = Holiday::TYPE_OFFICIAL)
     {
@@ -653,6 +661,7 @@ public function annunciation($year, $timezone, $locale, $type = Holiday::TYPE_OF
      *
      * @link http://php.net/manual/en/function.easter-date.php#83794
      * @link https://en.wikipedia.org/wiki/Computus#Adaptation_for_Western_Easter_of_Meeus.27_Julian_algorithm
+     * @throws \Exception
      */
     public function calculateOrthodoxEaster($year, $timezone)
     {
@@ -726,6 +735,7 @@ public function reformationDay($year, $timezone, $locale, $type = Holiday::TYPE_
      * @param string $timezone the timezone in which Easter is celebrated
      *
      * @return \DateTime date of Easter
+     * @throws \Exception
      */
     protected function calculateEaster($year, $timezone)
     {

diff --git a/src/Yasumi/Provider/Croatia.php b/src/Yasumi/Provider/Croatia.php
@@ -36,6 +36,7 @@ class Croatia extends AbstractProvider
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/CzechRepublic.php b/src/Yasumi/Provider/CzechRepublic.php
@@ -37,6 +37,7 @@ class CzechRepublic extends AbstractProvider
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/Denmark.php b/src/Yasumi/Provider/Denmark.php
@@ -35,6 +35,7 @@ class Denmark extends AbstractProvider
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {
@@ -71,6 +72,7 @@ public function initialize()
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function calculateGreatPrayerDay()
     {

diff --git a/src/Yasumi/Provider/Estonia.php b/src/Yasumi/Provider/Estonia.php
@@ -40,6 +40,7 @@ class Estonia extends AbstractProvider
      * Initialize holidays for Estonia.
      *
      * @throws \InvalidArgumentException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/Finland.php b/src/Yasumi/Provider/Finland.php
@@ -35,6 +35,7 @@ class Finland extends AbstractProvider
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {
@@ -119,6 +120,7 @@ public function calculateStJohnsDay()
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     private function calculateAllSaintsDay()
     {

diff --git a/src/Yasumi/Provider/France.php b/src/Yasumi/Provider/France.php
@@ -34,6 +34,7 @@ class France extends AbstractProvider
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/France/BasRhin.php b/src/Yasumi/Provider/France/BasRhin.php
@@ -39,6 +39,7 @@ class BasRhin extends France
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/France/HautRhin.php b/src/Yasumi/Provider/France/HautRhin.php
@@ -39,6 +39,7 @@ class HautRhin extends France
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/France/Moselle.php b/src/Yasumi/Provider/France/Moselle.php
@@ -40,6 +40,7 @@ class Moselle extends France
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/Germany.php b/src/Yasumi/Provider/Germany.php
@@ -34,6 +34,7 @@ class Germany extends AbstractProvider
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/Germany/BadenWurttemberg.php b/src/Yasumi/Provider/Germany/BadenWurttemberg.php
@@ -37,6 +37,7 @@ class BadenWurttemberg extends Germany
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/Germany/Bavaria.php b/src/Yasumi/Provider/Germany/Bavaria.php
@@ -38,6 +38,7 @@ class Bavaria extends Germany
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/Germany/Brandenburg.php b/src/Yasumi/Provider/Germany/Brandenburg.php
@@ -36,6 +36,7 @@ class Brandenburg extends Germany
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/Germany/Hesse.php b/src/Yasumi/Provider/Germany/Hesse.php
@@ -38,6 +38,7 @@ class Hesse extends Germany
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/Germany/MecklenburgWesternPomerania.php b/src/Yasumi/Provider/Germany/MecklenburgWesternPomerania.php
@@ -37,6 +37,7 @@ class MecklenburgWesternPomerania extends Germany
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/Germany/NorthRhineWestphalia.php b/src/Yasumi/Provider/Germany/NorthRhineWestphalia.php
@@ -38,6 +38,7 @@ class NorthRhineWestphalia extends Germany
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/Germany/RhinelandPalatinate.php b/src/Yasumi/Provider/Germany/RhinelandPalatinate.php
@@ -37,6 +37,7 @@ class RhinelandPalatinate extends Germany
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/Germany/Saarland.php b/src/Yasumi/Provider/Germany/Saarland.php
@@ -38,6 +38,7 @@ class Saarland extends Germany
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/Germany/Saxony.php b/src/Yasumi/Provider/Germany/Saxony.php
@@ -38,6 +38,7 @@ class Saxony extends Germany
      * Initialize holidays for Saxony (Germany).
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/Germany/SaxonyAnhalt.php b/src/Yasumi/Provider/Germany/SaxonyAnhalt.php
@@ -37,6 +37,7 @@ class SaxonyAnhalt extends Germany
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {

diff --git a/src/Yasumi/Provider/Germany/Thuringia.php b/src/Yasumi/Provider/Germany/Thuringia.php
@@ -37,6 +37,7 @@ class Thuringia extends Germany
      *
      * @throws \InvalidArgumentException
      * @throws \Yasumi\Exception\UnknownLocaleException
+     * @throws \Exception
      */
     public function initialize()
     {