Take advantage of new PHP 8 features

kmdwebdesigns · Oct 11, 2021 · 2f14032 · 2f14032
1 parent 87d54cd
commit 2f14032
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 80 deletions.
diff --git a/.php-cs-fixer.cache b/.php-cs-fixer.cache
diff --git a/src/AbstractCarbonWrapper.php b/src/AbstractCarbonWrapper.php
@@ -2,15 +2,14 @@
 
 namespace Calendar;
 
+use Carbon\CarbonImmutable;
+
 /**
  * @mixin \Carbon\CarbonImmutable
  */
 abstract class AbstractCarbonWrapper
 {
-    /**
-     * @var \Carbon\CarbonImmutable
-     */
-    protected $carbon;
+    protected CarbonImmutable $carbon;
 
     /**
      * Attempts to query Carbon for the property

diff --git a/src/Calendar.php b/src/Calendar.php
@@ -4,7 +4,6 @@
 
 use Carbon\CarbonInterface;
 use DateTimeZone;
-use InvalidArgumentException;
 
 class Calendar
 {
@@ -14,32 +13,17 @@ class Calendar
      */
     public const WEEKS_IN_MONTH = 6;
 
-    /**
-     * @var int
-     */
-    private $month;
+    private int $month;
 
-    /**
-     * @var int
-     */
-    private $year;
+    private int $year;
 
-    /**
-     * @var \DateTimeZone
-     */
-    private $timezone;
+    private DateTimeZone $timezone;
 
-    /**
-     * @var int
-     */
-    private $weekStart = CarbonInterface::MONDAY;
+    private int $weekStart = CarbonInterface::MONDAY;
 
-    /**
-     * @var bool
-     */
-    private $variableWeeks = false;
+    private bool $variableWeeks = false;
 
-    public function __construct(int $year, int $month, $timezone = 'UTC')
+    public function __construct(int $year, int $month, DateTimeZone|string $timezone = 'UTC')
     {
         $this->setYear($year);
         $this->setMonth($month);
@@ -66,17 +50,8 @@ public function getYear(): int
         return $this->year;
     }
 
-    /**
-     * @param  \DateTimeZone|string $timezone
-     *
-     * @throws \InvalidArgumentException
-     */
-    public function setTimezone($timezone): void
+    public function setTimezone(DateTimeZone|string $timezone): void
     {
-        if (! ($timezone instanceof DateTimeZone || is_string($timezone))) {
-            throw new InvalidArgumentException('setTimezone requires a DateTimeZone instance or a timezone string');
-        }
-
         $this->timezone = $timezone instanceof DateTimeZone ? $timezone : new DateTimeZone($timezone);
     }
 
@@ -135,7 +110,6 @@ public function getWeeks(): array
         $firstDay = $this->getFirstDay();
         $lastDay = $this->getLastDay();
         $numberOfWeeks = $this->isVariableWeeks() ? $this->getWeekCount($firstDay) : self::WEEKS_IN_MONTH;
-        /** @var \Calendar\Day $day */
         $day = clone $firstDay;
 
         $weeks = [];

diff --git a/src/Day.php b/src/Day.php
@@ -7,22 +7,13 @@
 
 class Day extends AbstractCarbonWrapper
 {
-    /**
-     * @var bool
-     */
-    private $blankDay = false;
+    private bool $blankDay = false;
 
-    /**
-     * @param  int $year
-     * @param  int $month
-     * @param  int $day
-     * @param  \DateTimeZone|string $timezone
-     */
-    public function __construct(int $year, int $month, int $day, $timezone = 'UTC')
+    public function __construct(int $year, int $month, int $day, DateTimeZone|string $timezone = 'UTC')
     {
         $hour = 5;
 
-        if (($timezone instanceof DateTimeZone && $timezone->getName() === 'UTC') || $timezone === 'UTC') {
+        if ($timezone === 'UTC' || ($timezone instanceof DateTimeZone && $timezone->getName() === 'UTC')) {
             $hour = 0;
         }
 
@@ -35,9 +26,8 @@ public function setBlankDay(bool $value): void
     }
 
     /**
-     * A "blank" day refers to days that appear
-     * on the current months calendar but are physically part of the
-     * previous or next months
+     * A "blank" day refers to days that appear on the current month's calendar
+     * but are physically part of the previous or next months
      */
     public function isBlankDay(): bool
     {

diff --git a/src/Week.php b/src/Week.php
@@ -6,27 +6,15 @@
 
 class Week
 {
-    /**
-     * @var \Calendar\Day
-     */
-    private $dateStart;
+    private Day $dateStart;
 
-    /**
-     * @var int
-     */
-    private $currentMonth;
+    private int $currentMonth;
 
-    /**
-     * @var int
-     */
-    private $weekStart = CarbonInterface::MONDAY;
+    private int $weekStart = CarbonInterface::MONDAY;
 
-    /**
-     * @var array
-     */
-    private $days = [];
+    private array $days = [];
 
-    public function __construct(Day $dateStart, int $currentMonth = null, int $weekStart = CarbonInterface::MONDAY)
+    public function __construct(Day $dateStart, ?int $currentMonth = null, int $weekStart = CarbonInterface::MONDAY)
     {
         $this->setWeekStart($weekStart);
         $this->setStartDate($dateStart);
@@ -47,7 +35,7 @@ public function getStartDate(): Day
         return $this->dateStart;
     }
 
-    private function setCurrentMonth(int $currentMonth = null): void
+    private function setCurrentMonth(?int $currentMonth = null): void
     {
         $this->currentMonth = $currentMonth ?? $this->dateStart->month;
     }
@@ -83,8 +71,6 @@ private function generateWeek(): void
     /**
      * Adds a day to the days property
      * Goes through a check first
-     *
-     * @param  \Calendar\Day $day
      */
     private function addDay(Day $day): void
     {
@@ -94,20 +80,15 @@ private function addDay(Day $day): void
     }
 
     /**
-     * @return \Calendar\Day[]
+     * @return array<\Calendar\Day>
      */
     public function getDays(): array
     {
         return $this->days;
     }
 
     /**
-     * Determines whether a day is part of the currently
-     * selected month or not
-     *
-     * @param  \Calendar\Day $day
-     *
-     * @return bool
+     * Determines whether a day is part of the currently selected month or not
      */
     public function currentMonthDay(Day $day): bool
     {