CalendR\Period\PeriodAbstract

Complexity

Total Complexity

25

Size/Duplication

Total Lines	190
Duplicated Lines	0 %

Coupling/Cohesion

Dependencies

4

Importance

Changes	22
Bugs	5	Features	10

13 Methods

Rating	Name	Duplication	Size	Complexity
A	contains()	0	4	2
A	equals()	0	7	2
B	includes()	0	13	6
A	containsEvent()	0	9	4
A	format()	0	4	1
A	isCurrent()	0	4	1
A	getNext()	0	4	1
A	getPrevious()	0	7	1
A	getBegin()	0	4	1
A	getEnd()	0	4	1
A	getFactory()	0	8	2
A	__construct()	0	11	2
A	createInvalidException()	0	6	1

<?php

/*
 * This file is part of CalendR, a Fréquence web project.
 *
 * (c) 2012 Fréquence web
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace CalendR\Period;

use CalendR\Event\EventInterface;

/**
 * An abstract class that represent a date period and provide some base helpers.
 *
 * @author Yohan Giarelli <yohan@giarel.li>
 */
abstract class PeriodAbstract implements PeriodInterface
{
    /**
     * @var \DateTime
     */
    protected $begin;

    /**
     * @var \DateTime
     */
    protected $end;

    /**
     * @var FactoryInterface
     */
    protected $factory;

    /**
     * @param \DateTime        $begin
     * @param FactoryInterface $factory
     *
     * @throws \CalendR\Exception
     */
    public function __construct(\DateTime $begin, FactoryInterface $factory)
    {
        $this->factory = $factory;
        if (!static::isValid($begin)) {
            throw $this->createInvalidException();
        }

        $this->begin = clone $begin;
        $this->end   = clone $begin;
        $this->end->add($this->getDateInterval());
    }

    /**
     * Checks if the given period is contained in the current period.
     *
     * @param \DateTime $date
     *
     * @return bool true if the period contains this date
     */
    public function contains(\DateTime $date)
    {
        return $this->begin <= $date && $date < $this->end;
    }

    /**
     * Checks if a period is equals to an other.
     *
     * @param PeriodInterface $period
     *
     * @return bool
     */
    public function equals(PeriodInterface $period)
    {
        return
            $period instanceof static &&
            $this->begin->format('Y-m-d-H-i-s') === $period->getBegin()->format('Y-m-d-H-i-s')
        ;
    }

    /**
     * Returns true if the period include the other period
     * given as argument.
     *
     * @param PeriodInterface $period
     * @param bool            $strict
     *
     * @return bool
     */
    public function includes(PeriodInterface $period, $strict = true)
    {
        if (true === $strict) {
            return $this->getBegin() <= $period->getBegin() && $this->getEnd() >= $period->getEnd();
        }

        return
            $this->includes($period, true) ||
            $period->includes($this, true) ||
            $this->contains($period->getBegin()) ||
            $this->contains($period->getEnd())
        ;
    }

    /**
     * Returns if $event is during this period.
     * Non strict. Must return true if :
     *  * Event is during period
     *  * Period is during event
     *  * Event begin is during Period
     *  * Event end is during Period.
     *
     * @param EventInterface $event
     *
     * @return bool
     */
    public function containsEvent(EventInterface $event)
    {
        return
            $event->containsPeriod($this) ||
            $event->isDuring($this) ||
            $this->contains($event->getBegin()) ||
            $this->contains($event->getEnd())
        ;
    }

    /**
     * Format the period to a string.
     *
     * @param string $format
     *
     * @return string
     */
    public function format($format)
    {
        return $this->begin->format($format);
    }

    /**
     * Returns if the current period is the current one.
     *
     * @return bool
     */
    public function isCurrent()
    {
        return $this->contains(new \DateTime());
    }

    /**
     * Gets the next period of the same type.
     *
     * @return PeriodInterface
     */
    public function getNext()
    {
        return new static($this->end, $this->factory);
    }

    /**
     * Gets the previous period of the same type.
     *
     * @return PeriodInterface
     */
    public function getPrevious()
    {
        $start = clone $this->begin;
        $start->sub(static::getDateInterval());

        return new static($start, $this->factory);
    }

    /**
     * @return \DateTime
     */
    public function getBegin()
    {
        return clone $this->begin;
    }

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

    /**
     * @return FactoryInterface
     */
    public function getFactory()
    {
        if (null === $this->factory) {
            $this->factory = new Factory();
        }

        return $this->factory;
    }

    /**
     * @return \CalendR\Exception
     */
    protected function createInvalidException()
    {
        $class = 'CalendR\Period\Exception\NotA' . (new \ReflectionClass($this))->getShortName();

        return new $class;
    }
}