Timer::isHoliday() - Code Metrics - maschmann/php-utilities - Measure and Improve Code Quality continuously with Scrutinizer

Timer::isHoliday() A
last analyzed 2018-08-20 09:43 UTC

↳ Parent: Timer

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php
/*
 * This file is part of the php-utilities package.
 *
 * (c) Marc Aschmann <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Asm\Timer;

use Asm\Config\ConfigTimer;

/**
 * Timer Class
 *
 * @package Asm\Timer
 * @author Marc Aschmann <[email protected]>
 */
final class Timer
{
    /**
     * @var \Asm\Data\Data
     */
    private $config;

    /**
     * Current timer's config.
     *
     * @var mixed
     */
    private $currentConf;

    /**
     * If a holiday is in place - here it is.
     *
     * @var null|\DateTime
     */
    private $holiday;

    /**
     * Constructor with dependency injection.
     *
     * @param ConfigTimer $config
     */
    public function __construct(ConfigTimer $config)
    {
        $this->config = $config;
    }

    /**
     * Check if timer is active.
     *
     * @param  string $type
     * @return bool
     */
    public function isTimerActive(string $type) : bool
    {
        $return = false;
        $this->currentConf = $this->config->get('timers', $type);

        // pre-check holidays
        if (true === isset($this->currentConf['holiday'])) {
            // check if general holidays are to be used
            if (isset($this->currentConf['holiday']['use_general'])
                && true === (bool)$this->currentConf['holiday']['use_general']
            ) {
                if (false === $this->isHoliday()) {
                    $return = $this->checkDate();
                }
            } elseif (0 < count($this->config->get('holidays'))) {
                if (false === $this->checkIntervals($this->config->get('holidays'))) {
                    // we're not in a holiday
                    $return = $this->checkDate();
                }
            }
        } else {
            $return = $this->checkDate();
        }

        $this->flush();

        return $return;
    }

    /**
     * Calculate difference between holiday DateTime objects and current or given time.
     *
     * @param  string|null $date
     * @return bool
     */
    public function isHoliday($date = null) : bool
    {
        return $this->checkHoliday($date);
    }

    /**
     * Returns holiday object, if set.
     *
     * @return \DateTime|null
     */
    public function getHoliday()
    {
        return $this->holiday;
    }

    /**
     * Clear current configuration.
     */
    public function flush()
    {
        $this->currentConf = [];
        $this->holiday = null;
    }

    /**
     * Date checks on config.
     *
     * @return bool
     */
    private function checkDate() : bool
    {
        $return = false;

        // reverse switch to call checks
        switch (true) {
            case array_key_exists('interval', $this->currentConf):
                $return = $this->checkIntervals();
                break;
            case (array_key_exists('time', $this->currentConf) && array_key_exists('day', $this->currentConf)):
                // first check if we're on configured day
                if (true === $this->checkDays()) {
                    // then see if we're in the timeframe
                    $return = $this->checkTime();
                }
                break;
            case array_key_exists('day', $this->currentConf):
                $return = $this->checkDays();
                break;
            case array_key_exists('time', $this->currentConf):
                $return = $this->checkTime();
                break;
        }

        return $return;
    }

    /**
     * Check for holidays.
     *
     * @param  string|null $date
     * @return bool
     */
    private function checkHoliday($date = null) : bool
    {
        $mixReturn = false;

        $today = $this->convertDate($date);

        foreach ($this->config->get('general_holidays') as $holiday) {
            // clone for start/enddate
            $holidayEnd = clone $holiday;
            $holidayStart = clone $holiday;
            $startTime = ['00', '00', '00'];
            $endTime = ['23', '59', '59'];

            if (true === isset($this->currentConf['holiday']['interval'])) {
                $startTime = explode(':', $this->currentConf['holiday']['interval'][0]);
                $endTime = explode(':', $this->currentConf['holiday']['interval'][1]);
            }

            // check if there's a modifier for holiday range and if it's before or after the actual holiday
            if (isset($this->currentConf['holiday']['additional'])) {
                // create interval object for difference to add/subtract
                $intervalDiff = new \DateInterval('P' . $this->currentConf['holiday']['additional'][1] . 'D');
                switch ($this->currentConf['holiday']['additional'][0]) {
                    // @codeCoverageIgnoreStart
                    case 'add':
                        // if days are added, date will be enddate
                        $holidayEnd->{$this->currentConf['holiday']['additional'][0]}($intervalDiff);
                        break;
                    case 'sub':
                        // if days are subtracted, date will be startdate
                        $holidayStart->{$this->currentConf['holiday']['additional'][0]}($intervalDiff);
                        break;
                    // @codeCoverageIgnoreEnd
                }
            }

            // calculate difference between today and timed startdate
            $intervalStart = $today->diff(
                $holidayStart->setTime($startTime[0], $startTime[1], $startTime[2])
            );
            // calculate difference between today and timed enddate
            $intervalEnd = $today->diff(
                $holidayEnd->setTime($endTime[0], $endTime[1], $endTime[2])
            );

            // check if current date has passed start but not endtime
            if ((1 == $intervalStart->invert) && (0 == $intervalEnd->invert)) {
                $this->holiday = $holiday;
                $mixReturn = true;
                break;
            }
        }

        return $mixReturn;
    }

    /**
     * Check if current date is in interval.
     *
     * @param  array $intervals
     * @return bool
     */
    private function checkIntervals(array $intervals = []) : bool
    {
        $today = new \DateTime();
        $return = false;

        if (empty($intervals)) {
            $intervals = $this->currentConf['interval'];
        }

        foreach ($intervals as $interval) {
            $intervalStart = $today->diff($interval[0]);
            $intervalEnd = $today->diff($interval[1]);

            // check if current date has passed start but not endtime
            if ((1 == $intervalStart->invert) && (0 == $intervalEnd->invert)) {
                $return = true;
                break;
            }
        }

        return $return;
    }

    /**
     * Check if today is in days array.
     *
     * @return bool
     */
    private function checkDays() : bool
    {
        $return = false;

        if (in_array(strtolower(date('l')), $this->currentConf['day'])) {
            $return = true;
        }

        return $return;
    }

    /**
     * Do time comparison.
     *
     * @param array $intervals
     * @return bool
     */
    private function checkTime($intervals = []) : bool
    {
        $return = [];
        if (empty($intervals)) {
            $intervals = $this->currentConf['time'];
        }

        foreach ($intervals as $intKey => $intervalParts) {
            // build objects for comparison
            $startTime = new \DateTime();
            $startTimeParts = explode(':', $intervalParts[0]);

            $return[$intKey][0] = $startTime->setTime(
                $startTimeParts[0],
                $startTimeParts[1],
                $startTimeParts[2]
            );

            $endTime = new \DateTime();
            $endTimeParts = explode(':', $intervalParts[1]);
            $return[$intKey][1] = $endTime->setTime(
                $endTimeParts[0],
                $endTimeParts[1],
                $endTimeParts[2]
            );
        }

        return $this->checkIntervals($return);
    }

    /**
     * Check date string or object and convert if necessary.
     *
     * @param string|null $date
     * @return \DateTime
     */
    private function convertDate($date) : \DateTime
    {
        if (empty($date)) {
            $today = new \DateTime();
        } else {
            $today = new \DateTime($date);
        }

        return $today;
    }
}


1			<?php
2			/*
3			* This file is part of the php-utilities package.
4			*
5			* (c) Marc Aschmann <[email protected]>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10			namespace Asm\Timer;
11
12			use Asm\Config\ConfigTimer;
13
14			/**
15			* Timer Class
16			*
17			* @package Asm\Timer
18			* @author Marc Aschmann <[email protected]>
19			*/
20			final class Timer
21			{
22			/**
23			* @var \Asm\Data\Data
24			*/
25			private $config;
26
27			/**
28			* Current timer's config.
29			*
30			* @var mixed
31			*/
32			private $currentConf;
33
34			/**
35			* If a holiday is in place - here it is.
36			*
37			* @var null\|\DateTime
38			*/
39			private $holiday;
40
41			/**
42			* Constructor with dependency injection.
43			*
44			* @param ConfigTimer $config
45			*/
46			public function __construct(ConfigTimer $config)
47			{
48			$this->config = $config;
49			}
50
51			/**
52			* Check if timer is active.
53			*
54			* @param string $type
55			* @return bool
56			*/
57			public function isTimerActive(string $type) : bool
58			{
59			$return = false;
60			$this->currentConf = $this->config->get('timers', $type);
61
62			// pre-check holidays
63			if (true === isset($this->currentConf['holiday'])) {
64			// check if general holidays are to be used
65			if (isset($this->currentConf['holiday']['use_general'])
66			&& true === (bool)$this->currentConf['holiday']['use_general']
67			) {
68			if (false === $this->isHoliday()) {
69			$return = $this->checkDate();
70			}
71			} elseif (0 < count($this->config->get('holidays'))) {
72			if (false === $this->checkIntervals($this->config->get('holidays'))) {
73			// we're not in a holiday
74			$return = $this->checkDate();
75			}
76			}
77			} else {
78			$return = $this->checkDate();
79			}
80
81			$this->flush();
82
83			return $return;
84			}
85
86			/**
87			* Calculate difference between holiday DateTime objects and current or given time.
88			*
89			* @param string\|null $date
90			* @return bool
91			*/
92			public function isHoliday($date = null) : bool
93			{
94			return $this->checkHoliday($date);
95			}
96
97			/**
98			* Returns holiday object, if set.
99			*
100			* @return \DateTime\|null
101			*/
102			public function getHoliday()
103			{
104			return $this->holiday;
105			}
106
107			/**
108			* Clear current configuration.
109			*/
110			public function flush()
111			{
112			$this->currentConf = [];
113			$this->holiday = null;
114			}
115
116			/**
117			* Date checks on config.
118			*
119			* @return bool
120			*/
121			private function checkDate() : bool
122			{
123			$return = false;
124
125			// reverse switch to call checks
126			switch (true) {
127			case array_key_exists('interval', $this->currentConf):
128			$return = $this->checkIntervals();
129			break;
130			case (array_key_exists('time', $this->currentConf) && array_key_exists('day', $this->currentConf)):
131			// first check if we're on configured day
132			if (true === $this->checkDays()) {
133			// then see if we're in the timeframe
134			$return = $this->checkTime();
135			}
136			break;
137			case array_key_exists('day', $this->currentConf):
138			$return = $this->checkDays();
139			break;
140			case array_key_exists('time', $this->currentConf):
141			$return = $this->checkTime();
142			break;
143			}
144
145			return $return;
146			}
147
148			/**
149			* Check for holidays.
150			*
151			* @param string\|null $date
152			* @return bool
153			*/
154			private function checkHoliday($date = null) : bool
155			{
156			$mixReturn = false;
157
158			$today = $this->convertDate($date);
159
160			foreach ($this->config->get('general_holidays') as $holiday) {
161			// clone for start/enddate
162			$holidayEnd = clone $holiday;
163			$holidayStart = clone $holiday;
164			$startTime = ['00', '00', '00'];
165			$endTime = ['23', '59', '59'];
166
167			if (true === isset($this->currentConf['holiday']['interval'])) {
168			$startTime = explode(':', $this->currentConf['holiday']['interval'][0]);
169			$endTime = explode(':', $this->currentConf['holiday']['interval'][1]);
170			}
171
172			// check if there's a modifier for holiday range and if it's before or after the actual holiday
173			if (isset($this->currentConf['holiday']['additional'])) {
174			// create interval object for difference to add/subtract
175			$intervalDiff = new \DateInterval('P' . $this->currentConf['holiday']['additional'][1] . 'D');
176			switch ($this->currentConf['holiday']['additional'][0]) {
177			// @codeCoverageIgnoreStart
178			case 'add':
179			// if days are added, date will be enddate
180			$holidayEnd->{$this->currentConf['holiday']['additional'][0]}($intervalDiff);
181			break;
182			case 'sub':
183			// if days are subtracted, date will be startdate
184			$holidayStart->{$this->currentConf['holiday']['additional'][0]}($intervalDiff);
185			break;
186			// @codeCoverageIgnoreEnd
187			}
188			}
189
190			// calculate difference between today and timed startdate
191			$intervalStart = $today->diff(
192			$holidayStart->setTime($startTime[0], $startTime[1], $startTime[2])
193			);
194			// calculate difference between today and timed enddate
195			$intervalEnd = $today->diff(
196			$holidayEnd->setTime($endTime[0], $endTime[1], $endTime[2])
197			);
198
199			// check if current date has passed start but not endtime
200			if ((1 == $intervalStart->invert) && (0 == $intervalEnd->invert)) {
201			$this->holiday = $holiday;
202			$mixReturn = true;
203			break;
204			}
205			}
206
207			return $mixReturn;
208			}
209
210			/**
211			* Check if current date is in interval.
212			*
213			* @param array $intervals
214			* @return bool
215			*/
216			private function checkIntervals(array $intervals = []) : bool
217			{
218			$today = new \DateTime();
219			$return = false;
220
221			if (empty($intervals)) {
222			$intervals = $this->currentConf['interval'];
223			}
224
225			foreach ($intervals as $interval) {
226			$intervalStart = $today->diff($interval[0]);
227			$intervalEnd = $today->diff($interval[1]);
228
229			// check if current date has passed start but not endtime
230			if ((1 == $intervalStart->invert) && (0 == $intervalEnd->invert)) {
231			$return = true;
232			break;
233			}
234			}
235
236			return $return;
237			}
238
239			/**
240			* Check if today is in days array.
241			*
242			* @return bool
243			*/
244			private function checkDays() : bool
245			{
246			$return = false;
247
248			if (in_array(strtolower(date('l')), $this->currentConf['day'])) {
249			$return = true;
250			}
251
252			return $return;
253			}
254
255			/**
256			* Do time comparison.
257			*
258			* @param array $intervals
259			* @return bool
260			*/
261			private function checkTime($intervals = []) : bool
262			{
263			$return = [];
264			if (empty($intervals)) {
265			$intervals = $this->currentConf['time'];
266			}
267
268			foreach ($intervals as $intKey => $intervalParts) {
269			// build objects for comparison
270			$startTime = new \DateTime();
271			$startTimeParts = explode(':', $intervalParts[0]);
272
273			$return[$intKey][0] = $startTime->setTime(
274			$startTimeParts[0],
275			$startTimeParts[1],
276			$startTimeParts[2]
277			);
278
279			$endTime = new \DateTime();
280			$endTimeParts = explode(':', $intervalParts[1]);
281			$return[$intKey][1] = $endTime->setTime(
282			$endTimeParts[0],
283			$endTimeParts[1],
284			$endTimeParts[2]
285			);
286			}
287
288			return $this->checkIntervals($return);
289			}
290
291			/**
292			* Check date string or object and convert if necessary.
293			*
294			* @param string\|null $date
295			* @return \DateTime
296			*/
297			private function convertDate($date) : \DateTime
298			{
299			if (empty($date)) {
300			$today = new \DateTime();
301			} else {
302			$today = new \DateTime($date);
303			}
304
305			return $today;
306			}
307			}
308

maschmann / php-utilities

Timer::isHoliday() A last analyzed 2018-08-20 09:43 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Timer::isHoliday() A
last analyzed 2018-08-20 09:43 UTC