Config::__construct() - Code Metrics - Inspection of "Deep refactoring of library" - DrTeamRocks/uon - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#15)

by Mr

created 2021-02-20 19:53 UTC

Config::__construct() A

↳ Parent: Config

Complexity

Conditions	2
Paths	2

Size

Total Lines	28
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2.1481

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	14
nc	2
nop	1
dl	0
loc	28
rs	9.7998
c	1
b	0
f	0
ccs	4
cts	6
cp	0.6667
crap	2.1481

<?php

namespace Uon;

use Uon\Exceptions\UonParameterNotAllowedException;
use Uon\Exceptions\UonParameterNotSetException;
use Uon\Interfaces\ConfigInterface;
use function in_array;
use function implode;

class Config implements ConfigInterface
{
    /**
     * List of allowed parameters
     */
    public const ALLOWED = [
        'token',
        'proxy',
        'base_uri',
        'handler',
        'user_agent',
        'timeout',
        'tries',
        'seconds',
        'debug',
        'verbose',
        'track_redirects',
        'format',
    ];

    /**
     * List of minimal required parameters
     */
    public const REQUIRED = [
        'token',
        'base_uri',
        'user_agent',
        'timeout',
    ];

    /**
     * List of configured parameters
     *
     * @var array
     */
    private $parameters;

    /**
     * Config constructor.
     *
     * @param array $parameters List of parameters which can be set on object creation stage
     *
     * @throws \ErrorException
     */
    public function __construct(array $parameters = [])
    {
        // Set default parameters of client
        $this->parameters = [
            // Errors must be disabled by default, because we need to get error codes
            // @link http://docs.guzzlephp.org/en/stable/request-options.html#http-errors
            'http_errors'     => false,

            // Wrapper settings
            'tries'           => 2,  // Count of tries
            'seconds'         => 10, // Waiting time per each try

            // Optional parameters
            'debug'           => false,
            'track_redirects' => false,
            'verbose'         => false,
            'format'          => 'json',

            // Main parameters
            'auto_exec'       => true,
            'timeout'         => 20,
            'user_agent'      => 'U-On PHP Client v2.x',
            'base_uri'        => 'https://api.u-on.ru',
        ];

        // Overwrite parameters by client input
        foreach ($parameters as $key => $value) {
            $this->set($key, $value);
        }
    }

    /**
     * Magic setter parameter by name
     *
     * @param string               $parameter Name of parameter
     * @param string|bool|int|null $value     Value of parameter
     *
     * @throws \ErrorException
     */
    public function __set(string $parameter, $value)
    {
        $this->set($parameter, $value);
    }

    /**
     * Check if parameter if available
     *
     * @param string $parameter Name of parameter
     *
     * @return bool
     */
    public function __isset(string $parameter): bool
    {
        return isset($this->parameters[$parameter]);
    }

    /**
     * Get parameter via magic call
     *
     * @param string $parameter Name of parameter
     *
     * @return bool|int|string|null
     * @throws \ErrorException
     */
    public function __get(string $parameter)
    {
        return $this->get($parameter);
    }

    /**
     * Remove parameter from array
     *
     * @param string $parameter Name of parameter
     */
    public function __unset(string $parameter)
    {
        unset($this->parameters[$parameter]);
    }

    /**
     * Set parameter by name
     *
     * @param string               $parameter Name of parameter
     * @param string|bool|int|null $value     Value of parameter
     *
     * @return \Uon\Interfaces\ConfigInterface
     * @throws \Uon\Exceptions\UonParameterNotAllowedException
     */
    public function set(string $parameter, $value): ConfigInterface
    {
        if (!in_array($parameter, self::ALLOWED, false)) {
            throw new UonParameterNotAllowedException("Parameter \"$parameter\" is not allowed [" . implode(',', self::ALLOWED) . ']');
        }

        // Add parameters into array
        $this->parameters[$parameter] = $value;
        return $this;
    }

    /**
     * Get available parameter by name
     *
     * @param string $parameter Name of parameter
     *
     * @return bool|int|string|null
     * @throws \Uon\Exceptions\UonParameterNotSetException
     */
    public function get(string $parameter)
    {
        if (!isset($this->parameters[$parameter])) {

            if ($parameter === 'auto_exec') {
                return true;
            }

            if ($parameter === 'debug') {
                return false;
            }

            throw new UonParameterNotSetException("Parameter \"$parameter\" is not in set");
        }

        return $this->parameters[$parameter];
    }

    /**
     * Get all available parameters
     *
     * @return array
     */
    public function all(): array
    {
        return $this->parameters;
    }

    /**
     * Return all ready for Guzzle parameters
     *
     * @return array
     * @throws \Uon\Exceptions\UonParameterNotSetException
     */
    public function guzzle(): array
    {
        $options = [
            // 'base_uri'        => $this->get('base_uri'), // By some reasons base_uri option is not work anymore
            'timeout'         => $this->get('timeout'),
            'track_redirects' => $this->get('track_redirects'),
            'debug'           => $this->get('debug'),
            'headers'         => [
                'User-Agent' => $this->get('user_agent'),
            ],
        ];

        // Proxy is optional
        if (isset($this->proxy)) {

            $options['proxy'] = $this->proxy;
        }

        // Handler is optional for tests
        if (isset($this->handler)) {

            $options['handler'] = $this->handler;
        }

        return $options;
    }
}


1		<?php
2
3		namespace Uon;
4
5		use Uon\Exceptions\UonParameterNotAllowedException;
6		use Uon\Exceptions\UonParameterNotSetException;
7		use Uon\Interfaces\ConfigInterface;
8		use function in_array;
9		use function implode;
10
11		class Config implements ConfigInterface
12		{
13		/**
14		* List of allowed parameters
15		*/
16		public const ALLOWED = [
17		'token',
18		'proxy',
19		'base_uri',
20		'handler',
21		'user_agent',
22		'timeout',
23		'tries',
24		'seconds',
25		'debug',
26		'verbose',
27		'track_redirects',
28		'format',
29		];
30
31		/**
32		* List of minimal required parameters
33		*/
34		public const REQUIRED = [
35		'token',
36		'base_uri',
37		'user_agent',
38		'timeout',
39		];
40
41		/**
42		* List of configured parameters
43		*
44		* @var array
45		*/
46		private $parameters;
47
48		/**
49		* Config constructor.
50		*
51		* @param array $parameters List of parameters which can be set on object creation stage
52		*
53		* @throws \ErrorException
54		*/
55		public function __construct(array $parameters = [])
56		{
57		// Set default parameters of client
58		$this->parameters = [
59		// Errors must be disabled by default, because we need to get error codes
60	2	// @link http://docs.guzzlephp.org/en/stable/request-options.html#http-errors
61		'http_errors' => false,
62	2
63	2	// Wrapper settings
64	2	'tries' => 2, // Count of tries
65		'seconds' => 10, // Waiting time per each try
66
67		// Optional parameters
68		'debug' => false,
69		'track_redirects' => false,
70		'verbose' => false,
71		'format' => 'json',
72
73		// Main parameters
74		'auto_exec' => true,
75		'timeout' => 20,
76		'user_agent' => 'U-On PHP Client v2.x',
77		'base_uri' => 'https://api.u-on.ru',
78		];
79
80		// Overwrite parameters by client input
81		foreach ($parameters as $key => $value) {
82		$this->set($key, $value);
83		}
84	2	}
85
86	2	/**
87		* Magic setter parameter by name
88	2	*
89	2	* @param string $parameter Name of parameter
90	2	* @param string\|bool\|int\|null $value Value of parameter
91	2	*
92	2	* @throws \ErrorException
93	2	*/
94	2	public function __set(string $parameter, $value)
95	2	{
96		$this->set($parameter, $value);
97		}
98
99		/**
100		* Check if parameter if available
101		*
102		* @param string $parameter Name of parameter
103		*
104		* @return bool
105		*/
106		public function __isset(string $parameter): bool
107		{
108		return isset($this->parameters[$parameter]);
109		}
110
111		/**
112		* Get parameter via magic call
113		*
114		* @param string $parameter Name of parameter
115		*
116		* @return bool\|int\|string\|null
117		* @throws \ErrorException
118		*/
119		public function __get(string $parameter)
120		{
121		return $this->get($parameter);
122		}
123
124		/**
125		* Remove parameter from array
126		*
127		* @param string $parameter Name of parameter
128		*/
129		public function __unset(string $parameter)
130		{
131		unset($this->parameters[$parameter]);
132		}
133
134		/**
135		* Set parameter by name
136		*
137		* @param string $parameter Name of parameter
138		* @param string\|bool\|int\|null $value Value of parameter
139		*
140		* @return \Uon\Interfaces\ConfigInterface
141		* @throws \Uon\Exceptions\UonParameterNotAllowedException
142		*/
143		public function set(string $parameter, $value): ConfigInterface
144		{
145		if (!in_array($parameter, self::ALLOWED, false)) {
146		throw new UonParameterNotAllowedException("Parameter \"$parameter\" is not allowed [" . implode(',', self::ALLOWED) . ']');
147		}
148
149		// Add parameters into array
150		$this->parameters[$parameter] = $value;
151		return $this;
152		}
153
154		/**
155		* Get available parameter by name
156		*
157		* @param string $parameter Name of parameter
158		*
159		* @return bool\|int\|string\|null
160		* @throws \Uon\Exceptions\UonParameterNotSetException
161		*/
162		public function get(string $parameter)
163		{
164		if (!isset($this->parameters[$parameter])) {
165
166		if ($parameter === 'auto_exec') {
167		return true;
168		}
169
170		if ($parameter === 'debug') {
171		return false;
172		}
173
174		throw new UonParameterNotSetException("Parameter \"$parameter\" is not in set");
175		}
176
177		return $this->parameters[$parameter];
178		}
179
180		/**
181		* Get all available parameters
182		*
183		* @return array
184		*/
185		public function all(): array
186		{
187		return $this->parameters;
188		}
189
190		/**
191		* Return all ready for Guzzle parameters
192		*
193		* @return array
194		* @throws \Uon\Exceptions\UonParameterNotSetException
195		*/
196		public function guzzle(): array
197		{
198		$options = [
199		// 'base_uri' => $this->get('base_uri'), // By some reasons base_uri option is not work anymore
200		'timeout' => $this->get('timeout'),
201		'track_redirects' => $this->get('track_redirects'),
202		'debug' => $this->get('debug'),
203		'headers' => [
204		'User-Agent' => $this->get('user_agent'),
205		],
206		];
207
208		// Proxy is optional
209		if (isset($this->proxy)) {
		0 ignored issues – show Bug Best Practice introduced 2021-02-20 19:58 UTC by Report Bug Copy Issue Report The property `proxy` does not exist on `Uon\Config`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
210		$options['proxy'] = $this->proxy;
211		}
212
213		// Handler is optional for tests
214		if (isset($this->handler)) {
		0 ignored issues – show Bug Best Practice introduced 2021-02-20 19:58 UTC by Report Bug Copy Issue Report The property `handler` does not exist on `Uon\Config`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
215		$options['handler'] = $this->handler;
216		}
217
218		return $options;
219		}
220		}
221

DrTeamRocks / uon

Pull Request — master (#15)

Config::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like