Settings::clear() - Code Metrics - Inspection of "Merge pull request #219 from tw2066/setting" - smi2/phpClickHouse - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( e1fd7c...ba32b0 )

by Igor

created 2024-07-17 07:45 UTC

Settings::clear() A

↳ Parent: Settings

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	1
eloc	1
c	1
b	0
f	1
nc	1
nop	0
dl	0
loc	3
ccs	1
cts	1
cp	1
crap	1
rs	10

<?php


namespace ClickHouseDB;

class Settings
{
    /**

     * @var array

     */
    private $settings = [];

    private $_ReadOnlyUser = false;


    /**
     * Settings constructor.

     */
    public function __construct()
    {
        $default = [
            'extremes' => false,
            'readonly' => true,
            'max_execution_time' => 20.0,
            'enable_http_compression' => 1,
            'https' => false,
        ];

        $this->settings = $default;
    }

    /**
     * @param string|int $key

     * @return mixed
     */
    public function get($key)
    {
        if (!$this->is($key)) {

            return null;
        }
        return $this->settings[$key];

    }

    /**
     * @param string|int $key

     * @return bool
     */
    public function is($key)

    {
        return isset($this->settings[$key]);
    }



    /**
     * @param string|int $key

     * @param mixed $value

     * @return $this
     */
    public function set($key, $value)
    {
        $this->settings[$key] = $value;
        return $this;

    }

    /**
     * @return mixed
     */
    public function getDatabase()
    {
        return $this->get('database');
    }

    /**
     * @param string $db

     * @return $this
     */
    public function database($db)

    {
        $this->set('database', $db);
        return $this;

    }

    /**
     * @return int

     */
    public function getTimeOut(): int

    {
        return intval($this->get('max_execution_time'));

    }

    /**
     * @return mixed|null
     */
    public function isEnableHttpCompression()
    {
        return $this->getSetting('enable_http_compression');
    }

    /**
     * @param bool|int $flag

     * @return $this
     */
    public function enableHttpCompression($flag)
    {
        $this->set('enable_http_compression', intval($flag));

        return $this;

    }



    public function https($flag = true)

    {
        $this->set('https', $flag);
        return $this;

    }

    public function isHttps()

    {
        return $this->get('https');
    }



    /**
     * @param int|bool $flag

     * @return $this
     */
    public function readonly($flag)
    {
        $this->set('readonly', $flag);
        return $this;

    }

    /**
     * @param string $session_id

     * @return $this
     */
    public function session_id($session_id)

    {
        $this->set('session_id', $session_id);

        return $this;

    }

    /**
     * @return mixed|bool
     */
    public function getSessionId()
    {
        if (empty($this->settings['session_id'])) {

            return false;
        }
        return $this->get('session_id');

    }

    /**
     * @return string|bool
     */
    public function makeSessionId()
    {
        $this->session_id(sha1(uniqid('', true)));

        return $this->getSessionId();

    }

    /**
     *
     * max_execution_time - is integer in Seconds clickhouse source

     *
     * @param int $time

     * @return $this
     */
    public function max_execution_time(int $time)

    {
        $this->set('max_execution_time',$time);
        return $this;

    }

    /**
     * @return array

     */
    public function getSettings()

    {
        return $this->settings;
    }

    /**
     * @param array $settings_array

     * @return $this
     */
    public function apply(array $settings_array)

    {
        foreach ($settings_array as $key => $value) {

            $this->set($key, $value);
        }

        return $this;
    }

    /**
     * @param int|bool $flag
     */
    public function setReadOnlyUser($flag):void

    {
        $this->_ReadOnlyUser = $flag;

    }

    /**
     * @return bool

     */
    public function isReadOnlyUser():bool

    {
        return $this->_ReadOnlyUser;

    }

    /**
     * @param string $name

     * @return mixed|null
     */
    public function getSetting(string $name)
    {
        if (!isset($this->settings[$name])) {

            return null;
        }

        return $this->get($name);
    }

    public function clear():void

    {
        $this->settings = [];
    }
}


1		<?php
		0 ignored issues – show introduced 2019-03-13 07:05 UTC by Report Bug Copy Issue Report Missing declare(strict_types=1). Loading history...
2
3		namespace ClickHouseDB;
4
5		class Settings
6		{
7		/**
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Found multi-line comment for property \ClickHouseDB\Settings::$settings with single line content, use one-line comment instead. Loading history...
8		* @var array
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report @var annotation of property \ClickHouseDB\Settings::$settings does not specify type hint for its items. Loading history...
9		*/
10		private $settings = [];
11
12		private $_ReadOnlyUser = false;
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Property \ClickHouseDB\Settings::$_ReadOnlyUser does not have @var annotation for its value. Loading history... Coding Style introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Member variable "_ReadOnlyUser" is not in valid camel caps format Loading history...
13
14		/**
15		* Settings constructor.
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Documentation comment contains forbidden comment "Settings constructor.". Loading history...
16		*/
17		public function __construct()
18		{
19		$default = [
20		'extremes' => false,
21		'readonly' => true,
22		'max_execution_time' => 20.0,
23		'enable_http_compression' => 1,
24		'https' => false,
25		];
26
27		$this->settings = $default;
28		}
29
30	68	/**
31		* @param string\|int $key
		0 ignored issues – show introduced 2018-09-26 10:27 UTC by Report Bug Copy Issue Report Incorrect annotations group. Loading history...
32		* @return mixed
33	68	*/
34		public function get($key)
35		{
36		if (!$this->is($key)) {
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Expected 1 lines after "if", found 0. Loading history... Coding Style introduced 2024-01-10 11:49 UTC by Report Bug Copy Issue Report Expected 1 space after NOT operator; 0 found Loading history...
37		return null;
38		}
39		return $this->settings[$key];
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Expected 1 lines before "return", found 0. Loading history...
40	68	}
41	68
42	68	/**
43		* @param string\|int $key
		0 ignored issues – show introduced 2018-09-26 10:27 UTC by Report Bug Copy Issue Report Incorrect annotations group. Loading history...
44		* @return bool
45		*/
46		public function is($key)
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::is() does not have native return type hint for its return value but it should be possible to add it based on @return annotation "bool". Loading history...
47		{
48	55	return isset($this->settings[$key]);
49		}
		0 ignored issues – show Coding Style introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Expected 1 blank line after function; 2 found Loading history...
50	55
51
52		/**
53	55	* @param string\|int $key
		0 ignored issues – show introduced 2018-09-26 10:27 UTC by Report Bug Copy Issue Report Incorrect annotations group. Loading history...
54		* @param mixed $value
		0 ignored issues – show Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Expected 6 spaces after parameter type; 1 found Loading history...
55		* @return $this
56		*/
57		public function set($key, $value)
58		{
59		$this->settings[$key] = $value;
60	55	return $this;
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Expected 1 lines before "return", found 0. Loading history...
61		}
62	55
63		/**
64		* @return mixed
65		*/
66		public function getDatabase()
67		{
68		return $this->get('database');
69		}
70
71	68	/**
72		* @param string $db
		0 ignored issues – show introduced 2018-09-26 10:27 UTC by Report Bug Copy Issue Report Incorrect annotations group. Loading history...
73	68	* @return $this
74	68	*/
75		public function database($db)
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::database() does not have native type hint for its parameter $db but it should be possible to add it based on @param annotation "string". Loading history...
76		{
77		$this->set('database', $db);
78		return $this;
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Expected 1 lines before "return", found 0. Loading history...
79		}
80	1
81		/**
82	1	* @return int
		0 ignored issues – show introduced 2022-08-03 17:13 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::getTimeOut() has useless @return annotation. Loading history...
83		*/
84		public function getTimeOut(): int
		0 ignored issues – show introduced 2022-08-03 17:13 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::getTimeOut() does not need documentation comment. Loading history...
85		{
86		return intval($this->get('max_execution_time'));
		0 ignored issues – show introduced 2022-12-20 18:31 UTC by Report Bug Copy Issue Report Function intval() should not be referenced via a fallback global name, but via a use statement. Loading history...
87		}
88
89	68	/**
90		* @return mixed\|null
91	68	*/
92	68	public function isEnableHttpCompression()
93		{
94		return $this->getSetting('enable_http_compression');
95		}
96
97		/**
98	46	* @param bool\|int $flag
		0 ignored issues – show introduced 2018-09-26 10:27 UTC by Report Bug Copy Issue Report Incorrect annotations group. Loading history...
99		* @return $this
100	46	*/
101		public function enableHttpCompression($flag)
102		{
103		$this->set('enable_http_compression', intval($flag));
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Function intval() should not be referenced via a fallback global name, but via a use statement. Loading history...
104		return $this;
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Expected 1 lines before "return", found 0. Loading history...
105		}
		0 ignored issues – show Coding Style introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Expected 1 blank line after function; 2 found Loading history...
106	45
107
108	45	public function https($flag = true)
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::https() does not have parameter type hint nor @param annotation for its parameter $flag. Loading history... introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::https() does not have return type hint nor @return annotation for its return value. Loading history...
109		{
110		$this->set('https', $flag);
111		return $this;
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Expected 1 lines before "return", found 0. Loading history...
112		}
113
114		public function isHttps()
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::isHttps() does not have return type hint nor @return annotation for its return value. Loading history...
115	68	{
116		return $this->get('https');
117	68	}
		0 ignored issues – show Coding Style introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Expected 1 blank line after function; 2 found Loading history...
118	68
119
120		/**
121		* @param int\|bool $flag
		0 ignored issues – show introduced 2018-09-26 10:27 UTC by Report Bug Copy Issue Report Incorrect annotations group. Loading history...
122	1	* @return $this
123		*/
124	1	public function readonly($flag)
125	1	{
126		$this->set('readonly', $flag);
127		return $this;
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Expected 1 lines before "return", found 0. Loading history...
128	55	}
129
130	55	/**
131		* @param string $session_id
		0 ignored issues – show introduced 2018-09-26 10:27 UTC by Report Bug Copy Issue Report Incorrect annotations group. Loading history...
132		* @return $this
133		*/
134		public function session_id($session_id)
		0 ignored issues – show Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method name "Settings::session_id" is not in camel caps format Loading history... introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::session_id() does not have native type hint for its parameter $session_id but it should be possible to add it based on @param annotation "string". Loading history... Coding Style introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report The variable `$session_id` should be in camel caps format. Loading history...
135		{
136		$this->set('session_id', $session_id);
		0 ignored issues – show Coding Style introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report The variable `$session_id` should be in camel caps format. Loading history...
137		return $this;
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Expected 1 lines before "return", found 0. Loading history...
138		}
139
140		/**
141		* @return mixed\|bool
142		*/
143		public function getSessionId()
144		{
145		if (empty($this->settings['session_id'])) {
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Expected 1 lines after "if", found 0. Loading history...
146		return false;
147		}
148	2	return $this->get('session_id');
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Expected 1 lines before "return", found 0. Loading history...
149		}
150	2
151	2	/**
152		* @return string\|bool
153		*/
154		public function makeSessionId()
155		{
156		$this->session_id(sha1(uniqid('', true)));
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Function sha1() should not be referenced via a fallback global name, but via a use statement. Loading history... introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Function uniqid() should not be referenced via a fallback global name, but via a use statement. Loading history...
157	46	return $this->getSessionId();
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Expected 1 lines before "return", found 0. Loading history...
158		}
159	46
160	46	/**
161		*
162	2	* max_execution_time - is integer in Seconds clickhouse source
		0 ignored issues – show introduced 2022-12-20 18:31 UTC by Report Bug Copy Issue Report Expected 0 lines before first content, found 1. Loading history...
163		*
164		* @param int $time
		0 ignored issues – show introduced 2019-04-28 21:28 UTC by Report Bug Copy Issue Report Incorrect annotations group. Loading history... introduced 2022-08-03 17:13 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::max_execution_time() has useless @param annotation for parameter $time. Loading history...
165		* @return $this
166		*/
167		public function max_execution_time(int $time)
		0 ignored issues – show Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method name "Settings::max_execution_time" is not in camel caps format Loading history...
168	2	{
169		$this->set('max_execution_time',$time);
170	2	return $this;
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Expected 1 lines before "return", found 0. Loading history...
171	2	}
172
173		/**
174		* @return array
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report @return annotation of method \ClickHouseDB\Settings::getSettings() does not specify type hint for items of its traversable return value. Loading history...
175		*/
176		public function getSettings()
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::getSettings() does not have native return type hint for its return value but it should be possible to add it based on @return annotation "array". Loading history...
177		{
178	2	return $this->settings;
179		}
180	2
181	2	/**
182		* @param array $settings_array
		0 ignored issues – show introduced 2018-09-26 10:27 UTC by Report Bug Copy Issue Report Incorrect annotations group. Loading history... introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report @param annotation of method \ClickHouseDB\Settings::apply() does not specify type hint for items of its traversable parameter $settings_array. Loading history...
183		* @return $this
184		*/
185		public function apply(array $settings_array)
		0 ignored issues – show Coding Style introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report The variable `$settings_array` should be in camel caps format. Loading history...
186		{
187	45	foreach ($settings_array as $key => $value) {
		0 ignored issues – show Coding Style introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report The variable `$settings_array` should be in camel caps format. Loading history...
188		$this->set($key, $value);
189	45	}
190
191		return $this;
192		}
193
194		/**
195		* @param int\|bool $flag
196	1	*/
197		public function setReadOnlyUser($flag):void
		0 ignored issues – show introduced 2022-12-20 18:31 UTC by Report Bug Copy Issue Report There must be exactly one space between return type hint colon and return type hint. Loading history...
198	1	{
199	1	$this->_ReadOnlyUser = $flag;
		0 ignored issues – show Coding Style introduced 2021-10-08 16:39 UTC by Report Bug Copy Issue Report Member variable "_ReadOnlyUser" is not in valid camel caps format Loading history...
200		}
201
202	1	/**
203		* @return bool
		0 ignored issues – show introduced 2022-12-20 18:31 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::isReadOnlyUser() has useless @return annotation. Loading history...
204		*/
205		public function isReadOnlyUser():bool
		0 ignored issues – show introduced 2022-12-20 18:31 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::isReadOnlyUser() does not need documentation comment. Loading history... introduced 2022-12-20 18:31 UTC by Report Bug Copy Issue Report There must be exactly one space between return type hint colon and return type hint. Loading history...
206		{
207		return $this->_ReadOnlyUser;
		0 ignored issues – show Coding Style introduced 2021-10-08 16:39 UTC by Report Bug Copy Issue Report Member variable "_ReadOnlyUser" is not in valid camel caps format Loading history...
208		}
209
210		/**
211		* @param string $name
		0 ignored issues – show introduced 2018-09-26 10:27 UTC by Report Bug Copy Issue Report Incorrect annotations group. Loading history... introduced 2022-12-20 18:31 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::getSetting() has useless @param annotation for parameter $name. Loading history...
212		* @return mixed\|null
213		*/
214		public function getSetting(string $name)
215		{
216	45	if (!isset($this->settings[$name])) {
		0 ignored issues – show Coding Style introduced 2024-01-10 11:49 UTC by Report Bug Copy Issue Report Expected 1 space after NOT operator; 0 found Loading history...
217		return null;
218	45	}
219
220		return $this->get($name);
221		}
222
223		public function clear():void
		0 ignored issues – show introduced 2024-07-12 10:23 UTC by Report Bug Copy Issue Report There must be exactly one space between return type hint colon and return type hint. Loading history...
224		{
225	46	$this->settings = [];
226		}
227		}
228

smi2 / phpClickHouse

Push — master ( e1fd7c...ba32b0 )

Settings::clear() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like