Die Modelle für die Ansichten wurden definiert, einschließlich der Tests.

2021-03-29 16:31:04 +02:00
parent b7b72d9044
commit e6b9180432
4 changed files with 240 additions and 1 deletions
@@ -0,0 +1,23 @@
+<?php /** @noinspection PhpUnusedPrivateFieldInspection */
+
+
+namespace TorstenHettstedt\TimekeepingApi\Models;
+
+use MyCLabs\Enum\Enum;
+
+/**
+ * Enum-Klasse für die unterstützten Periode-Definitionen.
+ * Der Wert der Periode ist ein Format-String für {@link https://secure.php.net/manual/en/datetime.format.php}.
+ *
+ * @extends Enum<string>
+ *
+ * @method static PeriodDesignationEnum WEEKLY()
+ * @method static PeriodDesignationEnum MONTHLY()
+ * @method static PeriodDesignationEnum YEARLY()
+ */
+class PeriodDesignationEnum extends Enum
+{
+    private const WEEKLY = 'Y#W';
+    private const MONTHLY = 'Y-m';
+    private const YEARLY = 'Y';
+}
@@ -0,0 +1,102 @@
+<?php
+
+
+namespace TorstenHettstedt\TimekeepingApi\Models;
+
+
+use DateInterval;
+use DateTimeInterface;
+use JetBrains\PhpStorm\ArrayShape;
+
+class WorkingHoursView implements ModelInterface
+{
+    protected DateTimeInterface $period;
+    protected PeriodDesignationEnum $periodDesignation;
+    protected int $workingDays;
+    protected DateInterval $totalHours;
+    protected DateInterval $overtime;
+
+    /**
+     * WorkingHoursView constructor.
+     *
+     * @param DateTimeInterface     $period
+     * @param PeriodDesignationEnum $periodDesignation
+     * @param int                   $workingDays
+     * @param DateInterval          $totalHours
+     * @param DateInterval          $overtime
+     */
+    public function __construct(
+        DateTimeInterface $period,
+        PeriodDesignationEnum $periodDesignation,
+        int $workingDays,
+        DateInterval $totalHours,
+        DateInterval $overtime
+    ) {
+        $this->period = $period;
+        $this->periodDesignation = $periodDesignation;
+        $this->workingDays = $workingDays;
+        $this->totalHours = $totalHours;
+        $this->overtime = $overtime;
+    }
+
+    /**
+     * @return DateTimeInterface
+     */
+    public function getPeriod(): DateTimeInterface
+    {
+        return $this->period;
+    }
+
+    /**
+     * @return PeriodDesignationEnum
+     */
+    public function getPeriodDesignation(): PeriodDesignationEnum
+    {
+        return $this->periodDesignation;
+    }
+
+    /**
+     * @return int
+     */
+    public function getWorkingDays(): int
+    {
+        return $this->workingDays;
+    }
+
+    /**
+     * @return DateInterval
+     */
+    public function getTotalHours(): DateInterval
+    {
+        return $this->totalHours;
+    }
+
+    /**
+     * @return DateInterval
+     */
+    public function getOvertime(): DateInterval
+    {
+        return $this->overtime;
+    }
+
+    /**
+     * @inheritDoc
+     *
+     * @return array<string, mixed>
+     */
+    #[ArrayShape(['period'            => "string",
+                  'periodDesignation' => "string",
+                  'totalHours'        => "string",
+                  'workingDays'       => "int",
+                  'overtime'          => "string"
+    ])] public function jsonSerialize(): array
+    {
+        return [
+            'period'            => $this->getPeriod()->format($this->getPeriodDesignation()->getValue()),
+            'periodDesignation' => strtolower($this->getPeriodDesignation()->getKey()),
+            'workingDays'       => $this->getWorkingDays(),
+            'totalHours'        => $this->getTotalHours()->format('%H:%I:%S'),
+            'overtime'          => $this->getOvertime()->format('%H:%I:%S')
+        ];
+    }
+}