improve docblocks

This commit is contained in:
Dennis Eichhorn 2020-02-12 19:53:07 +01:00
parent 64a28428fd
commit 13a55f3400
3 changed files with 29 additions and 26 deletions

View File

@ -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;
}
/**

View File

@ -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;
}

View File

@ -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;
}