Janitor\Watcher\Fixed

Complexity

Total Complexity

20

Size/Duplication

Total Lines	143
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	2
B	setStart()	0	18	5
A	getStart()	0	4	1
B	setEnd()	0	18	5
A	getEnd()	0	4	1
A	getScheduledTimes()	0	13	2
A	isScheduled()	0	6	2
A	isActive()	0	6	2

<?php

/*
 * janitor (http://juliangut.com/janitor).
 * Effortless maintenance management.
 *
 * @license BSD-3-Clause
 * @link https://github.com/juliangut/janitor
 * @author Julián Gutiérrez <juliangut@gmail.com>
 */

namespace Janitor\Watcher;

/**
 * Fixed date scheduled maintenance status watcher.
 *
 * Maintenance mode is considered to be On if current date is
 *   - higher than start if only start is defined
 *   - lower than end if only end is defined
 *   - higher than start and lower than end if both are defined
 */
class Fixed extends AbstractScheduled
{
    /**
     * Maintenance start time.
     *
     * @var \DateTime
     */
    protected $start;

    /**
     * Maintenance end time.
     *
     * @var \DateTime
     */
    protected $end;

    /**
     * Fixed constructor.
     *
     * @param \DateTime|string         $start
     * @param \DateTime|string         $end
     * @param \DateTimeZone|string|int $timeZone

Should the type for parameter $timeZone not be \DateTimeZone|string|integer|null?

     *
     * @throws \InvalidArgumentException
     */
    public function __construct($start, $end, $timeZone = null)
    {
        $this->setStart($start);
        $this->setEnd($end);
        if ($timeZone !== null) {
            $this->setTimeZone($timeZone);
        }
    }

    /**
     * Set scheduled start time.
     *
     * @param \DateTime|string $start
     *
     * @throws \InvalidArgumentException
     *
     * @return $this
     */
    public function setStart($start)
    {
        if (!$start instanceof \DateTime) {
            try {
                $start = new \DateTime($start, $this->getTimeZone());
            } catch (\Exception $exception) {
                throw new \InvalidArgumentException(sprintf('"%s" is not a valid DateTime', $start));
            }
        }

        if ($this->end && $start > $this->end) {
            throw new \InvalidArgumentException('Start time should come before end time');
        }

        $this->start = $start;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getStart()
    {
        return $this->start;
    }

    /**
     * Set scheduled end time.
     *
     * @param \DateTime|string $end
     *
     * @throws \InvalidArgumentException
     *
     * @return $this
     */
    public function setEnd($end)
    {
        if (!$end instanceof \DateTime) {
            try {
                $end = new \DateTime($end, $this->getTimeZone());
            } catch (\Exception $exception) {
                throw new \InvalidArgumentException(sprintf('"%s" is not a valid DateTime', $end));
            }
        }

        if ($this->start && $end < $this->start) {
            throw new \InvalidArgumentException('End time should come after start time');
        }

        $this->end = $end;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getEnd()
    {
        return $this->end;
    }

    /**
     * {@inheritdoc}
     */
    public function getScheduledTimes($count = 5)
    {
        if (!$this->isScheduled()) {
            return [];
        }

        return [
            [
                'start' => $this->start,
                'end'   => $this->end,
            ],
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function isScheduled()
    {
        $now = new \DateTime('now', $this->getTimeZone());

        return $this->start && $now < $this->start;
    }

    /**
     * {@inheritdoc}
     */
    public function isActive()
    {
        $now = new \DateTime();

        return !($now < $this->start || $this->end < $now);
    }
}