JhFlexiTime\Service\PeriodService

Complexity

Total Complexity

22

Size/Duplication

Total Lines	244
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getTotalHoursInPeriod()	0	14	3
A	getTotalHoursBetweenDates()	0	9	1
A	getTotalHoursInMonth()	0	9	1
A	calculateHourDiff()	0	14	2
A	getRemainingHoursInMonth()	0	11	1
A	getDaysInWeek()	0	15	4
A	getFirstAndLastDayOfWeek()	0	9	1
A	getNumWorkingDaysInWeek()	0	6	1
A	removeNonWorkingDays()	0	9	1
B	getWeeksInMonth()	0	35	5
A	isDateAfterDay()	0	6	1

<?php

namespace JhFlexiTime\Service;

use JhFlexiTime\Options\ModuleOptions;
use JhFlexiTime\DateTime\DateTime;

/**
 * Calculate hours in various periods
 *
 * Class PeriodService
 * @package JhFlexiTime\Service
 * @author Aydin Hassan <aydin@wearejh.com>
 */
class PeriodService implements PeriodServiceInterface
{

    /**
     * @var \JhFlexiTime\Options\ModuleOptions
     */
    protected $options;

    /**
     * @param ModuleOptions $options
     */
    public function __construct(ModuleOptions $options)
    {
        $this->options = $options;
    }

    /**
     * Get total hours in period, using config
     * to determine how many hours to count in each day
     * exclude weekends
     *
     * @param \DatePeriod $period
     * @return int
     */
    protected function getTotalHoursInPeriod(\DatePeriod $period)
    {
        $count = 0;
        foreach ($period as $day) {
            //exclude weekends
            if ($day->format('N') < 6) {
                $count++;
            }
        }

        $monthTotalHours = $count * $this->options->getHoursInDay();
        //round to 2 decimal places
        return (float) number_format($monthTotalHours, 2, '.', '');
    }

    /**
     * @param DateTime $start
     * @param DateTime $end
     *
     * @return int
     */
    public function getTotalHoursBetweenDates(DateTime $start, DateTime $end)
    {
        $period = new \DatePeriod(
            new DateTime(sprintf('%s 00:00:00', $start->format('d-m-Y'))),
            new \DateInterval('P1D'),
            new DateTime(sprintf('%s 23:59:59', $end->format('d-m-Y')))
        );
        return $this->getTotalHoursInPeriod($period);
    }

    /**
     * Get total hours in a given month
     *
     * @param DateTime $month
     * @return float
     */
    public function getTotalHoursInMonth(DateTime $month)
    {
        $period = new \DatePeriod(
            new DateTime(sprintf('first day of %s 00:00:00', $month->format('F Y'))),
            new \DateInterval('P1D'),
            new DateTime(sprintf('last day of %s 23:59:59', $month->format('F Y')))
        );
        return $this->getTotalHoursInPeriod($period);
    }

    /**
     * Calculate the hours between to dates
     * return something like 7.5, 8.25
     *
     * Minus the lunch duration from the total,
     * so only return total working hours
     *
     * @param DateTime $start
     * @param DateTime $end
     * @throws \InvalidArgumentException
     * @return float hour diff
     */
    public function calculateHourDiff(DateTime $start, DateTime $end)
    {
        if ($end <= $start) {
            throw new \InvalidArgumentException("End time should be after start time");
        }

        $lunchDuration  = $this->options->getLunchDuration();
        $diff           = $start->diff($end);
        $hours          = $diff->format('%r%h');
        $minutes        = $diff->format('%i') / 60;
        $totalHours     = ($hours + $minutes) - $lunchDuration;
        //round to 2 decimal places
        return number_format($totalHours, 2, '.', '');
    }

    /**
     * Get the remaining hours in a month
     * using the config as a base for how many hours
     * should be worked per day
     *
     * @param DateTime $today
     * @return int
     */
    public function getRemainingHoursInMonth(DateTime $today)
    {
        $date       = clone $today;
        $lastDay    = clone $today;
        $date->modify("+1 day");
        $lastDay->modify('last day of this month');
        $lastDay->modify("+1 day"); //hack to include the last day in the period

        $period = new \DatePeriod($date, new \DateInterval('P1D'), $lastDay);
        return $this->getTotalHoursInPeriod($period);
    }

    /**
     * Get an array of all the dates of the week the given date
     * is in
     *
     * @param DateTime $date
     * @return DateTime[]
     * @throws \Exception
     */
    public function getDaysInWeek(DateTime $date)
    {
        $weeks = $this->getWeeksInMonth($date);

        foreach ($weeks as $week) {
            $firstDayOfWeek = reset($week);
            $lastDayOfWeek  = end($week);

            if ($date >= $firstDayOfWeek && $date <= $lastDayOfWeek) {
                return $week;
            }
        }

        throw new \Exception("Day is not present in returned month");
    }

    /**
     * Get an array of the first and last day of
     * the week the given day is in
     *
     * @param DateTime $date
     * @return array
     * @throws \Exception
     */
    public function getFirstAndLastDayOfWeek(DateTime $date)
    {
        $week = $this->getDaysInWeek($date);

        $firstDayOfWeek = reset($week);
        $lastDayOfWeek  = end($week);

        return ['firstDay' => $firstDayOfWeek, 'lastDay' => $lastDayOfWeek];
    }

    /**
     * Get the week which this date is in, and count the number
     * of non-working days
     *
     * @param DateTime $date
     * @return int
     */
    public function getNumWorkingDaysInWeek(DateTime $date)
    {
        $week = $this->getDaysInWeek($date);
        $week = $this->removeNonWorkingDays($week);
        return count($week);
    }

    /**
     * Remove any non-working days
     *
     * @param DateTime[] $dates
     * @return DateTime[]
     */
    public function removeNonWorkingDays(array $dates)
    {
        return array_filter(
            $dates,
            function (DateTime $day) {
                return $day->format('N') < 6;
            }
        );
    }

    /**
     * Get an array of weeks, with each day of the week in it
     *
     * @param DateTime $date
     * @return array
     */
    public function getWeeksInMonth(DateTime $date)
    {
        $tmpDatePeriod = new \DatePeriod(
            new DateTime(sprintf('first day of %s', $date->format('F Y'))),
            new \DateInterval('P1D'),
            new DateTime(sprintf('last day of %s 23:59:59', $date->format('F Y')))
        );

        //convert DateTime to JhDateTime
        $datePeriod = [];
        foreach ($tmpDatePeriod as $date) {
            $jhDate = new DateTime();
            $jhDate->setTimestamp($date->getTimestamp());
            $datePeriod[] = $jhDate;
        }


        $weeks = [];
        $weekCounter = 0;
        foreach ($datePeriod as $day) {
            $dayNum = $day->format('N');

            if (!isset($weeks[$weekCounter])) {
                $weeks[$weekCounter] = [$day];
            } else {
                $weeks[$weekCounter][] = $day;
            }

            if ($dayNum == 7) {
                $weekCounter++;
            }
        }

        return $weeks;
    }

    /**
     * @param DateTime $dateA
     * @param DateTime $dateB
     * @return bool
     */
    public function isDateAfterDay(DateTime $dateA, DateTime $dateB)
    {
        $date = clone $dateB;
        $date->modify("23:59:59");
        return $dateA > $date;
    }
}