From 13a55f3400f1b8ff2753fc612409678dae8371ff Mon Sep 17 00:00:00 2001
From: Dennis Eichhorn <spl1nes.com@googlemail.com>
Date: Wed, 12 Feb 2020 19:53:07 +0100
Subject: [PATCH] improve docblocks

---
 Models/Calendar.php | 10 +++++-----
 Models/Event.php    | 25 ++++++++++++++-----------
 Models/Schedule.php | 20 ++++++++++----------
 3 files changed, 29 insertions(+), 26 deletions(-)

diff --git a/Models/Calendar.php b/Models/Calendar.php
index 74d5d90..f0c2a8b 100644
--- a/Models/Calendar.php
+++ b/Models/Calendar.php
@@ -53,18 +53,18 @@ class Calendar
     /**
      * Created at.
      *
-     * @var null|\DateTime
+     * @var \DateTime
      * @since 1.0.0
      */
-    private ?\DateTime $createdAt = null;
+    private \DateTime $createdAt;
 
     /**
      * Current date of the calendar.
      *
-     * @var null|\DateTime
+     * @var \DateTime
      * @since 1.0.0
      */
-    private ?\DateTime $date = null;
+    private \DateTime $date;
 
     /**
      * Events.
@@ -152,7 +152,7 @@ class Calendar
         $key = \key($this->events);
         \reset($this->events);
 
-        return $key;
+        return $key ?? 0;
     }
 
     /**
diff --git a/Models/Event.php b/Models/Event.php
index bbe3a13..eac70f3 100644
--- a/Models/Event.php
+++ b/Models/Event.php
@@ -55,15 +55,15 @@ class Event
     /**
      * Created.
      *
-     * @var null|\DateTime
+     * @var \DateTime
      * @since 1.0.0
      */
-    private ?\DateTime $createdAt = null;
+    private \DateTime $createdAt;
 
     /**
      * Creator.
      *
-     * @var int
+     * @var int|\Modules\Admin\Models\Account
      * @since 1.0.0
      */
     private $createdBy = 0;
@@ -91,10 +91,10 @@ class Event
     /**
      * Schedule
      *
-     * @var null|int|Schedule
+     * @var int|Schedule
      * @since 1.0.0
      */
-    private $schedule = null;
+    private $schedule;
 
     /**
      * Location of the event.
@@ -102,7 +102,7 @@ class Event
      * @var Location
      * @since 1.0.0
      */
-    private ?Location $location = null;
+    private Location $location;
 
     /**
      * Calendar
@@ -247,11 +247,11 @@ class Event
     }
 
     /**
-     * @return int
+     * @return int|\Modules\Admin\Models\Account
      *
      * @since 1.0.0
      */
-    public function getCreatedBy() : int
+    public function getCreatedBy()
     {
         return $this->createdBy;
     }
@@ -268,7 +268,10 @@ class Event
     public function setCreatedBy(int $createdBy) : void
     {
         $this->createdBy = $createdBy;
-        $this->schedule->setCreatedBy($this->createdBy);
+
+        if ($this->schedule instanceof Schedule) {
+            $this->schedule->setCreatedBy($this->createdBy);
+        }
     }
 
     /**
@@ -336,11 +339,11 @@ class Event
     }
 
     /**
-     * @return Schedule
+     * @return int|Schedule
      *
      * @since 1.0.0
      */
-    public function getSchedule() : Schedule
+    public function getSchedule()
     {
         return $this->schedule;
     }
diff --git a/Models/Schedule.php b/Models/Schedule.php
index b29175b..3ac591b 100644
--- a/Models/Schedule.php
+++ b/Models/Schedule.php
@@ -93,10 +93,10 @@ class Schedule
     /**
      * Start.
      *
-     * @var null|\DateTime
+     * @var \DateTime
      * @since 1.0.0
      */
-    private ?\DateTime $start = null;
+    private \DateTime $start;
 
     /**
      * Duration.
@@ -109,23 +109,23 @@ class Schedule
     /**
      * End.
      *
-     * @var null|\DateTime
+     * @var \DateTime
      * @since 1.0.0
      */
-    private ?\DateTime $end = null;
+    private \DateTime $end;
 
     /**
      * Created at.
      *
-     * @var null|\DateTime
+     * @var \DateTime
      * @since 1.0.0
      */
-    private ?\DateTime $createdAt = null;
+    private \DateTime $createdAt;
 
     /**
      * Created by.
      *
-     * @var int
+     * @var int|\Modules\Admin\Models\Account
      * @since 1.0.0
      */
     private $createdBy = 0;
@@ -361,7 +361,7 @@ class Schedule
     public function setDuration(int $duration)
     {
         if ($duration < 1) {
-            throw new \InvalidArgumentException($duration);
+            throw new \InvalidArgumentException((string) $duration);
         }
 
         $this->duration = $duration;
@@ -408,11 +408,11 @@ class Schedule
     }
 
     /**
-     * @return int
+     * @return int|\Modules\Admin\Models\Account
      *
      * @since 1.0.0
      */
-    public function getCreatedBy() : int
+    public function getCreatedBy()
     {
         return $this->createdBy;
     }