AbstractConfiguration::get() - Code Metrics - Inspection of "Add method has in configuration" - platine-php/stdlib - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( 5ffe5c...32af0c )

by nguereza

created 2021-06-20 06:08 UTC

AbstractConfiguration::get() A

↳ Parent: AbstractConfiguration

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?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 = [])
    {
        $this->load($config);
    }

    /**
     * {@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 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 ($config as $name => $value) {
            $key = Str::camel($name, true);
            if (property_exists($this, $key)) {
                $this->checkValue($key, $value, $rules);

                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 [];
    }

    /**
     * Check the configuration for the given type
     * @param string $key
     * @param mixed $value
     * @param array<string, string> $rules
     * @return void
     */
    private function checkValue(string $key, $value, array $rules = []): void
    {
        if (array_key_exists($key, $rules)) {
            $expectedType = $rules[$key];
            $type = gettype($value);
            $className = null;
            if (strpos($expectedType, 'object::') === 0) {
                $className = substr($expectedType, 8);
            }

            $error = null;

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

            if ($error !== null) {
                throw new Error(sprintf(
                    $error,
                    Str::snake($key),
                    $className ?? $expectedType,
                    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			/**
63			* The raw configuration array
64			* @var array<string, mixed>
65			*/
66			protected array $config = [];
67
68			/**
69			* {@inheritedoc}
70			*/
71			public function __construct(array $config = [])
72			{
73			$this->load($config);
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 has(string $name): bool
95			{
96			return Arr::has($this->config, $name);
97			}
98
99			/**
100			* {@inheritedoc}
101			*/
102			public function load(array $config): void
103			{
104			$this->config = $config;
105			$rules = $this->getValidationRules();
106			$setters = $this->getSetterMaps();
107
108			foreach ($config as $name => $value) {
109			$key = Str::camel($name, true);
110			if (property_exists($this, $key)) {
111			$this->checkValue($key, $value, $rules);
112
113			if (Arr::has($setters, $key)) {
114			$method = Arr::get($setters, $key);
115			$this->{$method}($value);
116			} else {
117			$setterMethod = 'set' . ucfirst($key);
118			if (method_exists($this, $setterMethod)) {
119			$this->{$setterMethod}($value);
120			} else {
121			$this->{$key} = $value;
122			}
123			}
124			}
125			}
126			}
127
128			/**
129			* {@inheritedoc}
130			*/
131			public function getValidationRules(): array
132			{
133			return [];
134			}
135
136			/**
137			* {@inheritedoc}
138			*/
139			public function getSetterMaps(): array
140			{
141			return [];
142			}
143
144			/**
145			* Check the configuration for the given type
146			* @param string $key
147			* @param mixed $value
148			* @param array<string, string> $rules
149			* @return void
150			*/
151			private function checkValue(string $key, $value, array $rules = []): void
152			{
153			if (array_key_exists($key, $rules)) {
154			$expectedType = $rules[$key];
155			$type = gettype($value);
156			$className = null;
157			if (strpos($expectedType, 'object::') === 0) {
158			$className = substr($expectedType, 8);
159			}
160
161			$error = null;
162
163			if ($className !== null) {
164			if (!($value instanceof $className)) {
165			$error = 'Invalid configuration [%s] instance value, expected [%s], but got [%s]';
166			}
167			} elseif ($type !== $expectedType) {
168			$error = 'Invalid configuration [%s] value, expected [%s], but got [%s]';
169			}
170
171			if ($error !== null) {
172			throw new Error(sprintf(
173			$error,
174			Str::snake($key),
175			$className ?? $expectedType,
176			is_object($value) ? get_class($value) : gettype($value)
177			));
178			}
179			}
180			}
181			}
182

platine-php / stdlib

Push — develop ( 5ffe5c...32af0c )

AbstractConfiguration::get() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like