heiglandreas / holidayChecker

src/IteratorItem/DateFollowUp.php

<?php

declare(strict_types=1);

/**
 * Copyright (c) Andreas Heigl<andreas@heigl.org>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * @author    Andreas Heigl<andreas@heigl.org>
 * @copyright Andreas Heigl
 * @license   http://www.opensource.org/licenses/mit-license.php MIT-License
 * @since     08.03.2017
 * @link      http://github.com/heiglandreas/org.heigl.Holidaychecker
 */

namespace Org_Heigl\Holidaychecker\IteratorItem;

use DateTimeInterface;
use IntlCalendar;
use Org_Heigl\Holidaychecker\CalendarDay;
use Org_Heigl\Holidaychecker\HolidayIteratorItemInterface;
use function array_filter;
use function array_map;
use function in_array;

class DateFollowUp implements HolidayIteratorItemInterface
{
	/** @var CalendarDay */
	private $day;

	/** @var bool */
	private $holiday;

	/** @var string */
	private $name;

	/** @var string */
	private $followup;

	/** @var IntlCalendar::DOW*[] */
	private $replaced;

	/**
	 * @param array<"sunday"|"monday"|"tuesday"|"wednesday"|"thursday"|"friday"|"saturday"> $replaced

The doc comment array<"sunday"|"monday"|"tuesday"|"wednesday"|"thursday"|"friday"|"saturday"> at position 2 could not be parsed: Unknown type name '"sunday"' at position 2 in array<"sunday"|"monday"|"tuesday"|"wednesday"|"thursday"|"friday"|"saturday">.

	 */
	public function __construct(string $name, bool $holiday, CalendarDay $day, string $followup, array $replaced = [])
	{
		$this->day = $day;
		$this->followup = $followup;
		$this->holiday = $holiday;
		$this->name = $name;
		$this->replaced = $this->replacedDays($replaced);

It seems like $this->replacedDays($replaced) of type array or array<integer,integer> is incompatible with the declared type IntlCalendar of property $replaced.

	}

	/**
	 * @param array<"sunday"|"monday"|"tuesday"|"wednesday"|"thursday"|"friday"|"saturday"|"foo"> $replaced

The doc comment array<"sunday"|"monday"|"tuesday"|"wednesday"|"thursday"|"friday"|"saturday"|"foo"> at position 2 could not be parsed: Unknown type name '"sunday"' at position 2 in array<"sunday"|"monday"|"tuesday"|"wednesday"|"thursday"|"friday"|"saturday"|"foo">.

	 * @return IntlCalendar::DOW_*[]
	 */
	private static function replacedDays(array $replaced): array
	{
		$daymap = [
			'sunday' => IntlCalendar::DOW_SUNDAY,
			'monday' => IntlCalendar::DOW_MONDAY,
			'tuesday' => IntlCalendar::DOW_TUESDAY,
			'wednesday' => IntlCalendar::DOW_WEDNESDAY,
			'thursday' => IntlCalendar::DOW_THURSDAY,
			'friday' => IntlCalendar::DOW_FRIDAY,
			'saturday' => IntlCalendar::DOW_SATURDAY,
		];

		if ([] === $replaced) {
			return [

The expression return array(IntlCalendar::DOW_SATURDAY, IntlCalendar::DOW_SUNDAY) returns the type array<integer,integer> which is incompatible with the documented return type IntlCalendar.

				IntlCalendar::DOW_SATURDAY,
				IntlCalendar::DOW_SUNDAY,
			];
		}

		return array_filter(array_map(function (string $day) use ($daymap) {

The expression return array_filter(array_map(function(...) { /* ... */ }, $replaced)) returns the type array which is incompatible with the documented return type IntlCalendar.

			if (!isset($daymap[$day])) {
				return null;
			}
			return $daymap[$day];
		}, $replaced));
	}

	public function dateMatches(DateTimeInterface $date): bool
	{
		$gregorianYear = (int) $date->format('Y');
		$weekday = $this->day->getWeekdayForGregorianYear($gregorianYear);

		if (in_array($weekday, $this->replaced)) {

$this->replaced of type IntlCalendar is incompatible with the type array expected by parameter $haystack of in_array().

			return $this->day->isFollowUpDay($date, $this->followup);
		}

		return $this->day->isSameDay($date);
	}

	public function getName(): string
	{
		return $this->name;
	}

	public function isHoliday(): bool
	{
		return $this->holiday;
	}
}