CalendR\Period\Hour

Complexity

Total Complexity

12

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Coupling/Cohesion

Dependencies

4

Importance

Changes	7
Bugs	1	Features	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getDatePeriod()	0	4	1
A	isValid()	0	4	1
A	current()	0	4	1
A	next()	0	11	3
A	key()	0	4	1
A	valid()	0	4	1
A	rewind()	0	5	1
A	__toString()	0	4	1
A	getDateInterval()	0	4	1
A	createInvalidException()	0	4	1

<?php

namespace CalendR\Period;
use CalendR\Period\Exception\NotAnHour;

/**
 * Represents an hour.
 *
 * @author Zander Baldwin <mynameis@zande.rs>
 */
class Hour extends PeriodAbstract implements \Iterator
{
    /**
     * @var PeriodInterface
     */
    private $current;

    /**
     * Returns the period as a DatePeriod.
     *
     * @return \DatePeriod
     */
    public function getDatePeriod()
    {
        return new \DatePeriod($this->begin, new \DateInterval('PT1M'), $this->end);
    }

    /**
     * @param \DateTime $start
     *
     * @return bool
     */
    public static function isValid(\DateTime $start)
    {
        return $start->format('i:s') == '00:00';
    }

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

    /**
     * {@inheritdoc}
     */
    public function next()
    {
        if (null === $this->current) {
            $this->current = $this->getFactory()->createMinute($this->begin);
        } else {
            $this->current = $this->current->getNext();
            if (!$this->contains($this->current->getBegin())) {
                $this->current = null;
            }
        }
    }

    /**
     * {@inheritdoc}
     */
    public function key()
    {
        return (int) $this->current->getBegin()->format('G');
    }

    /**
     * {@inheritdoc}
     */
    public function valid()
    {
        return null !== $this->current;
    }

    /**
     * {@inheritdoc}
     */
    public function rewind()
    {
        $this->current = null;
        $this->next();
    }

    /**
     * Returns the hour.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->format('G');
    }

    /**
     * Returns a \DateInterval equivalent to the period.
     *
     * @return \DateInterval
     */
    public static function getDateInterval()
    {
        return new \DateInterval('PT1H');
    }

    /**
     * @return NotAnHour
     */
    protected function createInvalidException()
    {
        return new NotAnHour;
    }
}