Settings::session_id() - Code Metrics - Inspection of "Add test for Connection without port #77" - smi2/phpClickHouse - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1606b5...4950b0 )

by Igor

created 2018-07-24 07:02 UTC

Settings::session_id() A

↳ Parent: Settings

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php


namespace ClickHouseDB;

use ClickHouseDB\Transport\Http;

class Settings
{
    /**

     * @var Http
     */
    private $client = null;


    /**

     * @var array

     */
    private $settings = [];

    private $_ReadOnlyUser = false;


    /**

     * @var bool
     */
    private $_isHttps = false;


    /**
     * Settings constructor.

     * @param Http $client

     */
    public function __construct(Http $client)
    {
        $default = [
            'extremes'                => false,
            'readonly'                => true,
            'max_execution_time'      => 20,
            'enable_http_compression' => 0,
            'https'                   => false

        ];

        $this->settings = $default;
        $this->client = $client;
$a = "a";
$ab = "ab";
$abc = "abc";
    }

    /**
     * @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 mixed
     */
    public function getTimeOut()
    {
        return $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();
    }

    /**
     * @param int $time
     * @return $this
     */
    public function max_execution_time($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($settings_array)

    {
        foreach ($settings_array as $key => $value) {
            $this->set($key, $value);
        }

        return $this;
    }

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

    {
        $this->_ReadOnlyUser = $flag;
    }

    /**
     * @return bool
     */
    public function isReadOnlyUser()

    {
        return $this->_ReadOnlyUser;
    }

    /**
     * @param string $name
     * @return mixed|null
     */
    public function getSetting($name)

    {
        if (!isset($this->settings[$name])) {

            return null;
        }

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


1		<?php
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Missing declare(strict_types = 1). Loading history...
2
3		namespace ClickHouseDB;
4
5		use ClickHouseDB\Transport\Http;
6
7		class Settings
8		{
9		/**
		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::$client with single line content, use one-line comment instead. Loading history...
10		* @var Http
11		*/
12		private $client = null;
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Class Settings contains write-only property $client. Loading history...
13
14		/**
		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...
15		* @var array
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report @var annotation of property \ClickHouseDB\Settings::$settings does not specify type hint for its items. Loading history...
16		*/
17		private $settings = [];
18
19		private $_ReadOnlyUser = false;
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Property \ClickHouseDB\Settings::$_ReadOnlyUser does not have @var annotation. Loading history...
20
21		/**
		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::$_isHttps with single line content, use one-line comment instead. Loading history...
22		* @var bool
23		*/
24		private $_isHttps = false;
		0 ignored issues – show introduced 2018-05-14 13:41 UTC by Report Bug Copy Issue Report The private property `$_isHttps` is not used, and could be removed. Loading history... introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Class Settings contains unused property $_isHttps. Loading history...
25
26		/**
27		* 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...
28		* @param Http $client
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::__construct() has useless @param annotation for parameter $client. Loading history...
29		*/
30	54	public function __construct(Http $client)
31		{
32		$default = [
33	54	'extremes' => false,
34		'readonly' => true,
35		'max_execution_time' => 20,
36		'enable_http_compression' => 0,
37		'https' => false
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Multiline arrays must have a trailing comma after the last element. Loading history... Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Each line in an array declaration must end in a comma Loading history...
38		];
39
40	54	$this->settings = $default;
41	54	$this->client = $client;
		0 ignored issues – show Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
42	54	}
43
44		/**
45		* @param string\|int $key
46		* @return mixed
47		*/
48	44	public function get($key)
49		{
50	44	if (!$this->is($key)) {
		0 ignored issues – show Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report There must be a single space after a NOT operator; 0 found Loading history...
51		return null;
52		}
53	44	return $this->settings[$key];
54		}
55
56		/**
57		* @param string\|int $key
58		* @return bool
59		*/
60	44	public function is($key)
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::is() does not have return type hint for its return value but it should be possible to add it based on @return annotation "bool". Loading history...
61		{
62	44	return isset($this->settings[$key]);
63		}
64
65
66		/**
67		* @param string\|int $key
68		* @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...
69		* @return $this
70		*/
71	54	public function set($key, $value)
72		{
73	54	$this->settings[$key] = $value;
74	54	return $this;
75		}
76
77		/**
78		* @return mixed
79		*/
80	1	public function getDatabase()
81		{
82	1	return $this->get('database');
83		}
84
85		/**
86		* @param string $db
87		* @return $this
88		*/
89	54	public function database($db)
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::database() does not have parameter type hint for its parameter $db but it should be possible to add it based on @param annotation "string". Loading history...
90		{
91	54	$this->set('database', $db);
92	54	return $this;
93		}
94
95		/**
96		* @return mixed
97		*/
98	36	public function getTimeOut()
99		{
100	36	return $this->get('max_execution_time');
101		}
102
103		/**
104		* @return mixed\|null
105		*/
106	35	public function isEnableHttpCompression()
107		{
108	35	return $this->getSetting('enable_http_compression');
109		}
110
111		/**
112		* @param bool\|int $flag
113		* @return $this
114		*/
115	54	public function enableHttpCompression($flag)
116		{
117	54	$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...
118	54	return $this;
119		}
120
121
122	1	public function https($flag = true)
		0 ignored issues – show introduced 2018-07-08 20:56 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 2018-07-08 20:56 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...
123		{
124	1	$this->set('https', $flag);
125	1	return $this;
126		}
127
128	44	public function isHttps()
		0 ignored issues – show introduced 2018-07-08 20:56 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...
129		{
130	44	return $this->get('https');
131		}
132
133
134		/**
135		* @param int\|bool $flag
136		* @return $this
137		*/
138		public function readonly($flag)
139		{
140		$this->set('readonly', $flag);
141		return $this;
142		}
143
144		/**
145		* @param string $session_id
146		* @return $this
147		*/
148	2	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 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::session_id() does not have parameter type hint for its parameter $session_id but it should be possible to add it based on @param annotation "string". Loading history...
149		{
150	2	$this->set('session_id', $session_id);
151	2	return $this;
152		}
153		/**
154		* @return mixed\|bool
155		*/
156	36	public function getSessionId()
157		{
158	36	if (empty($this->settings['session_id'])) {
159	36	return false;
160		}
161	2	return $this->get('session_id');
162		}
163
164		/**
165		* @return string\|bool
166		*/
167	2	public function makeSessionId()
168		{
169	2	$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...
170	2	return $this->getSessionId();
171		}
172
173		/**
174		* @param int $time
175		* @return $this
176		*/
177	2	public function max_execution_time($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... introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::max_execution_time() does not have parameter type hint for its parameter $time but it should be possible to add it based on @param annotation "int". Loading history...
178		{
179	2	$this->set('max_execution_time', $time);
180	2	return $this;
181		}
182
183		/**
184		* @return array
		0 ignored issues – show introduced 2018-07-08 20:56 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...
185		*/
186	35	public function getSettings()
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::getSettings() does not have return type hint for its return value but it should be possible to add it based on @return annotation "array". Loading history...
187		{
188	35	return $this->settings;
189		}
190
191		/**
192		* @param array $settings_array
		0 ignored issues – show introduced 2018-07-08 20:56 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...
193		* @return $this
194		*/
195	2	public function apply($settings_array)
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::apply() does not have parameter type hint for its parameter $settings_array but it should be possible to add it based on @param annotation "array". Loading history...
196		{
197	2	foreach ($settings_array as $key => $value) {
198	2	$this->set($key, $value);
199		}
200
201	2	return $this;
202		}
203
204		/**
205		* @param int\|bool $flag
206		*/
207		public function setReadOnlyUser($flag)
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::setReadOnlyUser() does not have void return type hint. Loading history...
208		{
209		$this->_ReadOnlyUser = $flag;
210		}
211
212		/**
213		* @return bool
214		*/
215	35	public function isReadOnlyUser()
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::isReadOnlyUser() does not have return type hint for its return value but it should be possible to add it based on @return annotation "bool". Loading history...
216		{
217	35	return $this->_ReadOnlyUser;
218		}
219
220		/**
221		* @param string $name
222		* @return mixed\|null
223		*/
224	36	public function getSetting($name)
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Settings::getSetting() does not have parameter type hint for its parameter $name but it should be possible to add it based on @param annotation "string". Loading history...
225		{
226	36	if (!isset($this->settings[$name])) {
		0 ignored issues – show Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report There must be a single space after a NOT operator; 0 found Loading history...
227		return null;
228		}
229
230	36	return $this->get($name);
231		}
232		}
233

smi2 / phpClickHouse

Push — master ( 1606b5...4950b0 )

Settings::session_id() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like