Calculator::isFreeDay() - Code Metrics - andrejsstepanovs/business-days-calculator - Measure and Improve Code Quality continuously with Scrutinizer

Calculator::isFreeDay() A
last analyzed 2018-05-26 20:23 UTC

↳ Parent: Calculator

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	6
cts	6
cp	1
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	6
nc	3
nop	1
crap	3

<?php

namespace BusinessDays;


/**
 * Class Calculator
 *
 * @package BusinessDays
 */
class Calculator
{
    const MONDAY    = 1;
    const TUESDAY   = 2;
    const WEDNESDAY = 3;
    const THURSDAY  = 4;
    const FRIDAY    = 5;
    const SATURDAY  = 6;
    const SUNDAY    = 7;

    const WEEK_DAY_FORMAT = 'N';
    const HOLIDAY_FORMAT  = 'm-d';
    const FREE_DAY_FORMAT = 'Y-m-d';

    /** @var \DateTime */
    private $date;

    /** @var \DateTime[] */
    private $holidays = array();

    /** @var \DateTime[] */
    private $freeDays = array();

    /** @var int[] */
    private $freeWeekDays = array();

    /**
     * @param \DateTime $startDate Date to start calculations from
     *
     * @return $this
     */
    public function setStartDate(\DateTime $startDate)
    {
        // Use clone so parameter is not passed as a reference.
        // If not, it can brake caller method by changing $startDate parameter while changing it here.

        $this->date = clone $startDate;

        return $this;
    }

    /**
     * @param \DateTime[] $holidays Array of holidays that repeats each year. (Only month and date is used to match).
     *
     * @return $this
     */
    public function setHolidays(array $holidays)
    {
        $this->holidays = $holidays;

        return $this;
    }

    /**
     * @return \DateTime[]
     */
    private function getHolidays()
    {
        return $this->holidays;
    }

    /**
     * @param \DateTime[] $freeDays Array of free days that dose not repeat.
     *
     * @return $this
     */
    public function setFreeDays(array $freeDays)
    {
        $this->freeDays = $freeDays;

        return $this;
    }

    /**
     * @return \DateTime[]
     */
    private function getFreeDays()
    {
        return $this->freeDays;
    }

    /**
     * @param int[] $freeWeekDays Array of days of the week which are not business days.
     *
     * @return $this
     */
    public function setFreeWeekDays(array $freeWeekDays)
    {
        $this->freeWeekDays = $freeWeekDays;

        return $this;
    }

    /**
     * @return int[]
     */
    private function getFreeWeekDays()
    {
        if (count($this->freeWeekDays) >= 7) {
            throw new \InvalidArgumentException('Too many non business days provided');
        }

        return $this->freeWeekDays;
    }

    /**
     * @param int $howManyDays
     *
     * @return $this
     */
    public function addBusinessDays($howManyDays)
    {
        $iterator = 0;
        while ($iterator < $howManyDays) {
            $this->getDate()->modify('+1 day');
            if ($this->isBusinessDay($this->getDate())) {
                $iterator++;
            }
        }

        return $this;
    }

    /**
     * @return \DateTime
     */
    public function getDate()
    {
        if ($this->date === null) {
            $this->date = new \DateTime();
        }

        return $this->date;
    }

    /**
     * @param \DateTime $date
     *
     * @return bool
     */
    public function isBusinessDay(\DateTime $date)
    {
        if ($this->isFreeWeekDayDay($date)) {
            return false;
        }

        if ($this->isHoliday($date)) {
            return false;
        }

        if ($this->isFreeDay($date)) {
            return false;
        }

        return true;
    }

    /**
     * @param \DateTime $date
     *
     * @return bool
     */
    public function isFreeWeekDayDay(\DateTime $date)
    {
        $currentWeekDay = (int)$date->format(self::WEEK_DAY_FORMAT);

        if (in_array($currentWeekDay, $this->getFreeWeekDays())) {
            return true;
        }

        return false;
    }

    /**
     * @param \DateTime $date
     *
     * @return bool
     */
    public function isHoliday(\DateTime $date)
    {
        $holidayFormatValue = $date->format(self::HOLIDAY_FORMAT);
        foreach ($this->getHolidays() as $holiday) {
            if ($holidayFormatValue == $holiday->format(self::HOLIDAY_FORMAT)) {
                return true;
            }
        }

        return false;
    }

    /**
     * @param \DateTime $date
     *
     * @return bool
     */
    public function isFreeDay(\DateTime $date)
    {
        $freeDayFormatValue = $date->format(self::FREE_DAY_FORMAT);
        foreach ($this->getFreeDays() as $freeDay) {
            if ($freeDayFormatValue == $freeDay->format(self::FREE_DAY_FORMAT)) {
                return true;
            }
        }

        return false;
    }
}


1		<?php
2
3		namespace BusinessDays;
4
5
6		/**
7		* Class Calculator
8		*
9		* @package BusinessDays
10		*/
11		class Calculator
12		{
13		const MONDAY = 1;
14		const TUESDAY = 2;
15		const WEDNESDAY = 3;
16		const THURSDAY = 4;
17		const FRIDAY = 5;
18		const SATURDAY = 6;
19		const SUNDAY = 7;
20
21		const WEEK_DAY_FORMAT = 'N';
22		const HOLIDAY_FORMAT = 'm-d';
23		const FREE_DAY_FORMAT = 'Y-m-d';
24
25		/** @var \DateTime */
26		private $date;
27
28		/** @var \DateTime[] */
29		private $holidays = array();
30
31		/** @var \DateTime[] */
32		private $freeDays = array();
33
34		/** @var int[] */
35		private $freeWeekDays = array();
36
37		/**
38		* @param \DateTime $startDate Date to start calculations from
39		*
40		* @return $this
41		*/
42	16	public function setStartDate(\DateTime $startDate)
43		{
44		// Use clone so parameter is not passed as a reference.
45		// If not, it can brake caller method by changing $startDate parameter while changing it here.
46
47	16	$this->date = clone $startDate;
48
49	16	return $this;
50		}
51
52		/**
53		* @param \DateTime[] $holidays Array of holidays that repeats each year. (Only month and date is used to match).
54		*
55		* @return $this
56		*/
57	15	public function setHolidays(array $holidays)
58		{
59	15	$this->holidays = $holidays;
60
61	15	return $this;
62		}
63
64		/**
65		* @return \DateTime[]
66		*/
67	16	private function getHolidays()
68		{
69	16	return $this->holidays;
70		}
71
72		/**
73		* @param \DateTime[] $freeDays Array of free days that dose not repeat.
74		*
75		* @return $this
76		*/
77	15	public function setFreeDays(array $freeDays)
78		{
79	15	$this->freeDays = $freeDays;
80
81	15	return $this;
82		}
83
84		/**
85		* @return \DateTime[]
86		*/
87	16	private function getFreeDays()
88		{
89	16	return $this->freeDays;
90		}
91
92		/**
93		* @param int[] $freeWeekDays Array of days of the week which are not business days.
94		*
95		* @return $this
96		*/
97	16	public function setFreeWeekDays(array $freeWeekDays)
98		{
99	16	$this->freeWeekDays = $freeWeekDays;
100
101	16	return $this;
102		}
103
104		/**
105		* @return int[]
106		*/
107	17	private function getFreeWeekDays()
108		{
109	17	if (count($this->freeWeekDays) >= 7) {
110	1	throw new \InvalidArgumentException('Too many non business days provided');
111		}
112
113	16	return $this->freeWeekDays;
114		}
115
116		/**
117		* @param int $howManyDays
118		*
119		* @return $this
120		*/
121	17	public function addBusinessDays($howManyDays)
122		{
123	17	$iterator = 0;
124	17	while ($iterator < $howManyDays) {
125	17	$this->getDate()->modify('+1 day');
126	17	if ($this->isBusinessDay($this->getDate())) {
127	16	$iterator++;
128		}
129		}
130
131	16	return $this;
132		}
133
134		/**
135		* @return \DateTime
136		*/
137	17	public function getDate()
138		{
139	17	if ($this->date === null) {
140	1	$this->date = new \DateTime();
141		}
142
143	17	return $this->date;
144		}
145
146		/**
147		* @param \DateTime $date
148		*
149		* @return bool
150		*/
151	17	public function isBusinessDay(\DateTime $date)
152		{
153	17	if ($this->isFreeWeekDayDay($date)) {
154	7	return false;
155		}
156
157	16	if ($this->isHoliday($date)) {
158	4	return false;
159		}
160
161	16	if ($this->isFreeDay($date)) {
162	7	return false;
163		}
164
165	16	return true;
166		}
167
168		/**
169		* @param \DateTime $date
170		*
171		* @return bool
172		*/
173	17	public function isFreeWeekDayDay(\DateTime $date)
174		{
175	17	$currentWeekDay = (int)$date->format(self::WEEK_DAY_FORMAT);
176
177	17	if (in_array($currentWeekDay, $this->getFreeWeekDays())) {
178	7	return true;
179		}
180
181	16	return false;
182		}
183
184		/**
185		* @param \DateTime $date
186		*
187		* @return bool
188		*/
189	16	public function isHoliday(\DateTime $date)
190		{
191	16	$holidayFormatValue = $date->format(self::HOLIDAY_FORMAT);
192	16	foreach ($this->getHolidays() as $holiday) {
193	4	if ($holidayFormatValue == $holiday->format(self::HOLIDAY_FORMAT)) {
194	4	return true;
195		}
196		}
197
198	16	return false;
199		}
200
201		/**
202		* @param \DateTime $date
203		*
204		* @return bool
205		*/
206	16	public function isFreeDay(\DateTime $date)
207		{
208	16	$freeDayFormatValue = $date->format(self::FREE_DAY_FORMAT);
209	16	foreach ($this->getFreeDays() as $freeDay) {
210	7	if ($freeDayFormatValue == $freeDay->format(self::FREE_DAY_FORMAT)) {
211	7	return true;
212		}
213		}
214
215	16	return false;
216		}
217		}
218

andrejsstepanovs / business-days-calculator

Calculator::isFreeDay() A last analyzed 2018-05-26 20:23 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Calculator::isFreeDay() A
last analyzed 2018-05-26 20:23 UTC