rounding rules via admin screen, round begin when starting record (#1229)

2019-11-10 13:57:05 +01:00
parent fa1c79e15c
commit c6c4098759
47 changed files with 1100 additions and 185 deletions
--- a/src/Timesheet/RoundingService.php
+++ b/src/Timesheet/RoundingService.php
@@ -0,0 +1,147 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Timesheet;
+
+use App\Configuration\TimesheetConfiguration;
+use App\Entity\Timesheet;
+use App\Timesheet\Rounding\RoundingInterface;
+
+final class RoundingService
+{
+    /**
+     * @var array
+     */
+    private $rules;
+    /**
+     * @var array
+     */
+    private $rulesCache;
+    /**
+     * @var TimesheetConfiguration
+     */
+    private $configuration;
+    /**
+     * @var RoundingInterface[]
+     */
+    private $roundingModes;
+
+    /**
+     * @param TimesheetConfiguration $configuration
+     * @param RoundingInterface[] $roundingModes
+     * @param array $rules
+     */
+    public function __construct(TimesheetConfiguration $configuration, iterable $roundingModes, array $rules)
+    {
+        $this->configuration = $configuration;
+        $this->roundingModes = $roundingModes;
+        $this->rules = $rules;
+    }
+
+    private function getRoundingRules(): array
+    {
+        if (empty($this->rulesCache)) {
+            $this->rulesCache = $this->rules;
+            if (empty($this->rulesCache) || array_key_exists('default', $this->rulesCache)) {
+                $this->rulesCache['default']['days'] = $this->configuration->getDefaultRoundingDays();
+                $this->rulesCache['default']['begin'] = $this->configuration->getDefaultRoundingBegin();
+                $this->rulesCache['default']['end'] = $this->configuration->getDefaultRoundingEnd();
+                $this->rulesCache['default']['duration'] = $this->configuration->getDefaultRoundingDuration();
+                $this->rulesCache['default']['mode'] = $this->configuration->getDefaultRoundingMode();
+            }
+
+            // see AppExtension, conversion from string to array due to system configuration ont allowing to store arrays
+            foreach ($this->rulesCache as $key => $settings) {
+                $days = explode(',', $settings['days']);
+                $days = array_map('trim', $days);
+                $days = array_map('strtolower', $days);
+                $this->rulesCache[$key]['days'] = $days;
+            }
+        }
+
+        return $this->rulesCache;
+    }
+
+    public function roundBegin(Timesheet $record): void
+    {
+        foreach ($this->getRoundingRules() as $rounding) {
+            $weekday = $record->getBegin()->format('l');
+
+            if (in_array(strtolower($weekday), $rounding['days'])) {
+                $rounder = $this->getRoundingMode($rounding['mode']);
+                $rounder->roundBegin($record, $rounding['begin']);
+            }
+        }
+    }
+
+    public function roundEnd(Timesheet $record): void
+    {
+        foreach ($this->getRoundingRules() as $rounding) {
+            $weekday = $record->getEnd()->format('l');
+
+            if (in_array(strtolower($weekday), $rounding['days'])) {
+                $rounder = $this->getRoundingMode($rounding['mode']);
+                $rounder->roundEnd($record, $rounding['end']);
+            }
+        }
+    }
+
+    public function roundDuration(Timesheet $record): void
+    {
+        foreach ($this->getRoundingRules() as $rounding) {
+            $weekday = $record->getEnd()->format('l');
+
+            if (in_array(strtolower($weekday), $rounding['days'])) {
+                $rounder = $this->getRoundingMode($rounding['mode']);
+                $rounder->roundDuration($record, $rounding['duration']);
+            }
+        }
+    }
+
+    public function applyRoundings(Timesheet $record): void
+    {
+        if (null === $record->getEnd()) {
+            return;
+        }
+
+        foreach ($this->getRoundingRules() as $rounding) {
+            $weekday = $record->getEnd()->format('l');
+
+            if (in_array(strtolower($weekday), $rounding['days'])) {
+                $rounder = $this->getRoundingMode($rounding['mode']);
+                $rounder->roundBegin($record, $rounding['begin']);
+                $rounder->roundEnd($record, $rounding['end']);
+
+                $duration = $record->getEnd()->getTimestamp() - $record->getBegin()->getTimestamp();
+                $record->setDuration($duration);
+
+                $rounder->roundDuration($record, $rounding['duration']);
+            }
+        }
+    }
+
+    /**
+     * @return RoundingInterface[]
+     */
+    public function getRoundingModes(): iterable
+    {
+        return $this->roundingModes;
+    }
+
+    public function getRoundingMode(string $id): RoundingInterface
+    {
+        foreach ($this->roundingModes as $mode) {
+            if ($mode->getId() === $id) {
+                return $mode;
+            }
+        }
+
+        throw new \InvalidArgumentException('Unknown rounding mode: ' . $id);
+    }
+}