HDNET\Calendarize\Utility\DateTimeUtility

Complexity

Total Complexity

20

Size/Duplication

Total Lines	234
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

21.62%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	convertWeekYear2DayMonthYear()	0	6	1
A	getTimeZone()	0	4	1
A	getDaySecondsOfDateTime()	0	7	1
B	normalizeDateTime()	0	22	6
A	normalizeQuarter()	0	8	2
A	getQuartar()	0	6	1
A	resetTime()	0	7	1
A	normalizeDateTimeSingle()	0	16	4
A	getNow()	0	6	1
A	getDayStart()	0	4	1
A	getDayEnd()	0	7	1

<?php

/**
 * DateTime Utility.
 */
declare(strict_types=1);

namespace HDNET\Calendarize\Utility;

use TYPO3\CMS\Core\Utility\MathUtility;

/**
 * DateTime Utility.
 */
class DateTimeUtility
{
    /**
     * One second.
     */
    const SECONDS_SECOND = 1;

    /**
     * One minute in seconds.
     */
    const SECONDS_MINUTE = 60;

    /**
     * One hour in seconds.
     */
    const SECONDS_HOUR = 3600;

    /**
     * One day in seconds.
     */
    const SECONDS_DAY = 86400;

    /**
     * One week in seconds.
     */
    const SECONDS_WEEK = 604800;

    /**
     * One quartar in seconds (90 days).
     */
    const SECONDS_QUARTER = 7776000;

    /**
     * One year in seconds (365 days).
     */
    const SECONDS_YEAR = 31536000;

    /**
     * One decade in seconds (base on a 365 days year).
     */
    const SECONDS_DECADE = 315360000;

    /**
     * Format date (Backend).
     */
    const FORMAT_DATE_BACKEND = '%a %d.%m.%Y';

    /**
     * Convert a Week/Year combination to a DateTime of the first day of week.
     *
     * @param int $week
     * @param int $year
     * @param int $startDay
     *
     * @return \DateTime
     */
    public static function convertWeekYear2DayMonthYear($week, $year, $startDay = 1): \DateTime
    {
        $week = \str_pad((string) $week, 2, '0', STR_PAD_LEFT);

        return self::normalizeDateTimeSingle(\strtotime($year . '-W' . $week . '-' . $startDay));
    }

    /**
     * Time zone is set by the TYPO3 core.
     *
     * @return \DateTimeZone
     *
     * @see \TYPO3\CMS\Core\Core\Bootstrap->setDefaultTimezone()
     */
    public static function getTimeZone()
    {
        return new \DateTimeZone(\date_default_timezone_get());
    }

    /**
     * Get the time seconds of the given date (TYPO3 Backend style).
     *
     * @param \DateTime $dateTime
     *
     * @return int
     */
    public static function getDaySecondsOfDateTime(\DateTime $dateTime): int
    {
        $hours = (int) $dateTime->format('G');
        $minutes = $hours * self::SECONDS_MINUTE + (int) $dateTime->format('i');

        return $minutes * self::SECONDS_MINUTE + (int) $dateTime->format('s');
    }

    /**
     * Get a normalize date time object.
     *
     * @param int|null $day
     * @param int|null $month
     * @param int|null $year
     *
     * @return \DateTime
     */
    public static function normalizeDateTime($day = null, $month = null, $year = null): \DateTime
    {
        $date = self::getNow();
        if (!MathUtility::canBeInterpretedAsInteger($year)) {
            $year = $date->format('Y');
        }
        if (!MathUtility::canBeInterpretedAsInteger($month)) {
            $month = $date->format('m');
        }
        if (!MathUtility::canBeInterpretedAsInteger($day)) {
            $day = $date->format('d');
        }
        $date->setDate((int) $year, (int) $month, (int) $day);
        $date->setTime(0, 0, 0);
        if ($date->format('m') > $month) {
            $date->modify('last day of last month');
        } elseif ($date->format('m') < $month) {
            $date->modify('first day of next month');
        }

        return $date;
    }

    /**
     * Normalize quartar.
     *
     * @param int|null $quarter
     *
     * @return int
     */
    public static function normalizeQuarter(int $quarter = null): int
    {
        if (null === $quarter) {
            $quarter = self::getQuartar(self::getNow());
        }

        return MathUtility::forceIntegerInRange((int) $quarter, 1, 4);
    }

    /**
     * Normalize quartar.
     *
     * @param int|null $quarter

There is no parameter named $quarter. Was it maybe removed?

     *
     * @return int
     */
    public static function getQuartar(\DateTimeInterface $date): int
    {
        $month = (int) $date->format('n');

        return (int) \ceil($month / 3);
    }

    /**
     * Reset the DateTime.
     *
     * @param \DateTime $dateTime
     *
     * @return \DateTime
     */
    public static function resetTime($dateTime = null): \DateTime
    {
        $dateTime = self::normalizeDateTimeSingle($dateTime);
        $dateTime->setTime(0, 0, 0);

        return $dateTime;
    }

    /**
     * Get a normalized date time object. The timezone of the returned object is
     * UTC for integer parameters and server timezone for everything else.
     *
     * @param int|string|\DateTime|null $dateInformation
     *
     * @return \DateTime
     */
    public static function normalizeDateTimeSingle($dateInformation): \DateTime
    {
        if ($dateInformation instanceof \DateTimeInterface) {
            return $dateInformation;
        }
        if (MathUtility::canBeInterpretedAsInteger($dateInformation)) {
            // http://php.net/manual/en/datetime.construct#refsect1-datetime.construct-parameters :
            // The $timezone parameter and the current timezone are ignored [ie. set to UTC] when the $time parameter [...] is a UNIX timestamp (e.g. @946684800) [...]
            return new \DateTime("@$dateInformation");
        }
        if (\is_string($dateInformation)) {
            return new \DateTime($dateInformation);
        }

        return self::getNow();
    }

    /**
     * Get the current date (normalized optimized for queries, because SIM_ACCESS_TIME is rounded to minutes)
     * in the current timezone.
     *
     * @return \DateTime
     */
    public static function getNow(): \DateTime
    {
        // NOTE that new \DateTime('@timestamp') does NOT work - @see comment in normalizeDateTimeSingle()
        // So we create a date string with timezone information first, and a \DateTime in the current server timezone then.
        return new \DateTime(\date(\DateTime::ATOM, (int) $GLOBALS['SIM_ACCESS_TIME']));
    }

    /**
     * Alias for resetTime.
     *
     * @see resetTime()
     *
     * @param int|string|\DateTime|null $dateInformation
     *
     * @return \DateTime
     */
    public static function getDayStart($dateInformation): \DateTime
    {
        return self::resetTime($dateInformation);
    }

    /**
     * Get the End of the given day.
     *
     * @param int|string|\DateTime|null $dateInformation
     *
     * @return \DateTime
     */
    public static function getDayEnd($dateInformation): \DateTime
    {
        $dateTime = self::getDayStart($dateInformation);
        $dateTime->setTime(23, 59, 59);

        return $dateTime;
    }
}