Michalmanko\Holiday\Provider\AbstractProvider

Complexity

Total Complexity

20

Size/Duplication

Total Lines	207
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes	7
Bugs	2	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
	prepareHolidays()	0	1	?
A	getTimeZone()	0	4	1
A	createHoliday()	0	4	1
A	getEaster()	0	9	1
B	prepareHolidaysByYear()	0	17	5
A	getHolidaysByYear()	0	16	2
C	getHolidays()	0	38	7
A	hasHolidays()	0	7	1
A	isHoliday()	0	4	1

<?php

/*
 * This file is part of the Holiday Library.
 *
 * (c) Michał Mańko <github@michalmanko.com>
 *
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */

namespace Michalmanko\Holiday\Provider;

use ArrayObject;
use DateTime;
use DateTimeZone;
use Michalmanko\Holiday\Holiday;
use Michalmanko\Holiday\Provider\Exception\InvalidArgumentException;
use Michalmanko\Holiday\Provider\Exception\UnexpectedValueException;

/**
 * Abstract provider class.
 *
 * @author Michał Mańko <github@michalmanko.com>
 */
abstract class AbstractProvider
{
    /**
     * Timezone.
     *
     * @var DateTimeZone
     */
    protected $timezone;

    /**
     * List of holidays by year.
     *
     * @var array
     */
    private $holidays = array();

    /**
     * @param null|DateTimeZone $timezone (optional) Timezone
     */
    public function __construct(DateTimeZone $timezone = null)
    {
        $this->timezone = $timezone;
    }

    /**
     * Prepare the holidays in given year.
     *
     * @param int $year The year to prepare the holidays for
     *
     * @return array An array of holidays
     */
    abstract protected function prepareHolidays($year);

    /**
     * Returns timezone.
     *
     * @return DateTimeZone
     */
    public function getTimeZone()
    {
        return $this->timezone;
    }

    /**
     * Creates a holiday object based on current timezone.
     *
     * @param string $name Name
     * @param mixed  $time Time
     * @param string $type Type
     *
     * @return Holiday
     */
    public function createHoliday($name, $time, $type = Holiday::TYPE_HOLIDAY)
    {
        return new Holiday($name, $time, $this->getTimeZone(), $type);
    }

    /**
     * Provides a DateTime object that represents easter sunday for this year.<br/>
     * The time is always set to 00:00:00.
     *
     * @param int $year The year for which to calculcate the easter sunday date
     *
     * @throws InvalidArgumentException
     *
     * @return DateTime
     */
    protected function getEaster($year)
    {
        $easter = new DateTime('now', $this->getTimeZone());
        $easter->setDate($year, 3, 21);
        $easter->setTime(0, 0, 0);
        $easter->modify('+' . easter_days($year) . 'days');

        return $easter;
    }

    /**
     * Prepare the holidays in given year based on {@see prepareHolidays()}.
     *
     * @param int $year
     *
     * @throws UnexpectedValueException
     */
    private function prepareHolidaysByYear($year)
    {
        if (!isset($this->holidays[$year])) {
            $preparedHolidays = $this->prepareHolidays($year);
            if (is_object($preparedHolidays) && $preparedHolidays instanceof ArrayObject) {
                $preparedHolidays = $preparedHolidays->getArrayCopy();
            }
            if (!is_array($preparedHolidays)) {
                throw new UnexpectedValueException(\sprintf(
                    'Method %s::prepareHolidays() must returns an array',
                    get_class($this)
                ));
            }

            $this->holidays[$year] = $preparedHolidays;
        }
    }

    /**
     * Returns the holidays in given year.
     *
     * @param int         $year The year to get the holidays for
     * @param null|string $type (optional) Holiday type
     *
     * @throws InvalidArgumentException
     *
     * @return array An array of Holidays
     */
    public function getHolidaysByYear($year, $type = null)
    {
        $this->prepareHolidaysByYear($year);

        if (null === $type) {
            return $this->holidays[$year];
        }

        // Note: array_filter preserves keys, so we use array_values to reset array keys
        return array_values(array_filter(
            $this->holidays[$year],
            function (Holiday $holiday) use ($type) {
                return $holiday->getType() === $type;
            }
        ));
    }

    /**
     * Returns all holidays in the given time period.
     *
     * @param DateTime $startDate     The start date
     * @param mixed    $endDateOrType (optional) The end date or holiday type
     * @param string   $type          (optional) Holiday type
     *
     * @return array
     */
    public function getHolidays(
        DateTime $startDate,
        $endDateOrType = null,
        $type = null
    ) {
        $startDate = clone $startDate;
        $startDate->setTime(0, 0, 0);

        if ($endDateOrType !== null && !($endDateOrType instanceof DateTime)) {
            if ($type !== null) {
                throw new InvalidArgumentException(
                    '$endDateOrType must be an instance of \DateTime'
                );
            }
            $type          = $endDateOrType;
            $endDateOrType = clone $startDate;
        } elseif ($endDateOrType === null) {
            $endDateOrType = clone $startDate;
        } else {
            $endDateOrType = clone $endDateOrType;
        }
        $endDateOrType->setTime(23, 59, 59);

        $startyear = (int) $startDate->format('Y');
        $endyear   = (int) $endDateOrType->format('Y');
        $holidays  = array();
        for ($y = $startyear; $y <= $endyear; $y++) {
            $holidays = array_merge($holidays, $this->getHolidaysByYear($y, $type));
        }

        // Note: array_filter preserves keys, so we use array_values to reset array keys
        return array_values(array_filter(
            $holidays,
            function (Holiday $holiday) use ($startDate, $endDateOrType) {
                return $holiday >= $startDate && $holiday <= $endDateOrType;
            }
        ));
    }

    /**
     * Returns true if any holiday exists in the given time period.
     *
     * @param DateTime      $startDate The start date
     * @param null|DateTime $endDate   (optional) The end date
     * @param null|string   $type      (optional) Holiday type
     *
     * @return bool
     */
    public function hasHolidays(
        DateTime $startDate,
        DateTime $endDate,
        $type = null
    ) {
        return count($this->getHolidays($startDate, $endDate, $type)) > 0;
    }

    /**
     * Returns true if $date is a holiday.
     *
     * @param DateTime    $date The date
     * @param null|string $type (optional) Holiday type
     *
     * @return bool
     */
    public function isHoliday(DateTime $date, $type = null)
    {
        return count($this->getHolidays($date, null, $type)) > 0;
    }
}