Platine\Stdlib\Config\AbstractConfiguration

Complexity

Total Complexity

23

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	get()	0	10	2
A	__construct()	0	4	1
A	has()	0	3	1
A	set()	0	19	4
A	getSetterMaps()	0	3	1
A	getDefault()	0	3	1
A	load()	0	6	2
B	checkType()	0	32	10
A	getValidationRules()	0	3	1

<?php

/**
 * Platine Stdlib
 *
 * Platine Stdlib is a the collection of frequently used php features
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2020 Platine Stdlib
 *
 * 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.
 */

/**
 *  @file AbstractConfiguration.php
 *
 *  The base class for application
 *
 *  @package    Platine\Stdlib\Config
 *  @author Platine Developers Team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   https://www.platine-php.com
 *  @version 1.0.0
 *  @filesource
 */

declare(strict_types=1);

namespace Platine\Stdlib\Config;

use Error;
use InvalidArgumentException;
use Platine\Stdlib\Contract\ConfigurationInterface;
use Platine\Stdlib\Helper\Arr;
use Platine\Stdlib\Helper\Str;

/**
 * @class AbstractConfiguration
 * @package Platine\Stdlib\Config
 */
abstract class AbstractConfiguration implements ConfigurationInterface
{
    /**
     * The raw configuration array
     * @var array<string, mixed>
     */
    protected array $config = [];

    /**
     * {@inheritedoc}
     */
    public function __construct(array $config = [])
    {
        $configuration = array_merge($this->getDefault(), $config);
        $this->load($configuration);
    }

    /**
     * {@inheritedoc}
     */
    public function get(string $name): mixed
    {
        if ($this->has($name) === false) {
            throw new InvalidArgumentException(sprintf(
                'Configuration [%s] does not exist',
                $name
            ));
        }

        return Arr::get($this->config, $name);
    }

    /**
     * {@inheritedoc}
     */
    public function set(string $name, mixed $value): void
    {
        $rules = $this->getValidationRules();
        if (array_key_exists($name, $rules)) {
            $type = $rules[$name];
            $this->checkType($name, $type, $value);
        }
        Arr::set($this->config, $name, $value);
        $setters = $this->getSetterMaps();
        $key = Str::camel($name, true);
        if (Arr::has($setters, $key)) {
            $method = Arr::get($setters, $key);
            $this->{$method}($value);
        } else {
            $setterMethod = 'set' . ucfirst($key);
            if (method_exists($this, $setterMethod)) {
                $this->{$setterMethod}($value);
            } else {
                $this->{$key} = $value;
            }
        }
    }

    /**
     * {@inheritedoc}
     */
    public function has(string $name): bool
    {
        return Arr::has($this->config, $name);
    }

    /**
     * {@inheritedoc}
     */
    public function load(array $config): void
    {
        $this->config = $config;

        foreach ($config as $name => $value) {
            $this->set($name, $value);
        }
    }

    /**
     * {@inheritedoc}
     */
    public function getValidationRules(): array
    {
        return [];
    }

    /**
     * {@inheritedoc}
     */
    public function getSetterMaps(): array
    {
        return [];
    }

    /**
     * {@inheritedoc}
     */
    public function getDefault(): array
    {
        return [];
    }

    /**
     * Check the configuration for the given type
     * @param string $key the configuration
     *  key to be checked can be dot notation
     * @param string $type
     * @param mixed $value
     * @return void
     */
    private function checkType(string $key, string $type, mixed $value = null): void
    {
        if (!Arr::has($this->config, $key) && $value === null) {
            return;
        }

        if ($value === null) {
            $value = Arr::get($this->config, $key, null);
        }

        $valueType = gettype($value);
        $className = null;
        if (strpos($type, 'object::') === 0) {
            $className = substr($type, 8);
        }

        $error = null;

        if ($className !== null) {
            if (!($value instanceof $className)) {
                $error = 'Invalid configuration [%s] instance value, expected [%s], but got [%s]';
            }
        } elseif ($type !== $valueType) {
            $error = 'Invalid configuration [%s] value, expected [%s], but got [%s]';
        }

        if ($error !== null) {
            throw new Error(sprintf(
                $error,
                Str::snake($key),
                $className ?? $type,
                is_object($value) ? get_class($value) : gettype($value)
            ));
        }
    }
}