kimai2/src/Timesheet/DateTimeFactory.php

<?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\Entity\User;
use DateTime;
use DateTimeInterface;
use DateTimeZone;

final class DateTimeFactory
{
    private DateTimeZone $timezone;
    private bool $startOnSunday = false;

    public static function createByUser(User $user): self
    {
        return new DateTimeFactory(new \DateTimeZone($user->getTimezone()), $user->isFirstDayOfWeekSunday());
    }

    public function __construct(?DateTimeZone $timezone = null, bool $startOnSunday = false)
    {
        if (null === $timezone) {
            $timezone = new \DateTimeZone(date_default_timezone_get());
        }
        $this->timezone = $timezone;
        $this->startOnSunday = $startOnSunday;
    }

    public function getTimezone(): DateTimeZone
    {
        return $this->timezone;
    }

    public function getStartOfMonth(DateTimeInterface|string|null $date = null): DateTime
    {
        $date = $this->getDate($date);

        $date = $date->modify('first day of this month');
        $date = $date->setTime(0, 0, 0);

        return $date;
    }

    /**
     * @deprecated
     * @codeCoverageIgnore
     */
    public function getStartOfLastMonth(): DateTimeInterface
    {
        @trigger_error('The method "DateTimeFactory::getStartOfLastMonth()" will be removed soon', E_USER_DEPRECATED);

        $date = $this->createDateTime('first day of -1 month');
        $date = $date->setTime(0, 0, 0);

        return $date;
    }

    private function getDate(DateTimeInterface|string|null $date = null): DateTime
    {
        if ($date === null) {
            $date = 'now';
        }

        if (\is_string($date)) {
            return $this->createDateTime($date);
        }

        return $this->createDateTime($date->format('Y-m-d H:i:s'));
    }

    /**
     * @deprecated
     * @codeCoverageIgnore
     */
    private function createDate(DateTimeInterface|string|null $date = null): \DateTimeImmutable
    {
        if ($date === null) {
            $date = 'now';
        }

        if (\is_string($date)) {
            return $this->create($date);
        }

        return $this->create($date->format('Y-m-d H:i:s'));
    }

    public function getStartOfWeek(DateTimeInterface|string|null $date = null): DateTime
    {
        $date = $this->getDate($date);
        $firstDay = 1;

        if ($this->startOnSunday) {
            $firstDay = 7;

            // if today = sunday => increase week by one
            if ($date->format('N') !== '7') {
                $date = $date->modify('-1 week');
            }
        }

        return $this->createWeekDateTime((int) $date->format('o'), (int) $date->format('W'), $firstDay, 0, 0, 0);
    }

    public function getEndOfWeek(DateTimeInterface|string|null $date = null): DateTime
    {
        $date = $this->getDate($date);
        $lastDay = 7;

        if ($this->startOnSunday) {
            $lastDay = 6;

            // only change when today is not sunday
            if ($date->format('N') === '7') {
                $date = $date->modify('+1 week');
            }
        }

        return $this->createWeekDateTime((int) $date->format('o'), (int) $date->format('W'), $lastDay, 23, 59, 59);
    }

    public function getEndOfMonth(DateTimeInterface|string|null $date = null): DateTime
    {
        $date = $this->getDate($date);
        $date = $date->modify('last day of this month');
        $date = $date->setTime(23, 59, 59);

        return $date;
    }

    /**
     * @deprecated
     * @codeCoverageIgnore
     */
    public function getEndOfLastMonth(): DateTimeInterface
    {
        @trigger_error('The method "DateTimeFactory::getEndOfLastMonth()" will be removed soon', E_USER_DEPRECATED);

        $date = $this->createDateTime('last day of -1 month');
        $date = $date->setTime(23, 59, 59);

        return $date;
    }

    private function createWeekDateTime(int $year, int $week, int $day, int $hour, int $minute, int $second): DateTime
    {
        $date = new DateTime('now', $this->getTimezone());
        $date = $date->setISODate($year, $week, $day);
        $date = $date->setTime($hour, $minute, $second);

        return $date;
    }

    public function createDateTime(string $datetime = 'now'): DateTime
    {
        return new DateTime($datetime, $this->getTimezone());
    }

    public function create(string $datetime = 'now'): \DateTimeImmutable
    {
        return new \DateTimeImmutable($datetime, $this->getTimezone());
    }

    /**
     * @deprecated
     * @codeCoverageIgnore
     */
    public function createStartOfDay(DateTimeInterface|string|null $date = null): \DateTimeImmutable
    {
        @trigger_error('The method "DateTimeFactory::createStartOfDay()" will be removed soon', E_USER_DEPRECATED);

        $date = $this->createDate($date);

        return $date->modify('00:00:00');
    }

    /**
     * @deprecated
     * @codeCoverageIgnore
     */
    public function createEndOfDay(DateTimeInterface|string|null $date = null): \DateTimeImmutable
    {
        @trigger_error('The method "DateTimeFactory::createEndOfDay()" will be removed soon', E_USER_DEPRECATED);

        $date = $this->createDate($date);

        return $date->modify('23:59:59');
    }

    public function createDateTimeFromFormat(string $format, ?string $datetime = 'now'): false|DateTime
    {
        return DateTime::createFromFormat($format, $datetime ?? 'now', $this->getTimezone());
    }

    public function createStartOfYear(DateTimeInterface|string|null $date = null): DateTime
    {
        $date = $this->getDate($date);

        return $date->modify('first day of january 00:00:00');
    }

    public function createEndOfYear(DateTimeInterface|string|null $date = null): DateTime
    {
        $date = $this->getDate($date);

        return $date->modify('last day of december 23:59:59');
    }

    public function createStartOfFinancialYear(?string $financialYear = null): DateTimeInterface
    {
        $defaultDate = $this->createDateTime('01 january this year 00:00:00');

        if (null === $financialYear) {
            return $defaultDate;
        }

        $financialYear = $this->createDateTime($financialYear);
        $financialYear = $financialYear->setDate((int) $defaultDate->format('Y'), (int) $financialYear->format('m'), (int) $financialYear->format('d'));
        $financialYear = $financialYear->setTime(0, 0, 0);

        $today = $this->createDateTime('00:00:00');

        if ($financialYear > $today) {
            $financialYear = $financialYear->modify('-1 year');
        }

        return $financialYear;
    }

    public function createEndOfFinancialYear(DateTimeInterface $financialYear): DateTimeInterface
    {
        $yearEnd = DateTime::createFromInterface($financialYear);
        $yearEnd = $yearEnd->modify('+1 year')->modify('-1 day')->setTime(23, 59, 59);

        return $yearEnd;
    }
}