thuecat/Classes/Domain/Model/Frontend/OpeningHour.php

<?php

declare(strict_types=1);

/*
 * Copyright (C) 2021 Daniel Siepmann <coding@daniel-siepmann.de>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

namespace WerkraumMedia\ThueCat\Domain\Model\Frontend;

class OpeningHour
{
    /**
     * @var string
     */
    private $opens;

    /**
     * @var string
     */
    private $closes;

    /**
     * @var mixed[]
     */
    private $daysOfWeek;

    /**
     * @var \DateTimeImmutable|null
     */
    private $from;

    /**
     * @var \DateTimeImmutable|null
     */
    private $through;

    private function __construct(
        string $opens,
        string $closes,
        array $daysOfWeek,
        ?\DateTimeImmutable $from,
        ?\DateTimeImmutable $through
    ) {
        $this->opens = $opens;
        $this->closes = $closes;
        $this->daysOfWeek = $daysOfWeek;
        $this->from = $from;
        $this->through = $through;
    }

    /**
     * @return OpeningHour
     */
    public static function createFromArray(array $rawData)
    {
        $from = null;
        if (isset($rawData['from'])) {
            $timeZone = new \DateTimeZone($rawData['from']['timezone'] ?? 'Europe/Berlin');
            $from = new \DateTimeImmutable($rawData['from']['date'], $timeZone);
        }
        $through = null;
        if (isset($rawData['through'])) {
            $timeZone = new \DateTimeZone($rawData['through']['timezone'] ?? 'Europe/Berlin');
            $through = new \DateTimeImmutable($rawData['through']['date'], $timeZone);
        }

        return new self(
            $rawData['opens'] ?? '',
            $rawData['closes'] ?? '',
            $rawData['daysOfWeek'] ?? [],
            $from,
            $through
        );
    }

    public function getOpens(): string
    {
        return $this->formatTiming($this->opens);
    }

    public function getCloses(): string
    {
        return $this->formatTiming($this->closes);
    }

    public function getDaysOfWeek(): array
    {
        return $this->daysOfWeek;
    }

    public function getDaysOfWeekWithMondayFirstWeekDay(): array
    {
        return $this->sortedDaysOfWeek([
            'Monday',
            'Tuesday',
            'Wednesday',
            'Thursday',
            'Friday',
            'Saturday',
            'Sunday',
            'PublicHolidays',
        ]);
    }

    public function getFrom(): ?\DateTimeImmutable
    {
        return $this->from;
    }

    public function getThrough(): ?\DateTimeImmutable
    {
        return $this->through;
    }

    public function isSingleDay(): bool
    {
        $from = $this->getFrom();
        $through = $this->getThrough();

        return $from instanceof \DateTimeImmutable
            && $through instanceof \DateTimeImmutable
            && $from->format('Ymd') === $through->format('Ymd')
        ;
    }

    private function sortedDaysOfWeek(array $sorting): array
    {
        if ($this->daysOfWeek === []) {
            return [];
        }

        $days = [];

        foreach ($sorting as $weekDay) {
            $position = array_search($weekDay, $this->daysOfWeek);
            if ($position === false) {
                continue;
            }

            $days[] = $this->daysOfWeek[$position];
        }

        return $days;
    }

    /**
     * Returns timing in default format.
     *
     * @return string
     */
    private function formatTiming(string $timing): string
    {
        $parts = $this->getTimingParts($timing);

        if ($parts['hour'] === '' || $parts['minutes'] === '') {
            return '';
        }

        return $parts['hour'] . ':' . $parts['minutes'];
    }

    /**
     * Converts the string representationg of a time HH:MM:SS into an array.
     *
     * @return string[]
     */
    private function getTimingParts(string $string): array
    {
        $parts = explode(':', $string);
        return [
            'hour' => $parts[0] ?? '',
            'minutes' => $parts[1] ?? '',
            'seconds' => $parts[2] ?? '',
        ];
    }
}