CPS-IT/project-builder

View on GitHub
src/IO/Validator/AbstractValidator.php

Summary

Maintainability
A
0 mins
Test Coverage
A
100%
<?php

declare(strict_types=1);

/*
 * This file is part of the Composer package "cpsit/project-builder".
 *
 * Copyright (C) 2022 Elias Häußler <e.haeussler@familie-redlich.de>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

namespace CPSIT\ProjectBuilder\IO\Validator;

use CPSIT\ProjectBuilder\Exception;

/**
 * AbstractValidator.
 *
 * @author Elias Häußler <e.haeussler@familie-redlich.de>
 * @license GPL-3.0-or-later
 *
 * @template T of array<string, mixed>
 */
abstract class AbstractValidator implements ValidatorInterface
{
    /**
     * @var array<string, mixed>
     */
    protected static array $defaultOptions = [];

    /**
     * @phpstan-var T
     */
    protected array $options;

    /**
     * @param array<string, mixed> $options
     *
     * @throws Exception\MisconfiguredValidatorException
     */
    public function __construct(
        array $options = [],
    ) {
        $invalidOptions = array_diff_key($options, static::$defaultOptions);

        if ([] !== $invalidOptions) {
            throw Exception\MisconfiguredValidatorException::forUnexpectedOptions($this, array_keys($invalidOptions));
        }

        /* @phpstan-ignore-next-line assign.propertyType */
        $this->options = [...static::$defaultOptions, ...$options];
    }
}