AbstractConfiguration::set() - Code Metrics - Inspection of "Add the possibility to set configuration later" - platine-php/stdlib - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( af8d5e...153c33 )

by nguereza

created 2022-09-01 04:05 UTC

AbstractConfiguration::set() A

↳ Parent: AbstractConfiguration

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	5
nc	2
nop	2
dl	0
loc	8
rs	10
c	0
b	0
f	0

<?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   http://www.iacademy.cf
 *  @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)
    {
        if (!$this->has($name)) {
            throw new InvalidArgumentException(sprintf(
                'Configuration [%s] does not exist',
                $name
            ));
        }

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

    /**
     * {@inheritedoc}
     */
    public function set(string $name, $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);
    }

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

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

        foreach ($rules as $name => $type) {
            $this->checkType($name, $type);
        }

        foreach ($config as $name => $value) {
            $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 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 null|mixed $value
     * @return void
     */
    private function checkType(string $key, string $type, $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)
            ));
        }
    }
}


1			<?php
2
3			/**
4			* Platine Stdlib
5			*
6			* Platine Stdlib is a the collection of frequently used php features
7			*
8			* This content is released under the MIT License (MIT)
9			*
10			* Copyright (c) 2020 Platine Stdlib
11			*
12			* Permission is hereby granted, free of charge, to any person obtaining a copy
13			* of this software and associated documentation files (the "Software"), to deal
14			* in the Software without restriction, including without limitation the rights
15			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16			* copies of the Software, and to permit persons to whom the Software is
17			* furnished to do so, subject to the following conditions:
18			*
19			* The above copyright notice and this permission notice shall be included in all
20			* copies or substantial portions of the Software.
21			*
22			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28			* SOFTWARE.
29			*/
30
31			/**
32			* @file AbstractConfiguration.php
33			*
34			* The base class for application
35			*
36			* @package Platine\Stdlib\Config
37			* @author Platine Developers Team
38			* @copyright Copyright (c) 2020
39			* @license http://opensource.org/licenses/MIT MIT License
40			* @link http://www.iacademy.cf
41			* @version 1.0.0
42			* @filesource
43			*/
44
45			declare(strict_types=1);
46
47			namespace Platine\Stdlib\Config;
48
49			use Error;
50			use InvalidArgumentException;
51			use Platine\Stdlib\Contract\ConfigurationInterface;
52			use Platine\Stdlib\Helper\Arr;
53			use Platine\Stdlib\Helper\Str;
54
55			/**
56			* Class AbstractConfiguration
57			* @package Platine\Stdlib\Config
58			*/
59			abstract class AbstractConfiguration implements ConfigurationInterface
60			{
61			/**
62			* The raw configuration array
63			* @var array<string, mixed>
64			*/
65			protected array $config = [];
66
67			/**
68			* {@inheritedoc}
69			*/
70			public function __construct(array $config = [])
71			{
72			$configuration = array_merge($this->getDefault(), $config);
73			$this->load($configuration);
74			}
75
76			/**
77			* {@inheritedoc}
78			*/
79			public function get(string $name)
80			{
81			if (!$this->has($name)) {
82			throw new InvalidArgumentException(sprintf(
83			'Configuration [%s] does not exist',
84			$name
85			));
86			}
87
88			return Arr::get($this->config, $name);
89			}
90
91			/**
92			* {@inheritedoc}
93			*/
94			public function set(string $name, $value): void
95			{
96			$rules = $this->getValidationRules();
97			if (array_key_exists($name, $rules)) {
98			$type = $rules[$name];
99			$this->checkType($name, $type, $value);
100			}
101			Arr::set($this->config, $name, $value);
102			}
103
104			/**
105			* {@inheritedoc}
106			*/
107			public function has(string $name): bool
108			{
109			return Arr::has($this->config, $name);
110			}
111
112			/**
113			* {@inheritedoc}
114			*/
115			public function load(array $config): void
116			{
117			$this->config = $config;
118			$rules = $this->getValidationRules();
119			$setters = $this->getSetterMaps();
120
121			foreach ($rules as $name => $type) {
122			$this->checkType($name, $type);
123			}
124
125			foreach ($config as $name => $value) {
126			$key = Str::camel($name, true);
127
128			if (Arr::has($setters, $key)) {
129			$method = Arr::get($setters, $key);
130			$this->{$method}($value);
131			} else {
132			$setterMethod = 'set' . ucfirst($key);
133			if (method_exists($this, $setterMethod)) {
134			$this->{$setterMethod}($value);
135			} else {
136			$this->{$key} = $value;
137			}
138			}
139			}
140			}
141
142			/**
143			* {@inheritedoc}
144			*/
145			public function getValidationRules(): array
146			{
147			return [];
148			}
149
150			/**
151			* {@inheritedoc}
152			*/
153			public function getSetterMaps(): array
154			{
155			return [];
156			}
157
158			/**
159			* {@inheritedoc}
160			*/
161			public function getDefault(): array
162			{
163			return [];
164			}
165
166			/**
167			* Check the configuration for the given type
168			* @param string $key the configuration
169			* key to be checked can be dot notation
170			* @param string $type
171			* @param null\|mixed $value
172			* @return void
173			*/
174			private function checkType(string $key, string $type, $value = null): void
175			{
176			if (!Arr::has($this->config, $key) && $value === null) {
177			return;
178			}
179
180			if ($value === null) {
181			$value = Arr::get($this->config, $key, null);
182			}
183
184			$valueType = gettype($value);
185			$className = null;
186			if (strpos($type, 'object::') === 0) {
187			$className = substr($type, 8);
188			}
189
190			$error = null;
191
192			if ($className !== null) {
193			if (!($value instanceof $className)) {
194			$error = 'Invalid configuration [%s] instance value, expected [%s], but got [%s]';
195			}
196			} elseif ($type !== $valueType) {
197			$error = 'Invalid configuration [%s] value, expected [%s], but got [%s]';
198			}
199
200			if ($error !== null) {
201			throw new Error(sprintf(
202			$error,
203			Str::snake($key),
204			$className ?? $type,
205			is_object($value) ? get_class($value) : gettype($value)
206			));
207			}
208			}
209			}
210

platine-php / stdlib

Push — develop ( af8d5e...153c33 )

AbstractConfiguration::set() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like