DateRanger\DateRange

Complexity

Total Complexity

16

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	start()	0	4	1
A	end()	0	4	1
A	getPeriod()	0	12	3
A	equals()	0	4	2
A	overlaps()	0	4	2
A	isCurrent()	0	6	1
A	current()	0	4	1
A	next()	0	4	1
A	key()	0	4	1
A	valid()	0	4	1
A	rewind()	0	4	1
A	count()	0	4	1

<?php

namespace DateRanger;

use Countable;
use DateInterval;
use DatePeriod;
use DateTimeImmutable;
use Iterator;

abstract class DateRange implements Iterator, Countable
{
    /** @var DateTimeImmutable */
    protected $start;
    /** @var DateTimeImmutable */
    protected $end;
    /** @var array */
    protected $dates = [];

    public function start(): DateTimeImmutable
    {
        return $this->start;
    }

    public function end(): DateTimeImmutable
    {
        return $this->end;
    }

    public function getPeriod($interval = 'P1D', DateTimeImmutable $start = null, DateTimeImmutable $end = null): DatePeriod
    {
        if (null === $start) {
            $start = $this->start;
        }

        if (null === $end) {
            $end = $this->end;
        }

        return new DatePeriod($start, new DateInterval($interval), $end);
    }

    public function equals(self $period): bool
    {
        return $this->start()->format('YmdHis') === $period->start()->format('YmdHis') && $this->end()->format('YmdHis') === $period->end()->format('YmdHis');
    }

    public function overlaps(self $period): bool
    {
        return $this->start() <= $period->end() && $this->end() >= $period->start();
    }

    public function isCurrent(): bool
    {
        $period = new static();

        return $this->equals($period);
    }

    public function current()
    {
        return current($this->dates);
    }

    public function next()
    {
        next($this->dates);
    }

    public function key()
    {
        return key($this->dates);
    }

    public function valid()
    {
        return current($this->dates);
    }

    public function rewind()
    {
        reset($this->dates);
    }

    public function count()
    {
        return count($this->dates);
    }
}