Http::__findXClickHouseProgress() - Code Metrics - Inspection of "Add functions `type` in `Http`" - smi2/phpClickHouse - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 9a3a1b...103669 )

by Igor

created 2021-02-28 10:06 UTC

Http::__findXClickHouseProgress() B

↳ Parent: Http

Complexity

Conditions	8
Paths	7

Size

Total Lines	38
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	16
CRAP Score	8.512

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	8
eloc	20
c	3
b	0
f	0
nc	7
nop	1
dl	0
loc	38
ccs	16
cts	20
cp	0.8
crap	8.512
rs	8.4444

<?php

introduced 2019-03-13 07:05 UTC by

Missing declare(strict_types=1).

namespace ClickHouseDB\Transport;

use ClickHouseDB\Exception\TransportException;

use ClickHouseDB\Query\Degeneration;

use ClickHouseDB\Query\Query;

use ClickHouseDB\Query\WhereInFile;

use ClickHouseDB\Query\WriteToFile;

use ClickHouseDB\Settings;

use ClickHouseDB\Statement;

use const PHP_EOL;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines between different types of use statement, found 0.

class Http

    const AUTH_METHOD_HEADER       = 1;

introduced 2020-06-21 08:15 UTC by

Constant \ClickHouseDB\Transport\Http::AUTH_METHOD_HEADER visibility missing.

    const AUTH_METHOD_QUERY_STRING = 2;

introduced 2020-06-21 08:15 UTC by

Constant \ClickHouseDB\Transport\Http::AUTH_METHOD_QUERY_STRING visibility missing.

    const AUTH_METHOD_BASIC_AUTH   = 3;

introduced 2020-06-21 08:15 UTC by

Constant \ClickHouseDB\Transport\Http::AUTH_METHOD_BASIC_AUTH visibility missing.

    const AUTH_METHODS_LIST = [

introduced 2020-06-21 08:15 UTC by

Constant \ClickHouseDB\Transport\Http::AUTH_METHODS_LIST visibility missing.

        self::AUTH_METHOD_HEADER,

        self::AUTH_METHOD_QUERY_STRING,

        self::AUTH_METHOD_BASIC_AUTH,

];

/**

introduced 2020-06-21 08:15 UTC by

Found multi-line comment for property \ClickHouseDB\Transport\Http::$_username with single line content, use one-line comment instead.

     * @var string

*/

    private $_username = null;

/**

introduced 2018-07-08 20:56 UTC by

Found multi-line comment for property \ClickHouseDB\Transport\Http::$_password with single line content, use one-line comment instead.

     * @var string

*/

    private $_password = null;

/**

     * The username and password can be indicated in one of three ways:

     *  - Using HTTP Basic Authentication.

     *  - In the ‘user’ and ‘password’ URL parameters.

     *  - Using ‘X-ClickHouse-User’ and ‘X-ClickHouse-Key’ headers (by default)

     * @see https://clickhouse.tech/docs/en/interfaces/http/

introduced 2020-06-21 08:15 UTC by

Incorrect annotations group.

     * @var int

*/

    private $_authMethod = self::AUTH_METHOD_HEADER;

/**

introduced 2020-06-21 08:15 UTC by

Found multi-line comment for property \ClickHouseDB\Transport\Http::$_host with single line content, use one-line comment instead.

     * @var string

*/

    private $_host = '';

/**

introduced 2018-07-08 20:56 UTC by

Found multi-line comment for property \ClickHouseDB\Transport\Http::$_port with single line content, use one-line comment instead.

     * @var int

*/

    private $_port = 0;

/**

introduced 2018-07-08 20:56 UTC by

Found multi-line comment for property \ClickHouseDB\Transport\Http::$_verbose with single line content, use one-line comment instead.

     * @var bool|int

*/

    private $_verbose = false;

/**

introduced 2018-07-08 20:56 UTC by

Found multi-line comment for property \ClickHouseDB\Transport\Http::$_curler with single line content, use one-line comment instead.

     * @var CurlerRolling

*/

    private $_curler = null;

/**

introduced 2018-07-08 20:56 UTC by

Found multi-line comment for property \ClickHouseDB\Transport\Http::$_settings with single line content, use one-line comment instead.

     * @var Settings

*/

    private $_settings = null;

/**

introduced 2018-07-08 20:56 UTC by

Found multi-line comment for property \ClickHouseDB\Transport\Http::$_query_degenerations with single line content, use one-line comment instead.

     * @var array

introduced 2020-12-21 16:16 UTC by

@var annotation of property \ClickHouseDB\Transport\Http::$_query_degenerations does not specify type hint for its items.

*/

    private $_query_degenerations = [];

Coding Style introduced 2020-12-21 16:16 UTC by

Member variable "_query_degenerations" is not in valid camel caps format

/**

     * Count seconds (int)

     * @var int

*/

    private $_connectTimeOut = 5;

/**

introduced 2018-07-08 20:56 UTC by

Found multi-line comment for property \ClickHouseDB\Transport\Http::$xClickHouseProgress with single line content, use one-line comment instead.

     * @var callable

*/

    private $xClickHouseProgress = null;

/**

introduced 2019-11-28 14:43 UTC by

Found multi-line comment for property \ClickHouseDB\Transport\Http::$sslCA with single line content, use one-line comment instead.

     * @var null|string

introduced 2020-12-21 16:16 UTC by

Null type hint should be on last position in "null|string".

*/

    private $sslCA = null;

/**

     * Http constructor.

introduced 2018-07-08 20:56 UTC by

Documentation comment contains forbidden comment "Http constructor.".

     * @param string $host

introduced 2018-09-26 10:27 UTC by

Expected 1 lines between description and annotations, found 0.

     * @param int $port

Coding Style introduced 2018-07-08 20:56 UTC by

Expected 4 spaces after parameter type; 1 found

     * @param string $username

     * @param string $password

100

     * @param int $authMethod

Coding Style introduced 2020-06-21 08:15 UTC by

Expected 4 spaces after parameter type; 1 found

101

*/

102

    public function __construct($host, $port, $username, $password, $authMethod = null)

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::__construct() does not have native type hint for its parameter $host but it should be possible to add it based on @param annotation "string".

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::__construct() does not have native type hint for its parameter $port but it should be possible to add it based on @param annotation "int".

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::__construct() does not have native type hint for its parameter $username but it should be possible to add it based on @param annotation "string".

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::__construct() does not have native type hint for its parameter $password but it should be possible to add it based on @param annotation "string".

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::__construct() does not have native type hint for its parameter $authMethod but it should be possible to add it based on @param annotation "int".

103

104

        $this->setHost($host, $port);

105

106

        $this->_username = $username;

107

        $this->_password = $password;

108

        if ($authMethod) {

Bug Best Practice introduced 2020-09-29 12:51 UTC by

The expression $authMethod of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

109

            $this->_authMethod = $authMethod;

110

111

112

        $this->_settings = new Settings($this);

113

114

        $this->setCurler();

115

Coding Style introduced 2020-12-21 16:16 UTC by

Expected 1 blank line after function; 2 found

116

117

118

    public function setCurler() : void

introduced 2021-02-28 10:12 UTC by

There must be no whitespace between closing parenthesis and return type colon.

119

120

        $this->_curler = new CurlerRolling();

121

122

123

/**

124

     * @param CurlerRolling $curler

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::setDirtyCurler() has useless @param annotation for parameter $curler.

125

*/

126

    public function setDirtyCurler(CurlerRolling $curler) : void

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::setDirtyCurler() does not need documentation comment.

introduced 2021-02-28 10:12 UTC by

There must be no whitespace between closing parenthesis and return type colon.

127

128

        if ($curler instanceof CurlerRolling) {

introduced 2019-08-24 09:06 UTC by

$curler is always a sub-type of ClickHouseDB\Transport\CurlerRolling.

introduced 2019-08-24 09:06 UTC by

Use early exit to reduce code nesting.

129

            $this->_curler = $curler;

130

131

132

133

/**

134

     * @return CurlerRolling

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::getCurler() has useless @return annotation.

135

*/

136

    public function getCurler(): ?CurlerRolling

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::getCurler() does not need documentation comment.

137

138

        return $this->_curler;

139

140

141

/**

142

     * @param string $host

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::setHost() has useless @param annotation for parameter $host.

143

     * @param int $port

Coding Style introduced 2018-07-08 20:56 UTC by

Expected 4 spaces after parameter type; 1 found

144

*/

145

    public function setHost(string $host, $port = -1) : void

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::setHost() does not have native type hint for its parameter $port but it should be possible to add it based on @param annotation "int".

introduced 2021-02-28 10:12 UTC by

There must be no whitespace between closing parenthesis and return type colon.

146

147

        if ($port > 0) {

148

            $this->_port = $port;

149

150

151

        $this->_host = $host;

152

153

154

/**

155

     * Sets client SSL certificate for Yandex Cloud

156

157

     * @param string $caPath

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::setSslCa() has useless @param annotation for parameter $caPath.

158

*/

159

    public function setSslCa(string $caPath) : void

introduced 2021-02-28 10:12 UTC by

There must be no whitespace between closing parenthesis and return type colon.

160

161

        $this->sslCA = $caPath;

162

163

164

/**

165

     * @return string

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::getUri() has useless @return annotation.

166

*/

167

    public function getUri(): string

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::getUri() does not need documentation comment.

168

169

        $proto = 'http';

170

        if ($this->settings()->isHttps()) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

171

            $proto = 'https';

172

173

        $uri = $proto . '://' . $this->_host;

174

        if (stripos($this->_host, '/') !== false || stripos($this->_host, ':') !== false) {

introduced 2018-07-24 07:04 UTC by

Function stripos() should not be referenced via a fallback global name, but via a use statement.

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

175

            return $uri;

176

177

        if (intval($this->_port) > 0) {

introduced 2018-07-24 07:04 UTC by

Function intval() should not be referenced via a fallback global name, but via a use statement.

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

178

            return $uri . ':' . $this->_port;

179

180

        return $uri;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

181

182

183

/**

184

     * @return Settings

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::settings() has useless @return annotation.

185

*/

186

    public function settings(): Settings

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::settings() does not need documentation comment.

187

188

        return $this->_settings;

189

190

191

/**

192

     * @param bool|int $flag

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

193

     * @return mixed

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::verbose() has useless @return annotation.

194

*/

195

    public function verbose($flag): mixed

196

197

        $this->_verbose = $flag;

198

        return $flag;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

199

200

201

/**

202

     * @param array $params

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

introduced 2020-12-21 16:16 UTC by

@param annotation of method \ClickHouseDB\Transport\Http::getUrl() does not specify type hint for items of its traversable parameter $params.

203

     * @return string

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::getUrl() has useless @return annotation.

204

*/

205

    private function getUrl($params = []): string

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::getUrl() does not have native type hint for its parameter $params but it should be possible to add it based on @param annotation "array".

206

207

        $settings = $this->settings()->getSettings();

208

209

        if (is_array($params) && sizeof($params)) {

introduced 2018-07-08 20:56 UTC by

Function is_array() should not be referenced via a fallback global name, but via a use statement.

introduced 2018-07-08 20:56 UTC by

Function sizeof() should not be referenced via a fallback global name, but via a use statement.

Coding Style introduced 2018-07-08 20:56 UTC by

The use of function sizeof() is forbidden; use count() instead

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 2.

210

            $settings = array_merge($settings, $params);

introduced 2018-07-08 20:56 UTC by

Function array_merge() should not be referenced via a fallback global name, but via a use statement.

211

212

Coding Style introduced 2018-07-08 20:56 UTC by

Functions must not contain multiple empty lines in a row; found 2 empty lines

213

214

        if ($this->settings()->isReadOnlyUser()) {

215

            unset($settings['extremes']);

216

            unset($settings['readonly']);

217

            unset($settings['enable_http_compression']);

218

            unset($settings['max_execution_time']);

219

Coding Style introduced 2018-07-08 20:56 UTC by

Blank line found at end of control structure

220

221

222

        unset($settings['https']);

223

Coding Style introduced 2018-07-08 20:56 UTC by

Functions must not contain multiple empty lines in a row; found 2 empty lines

224

225

        return $this->getUri() . '?' . http_build_query($settings);

introduced 2018-07-08 20:56 UTC by

Function http_build_query() should not be referenced via a fallback global name, but via a use statement.

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 2.

226

227

228

/**

229

     * @param array $extendinfo

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

introduced 2020-12-21 16:16 UTC by

@param annotation of method \ClickHouseDB\Transport\Http::newRequest() does not specify type hint for items of its traversable parameter $extendinfo.

230

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::newRequest() has useless @return annotation.

231

*/

232

    private function newRequest($extendinfo): CurlerRequest

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::newRequest() does not have native type hint for its parameter $extendinfo but it should be possible to add it based on @param annotation "array".

233

234

        $new = new CurlerRequest();

235

236

        switch ($this->_authMethod) {

237

            case self::AUTH_METHOD_QUERY_STRING:

238

                /* @todo: Move this implementation to CurlerRequest class. Possible options: the authentication method

239

                 *        should be applied in method `CurlerRequest:prepareRequest()`.

240

*/

241

                $this->settings()->set('user', $this->_username);

242

                $this->settings()->set('password', $this->_password);

243

                break;

244

            case self::AUTH_METHOD_BASIC_AUTH:

245

                $new->authByBasicAuth($this->_username, $this->_password);

246

                break;

247

            default:

248

                // Auth with headers by default

249

                $new->authByHeaders($this->_username, $this->_password);

250

                break;

251

252

253

        $new->POST()->setRequestExtendedInfo($extendinfo);

254

255

        if ($this->settings()->isEnableHttpCompression()) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

256

            $new->httpCompression(true);

257

258

        if ($this->settings()->getSessionId()) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

259

            $new->persistent();

260

261

        if ($this->sslCA) {

262

            $new->setSslCa($this->sslCA);

263

264

265

        $new->timeOut($this->settings()->getTimeOut());

266

        $new->connectTimeOut($this->_connectTimeOut);//->keepAlive(); // one sec

267

        $new->verbose(boolval($this->_verbose));

introduced 2018-07-08 20:56 UTC by

Function boolval() should not be referenced via a fallback global name, but via a use statement.

268

269

        return $new;

270

271

272

/**

273

     * @param Query $query

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::makeRequest() has useless @param annotation for parameter $query.

274

     * @param array $urlParams

introduced 2020-12-21 16:16 UTC by

@param annotation of method \ClickHouseDB\Transport\Http::makeRequest() does not specify type hint for items of its traversable parameter $urlParams.

275

     * @param bool $query_as_string

Coding Style introduced 2018-07-08 20:56 UTC by

Expected 2 spaces after parameter type; 1 found

276

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::makeRequest() has useless @return annotation.

277

     * @throws \ClickHouseDB\Exception\TransportException

introduced 2018-07-08 20:56 UTC by

Class \ClickHouseDB\Exception\TransportException should not be referenced via a fully qualified name, but via a use statement.

278

*/

279

    private function makeRequest(Query $query, $urlParams = [], $query_as_string = false): CurlerRequest

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::makeRequest() does not have native type hint for its parameter $urlParams but it should be possible to add it based on @param annotation "array".

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::makeRequest() does not have native type hint for its parameter $query_as_string but it should be possible to add it based on @param annotation "bool".

Coding Style introduced 2020-12-21 16:16 UTC by

The variable $query_as_string should be in camel caps format.

280

281

        $sql = $query->toSql();

282

283

        if ($query_as_string) {

Coding Style introduced 2020-12-21 16:16 UTC by

The variable $query_as_string should be in camel caps format.

284

            $urlParams['query'] = $sql;

285

286

287

        $extendinfo = [

288

            'sql' => $sql,

289

            'query' => $query,

290

            'format' => $query->getFormat()

introduced 2020-12-21 16:16 UTC by

Multi-line arrays must have a trailing comma after the last element.

291

];

292

293

        $new = $this->newRequest($extendinfo);

294

295

/*

296

         * Build URL after request making, since URL may contain auth data. This will not matter after the

297

         * implantation of the todo in the `HTTP:newRequest()` method.

298

*/

299

        $url = $this->getUrl($urlParams);

300

        $new->url($url);

301

Coding Style introduced 2019-11-28 14:43 UTC by

Functions must not contain multiple empty lines in a row; found 2 empty lines

302

303

        if (!$query_as_string) {

Coding Style introduced 2019-03-13 07:05 UTC by

Expected 1 space(s) after NOT operator; 0 found

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

Coding Style introduced 2020-12-21 16:16 UTC by

The variable $query_as_string should be in camel caps format.

304

            $new->parameters_json($sql);

305

306

        if ($this->settings()->isEnableHttpCompression()) {

307

            $new->httpCompression(true);

308

309

310

        return $new;

311

312

313

/**

314

     * @param string|Query $sql

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

315

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::writeStreamData() has useless @return annotation.

316

*/

317

    public function writeStreamData($sql): CurlerRequest

318

Coding Style introduced 2018-07-08 20:56 UTC by

Expected 0 blank lines after opening function brace; 1 found

319

320

        if ($sql instanceof Query) {

321

            $query = $sql;

322

        } else {

323

            $query = new Query($sql);

324

325

326

        $extendinfo = [

327

            'sql' => $sql,

328

            'query' => $query,

329

            'format' => $query->getFormat()

introduced 2020-12-21 16:16 UTC by

Multi-line arrays must have a trailing comma after the last element.

330

];

331

332

        $request = $this->newRequest($extendinfo);

333

334

/*

335

         * Build URL after request making, since URL may contain auth data. This will not matter after the

336

         * implantation of the todo in the `HTTP:newRequest()` method.

337

*/

338

        $url = $this->getUrl([

339

            'readonly' => 0,

340

            'query' => $query->toSql()

introduced 2020-12-21 16:16 UTC by

Multi-line arrays must have a trailing comma after the last element.

341

]);

342

343

        $request->url($url);

344

        return $request;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

345

Coding Style introduced 2020-12-21 16:16 UTC by

Expected 1 blank line after function; 2 found

346

347

348

/**

349

     * @param string $sql

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

350

     * @param string $file_name

351

     * @return Statement

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::writeAsyncCSV() has useless @return annotation.

352

     * @throws \ClickHouseDB\Exception\TransportException

introduced 2018-07-08 20:56 UTC by

Class \ClickHouseDB\Exception\TransportException should not be referenced via a fully qualified name, but via a use statement.

353

*/

354

    public function writeAsyncCSV($sql, $file_name): Statement

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::writeAsyncCSV() does not have native type hint for its parameter $sql but it should be possible to add it based on @param annotation "string".

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::writeAsyncCSV() does not have native type hint for its parameter $file_name but it should be possible to add it based on @param annotation "string".

Coding Style introduced 2020-12-21 16:16 UTC by

The variable $file_name should be in camel caps format.

355

356

        $query = new Query($sql);

357

358

        $extendinfo = [

359

            'sql' => $sql,

360

            'query' => $query,

361

            'format' => $query->getFormat()

introduced 2020-12-21 16:16 UTC by

Multi-line arrays must have a trailing comma after the last element.

362

];

363

364

        $request = $this->newRequest($extendinfo);

365

366

/*

367

         * Build URL after request making, since URL may contain auth data. This will not matter after the

368

         * implantation of the todo in the `HTTP:newRequest()` method.

369

*/

370

        $url = $this->getUrl([

371

            'readonly' => 0,

372

            'query' => $query->toSql()

introduced 2020-12-21 16:16 UTC by

Multi-line arrays must have a trailing comma after the last element.

373

]);

374

375

        $request->url($url);

376

377

        $request->setCallbackFunction(function (CurlerRequest $request) {

introduced 2018-09-26 10:27 UTC by

Closure not using "$this" should be declared static.

introduced 2020-12-21 16:16 UTC by

Closure does not have void return type hint.

378

            $handle = $request->getInfileHandle();

379

            if (is_resource($handle)) {

introduced 2018-07-08 20:56 UTC by

Use early exit to reduce code nesting.

introduced 2018-07-08 20:56 UTC by

Function is_resource() should not be referenced via a fallback global name, but via a use statement.

380

                fclose($handle);

introduced 2018-07-08 20:56 UTC by

Function fclose() should not be referenced via a fallback global name, but via a use statement.

381

382

});

383

384

        $request->setInfile($file_name);

Coding Style introduced 2020-12-21 16:16 UTC by

The variable $file_name should be in camel caps format.

385

        $this->_curler->addQueLoop($request);

386

387

        return new Statement($request);

388

389

390

/**

391

     * get Count Pending Query in Queue

392

393

     * @return int

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::getCountPendingQueue() has useless @return annotation.

394

*/

395

    public function getCountPendingQueue(): int

396

397

        return $this->_curler->countPending();

398

399

400

/**

401

     * set Connect TimeOut in seconds [CURLOPT_CONNECTTIMEOUT] ( int )

402

403

     * @param int $connectTimeOut

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::setConnectTimeOut() has useless @param annotation for parameter $connectTimeOut.

404

*/

405

    public function setConnectTimeOut(int $connectTimeOut)

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::setConnectTimeOut() does not have void return type hint.

406

407

        $this->_connectTimeOut = $connectTimeOut;

408

409

410

/**

411

     * get ConnectTimeOut in seconds

412

413

     * @return int

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::getConnectTimeOut() has useless @return annotation.

414

*/

415

    public function getConnectTimeOut(): int

416

417

        return $this->_connectTimeOut;

418

Coding Style introduced 2020-12-21 16:16 UTC by

Expected 1 blank line after function; 2 found

419

420

421

    public function __findXClickHouseProgress($handle): bool

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::__findXClickHouseProgress() does not have parameter type hint nor @param annotation for its parameter $handle.

422

423

        $code = curl_getinfo($handle, CURLINFO_HTTP_CODE);

introduced 2018-07-08 20:56 UTC by

Function curl_getinfo() should not be referenced via a fallback global name, but via a use statement.

introduced 2018-07-08 20:56 UTC by

Constant CURLINFO_HTTP_CODE should not be referenced via a fallback global name, but via a use statement.

424

425

        // Search X-ClickHouse-Progress

426

        if ($code == 200) {

introduced 2020-12-21 16:16 UTC by

Operator == is disallowed, use === instead.

introduced 2021-02-28 10:12 UTC by

Expected 1 lines after "if", found 0.

427

            $response = curl_multi_getcontent($handle);

Coding Style introduced 2018-07-08 20:56 UTC by

Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space

introduced 2018-07-08 20:56 UTC by

Function curl_multi_getcontent() should not be referenced via a fallback global name, but via a use statement.

428

            $header_size = curl_getinfo($handle, CURLINFO_HEADER_SIZE);

introduced 2018-07-08 20:56 UTC by

Function curl_getinfo() should not be referenced via a fallback global name, but via a use statement.

introduced 2018-07-08 20:56 UTC by

Constant CURLINFO_HEADER_SIZE should not be referenced via a fallback global name, but via a use statement.

Coding Style introduced 2020-12-21 16:16 UTC by

The variable $header_size should be in camel caps format.

429

            if (!$header_size) {

Coding Style introduced 2019-03-13 07:05 UTC by

Expected 1 space(s) after NOT operator; 0 found

Coding Style introduced 2020-12-21 16:16 UTC by

The variable $header_size should be in camel caps format.

430

                return false;

431

432

433

            $header = substr($response, 0, $header_size);

introduced 2018-07-08 20:56 UTC by

Function substr() should not be referenced via a fallback global name, but via a use statement.

Coding Style introduced 2020-12-21 16:16 UTC by

The variable $header_size should be in camel caps format.

434

            if (!$header_size) {

Coding Style introduced 2019-03-13 07:05 UTC by

Expected 1 space(s) after NOT operator; 0 found

Coding Style introduced 2020-12-21 16:16 UTC by

The variable $header_size should be in camel caps format.

435

                return false;

436

437

438

            $pos = strrpos($header, 'X-ClickHouse-Summary:');

introduced 2021-01-19 17:19 UTC by

Function strrpos() should not be referenced via a fallback global name, but via a use statement.

439

            if (!$pos) {

Coding Style introduced 2019-03-13 07:05 UTC by

Expected 1 space(s) after NOT operator; 0 found

440

                return false;

441

442

443

            $last = substr($header, $pos);

introduced 2018-07-08 20:56 UTC by

Function substr() should not be referenced via a fallback global name, but via a use statement.

444

            $data = @json_decode(str_ireplace('X-ClickHouse-Summary:', '', $last), true);

introduced 2018-07-08 20:56 UTC by

Function json_decode() should not be referenced via a fallback global name, but via a use statement.

introduced 2018-07-08 20:56 UTC by

Function str_ireplace() should not be referenced via a fallback global name, but via a use statement.

Bug introduced 2021-01-19 17:19 UTC by

It seems like str_ireplace('X-ClickHouse-Summary:', '', $last) can also be of type array; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

445

446

            if ($data && is_callable($this->xClickHouseProgress)) {

introduced 2018-07-08 20:56 UTC by

Function is_callable() should not be referenced via a fallback global name, but via a use statement.

Coding Style introduced 2018-07-08 20:56 UTC by

Blank line found at start of control structure

introduced 2020-12-21 16:16 UTC by

Expected 0 lines after "if", found 1.

447

448

                if (is_array($this->xClickHouseProgress)) {

introduced 2018-07-08 20:56 UTC by

Function is_array() should not be referenced via a fallback global name, but via a use statement.

introduced 2020-12-21 16:16 UTC by

Expected 0 lines after "if", found 2.

449

                    call_user_func_array($this->xClickHouseProgress, [$data]);

introduced 2018-07-08 20:56 UTC by

Function call_user_func_array() should not be referenced via a fallback global name, but via a use statement.

450

                } else {

451

                    call_user_func($this->xClickHouseProgress, $data);

introduced 2018-07-08 20:56 UTC by

Function call_user_func() should not be referenced via a fallback global name, but via a use statement.

452

453

Coding Style introduced 2018-07-08 20:56 UTC by

Functions must not contain multiple empty lines in a row; found 2 empty lines

454

Coding Style introduced 2018-07-08 20:56 UTC by

Blank line found at end of control structure

455

456

Coding Style introduced 2018-07-08 20:56 UTC by

Blank line found at end of control structure

457

458

        return false;

introduced 2021-02-28 10:12 UTC by

Expected 1 lines before "return", found 0.

459

460

461

/**

462

     * @param Query $query

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

Coding Style introduced 2018-07-08 20:56 UTC by

Expected 12 spaces after parameter type; 1 found

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::getRequestRead() has useless @param annotation for parameter $query.

463

     * @param null|WhereInFile $whereInFile

introduced 2020-12-21 16:16 UTC by

Null type hint should be on last position in "null|WhereInFile".

464

     * @param null|WriteToFile $writeToFile

introduced 2020-12-21 16:16 UTC by

Null type hint should be on last position in "null|WriteToFile".

465

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::getRequestRead() has useless @return annotation.

466

     * @throws \Exception

introduced 2018-09-26 10:27 UTC by

Class \Exception should not be referenced via a fully qualified name, but via a use statement.

467

*/

468

    public function getRequestRead(Query $query, $whereInFile = null, $writeToFile = null): CurlerRequest

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::getRequestRead() does not have native type hint for its parameter $whereInFile but it should be possible to add it based on @param annotation "null|WhereInFile".

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::getRequestRead() does not have native type hint for its parameter $writeToFile but it should be possible to add it based on @param annotation "null|WriteToFile".

469

470

        $urlParams = ['readonly' => 2];

Coding Style introduced 2018-07-08 20:56 UTC by

Equals sign not aligned with surrounding assignments; expected 7 spaces but found 1 space

471

        $query_as_string = false;

Coding Style introduced 2020-12-21 16:16 UTC by

The variable $query_as_string should be in camel caps format.

472

        // ---------------------------------------------------------------------------------

473

        if ($whereInFile instanceof WhereInFile && $whereInFile->size()) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

474

            // $request = $this->prepareSelectWhereIn($request, $whereInFile);

475

            $structure = $whereInFile->fetchUrlParams();

476

            // $structure = [];

477

            $urlParams = array_merge($urlParams, $structure);

Coding Style introduced 2018-07-08 20:56 UTC by

Equals sign not aligned with surrounding assignments; expected 7 spaces but found 1 space

introduced 2018-07-08 20:56 UTC by

Function array_merge() should not be referenced via a fallback global name, but via a use statement.

478

            $query_as_string = true;

Coding Style introduced 2020-12-21 16:16 UTC by

The variable $query_as_string should be in camel caps format.

479

480

        // ---------------------------------------------------------------------------------

481

        // if result to file

482

        if ($writeToFile instanceof WriteToFile && $writeToFile->fetchFormat()) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

483

            $query->setFormat($writeToFile->fetchFormat());

484

            unset($urlParams['extremes']);

485

486

        // ---------------------------------------------------------------------------------

487

        // makeRequest read

488

        $request = $this->makeRequest($query, $urlParams, $query_as_string);

Coding Style introduced 2020-12-21 16:16 UTC by

The variable $query_as_string should be in camel caps format.

489

        // ---------------------------------------------------------------------------------

490

        // attach files

491

        if ($whereInFile instanceof WhereInFile && $whereInFile->size()) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

492

            $request->attachFiles($whereInFile->fetchFiles());

493

494

        // ---------------------------------------------------------------------------------

495

        // result to file

496

        if ($writeToFile instanceof WriteToFile && $writeToFile->fetchFormat()) {

Coding Style introduced 2018-07-08 20:56 UTC by

Blank line found at start of control structure

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

497

498

            $fout = fopen($writeToFile->fetchFile(), 'w');

introduced 2018-07-08 20:56 UTC by

Function fopen() should not be referenced via a fallback global name, but via a use statement.

499

            if (is_resource($fout)) {

introduced 2018-07-08 20:56 UTC by

Function is_resource() should not be referenced via a fallback global name, but via a use statement.

Coding Style introduced 2018-07-08 20:56 UTC by

Blank line found at start of control structure

500

501

                $isGz = $writeToFile->getGzip();

502

503

                if ($isGz) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 2.

504

                    // write gzip header

505

                    // "\x1f\x8b\x08\x00\x00\x00\x00\x00"

506

                    // fwrite($fout, "\x1F\x8B\x08\x08".pack("V", time())."\0\xFF", 10);

507

                    // write the original file name

508

                    // $oname = str_replace("\0", "", basename($writeToFile->fetchFile()));

509

                    // fwrite($fout, $oname."\0", 1+strlen($oname));

510

511

                    fwrite($fout, "\x1f\x8b\x08\x00\x00\x00\x00\x00");

introduced 2018-07-08 20:56 UTC by

Function fwrite() should not be referenced via a fallback global name, but via a use statement.

512

Coding Style introduced 2018-07-08 20:56 UTC by

Blank line found at end of control structure

513

514

Coding Style introduced 2018-07-08 20:56 UTC by

Functions must not contain multiple empty lines in a row; found 2 empty lines

515

516

                $request->setResultFileHandle($fout, $isGz)->setCallbackFunction(function (CurlerRequest $request) {

introduced 2018-09-26 10:27 UTC by

Closure not using "$this" should be declared static.

introduced 2020-12-21 16:16 UTC by

Closure does not have void return type hint.

517

                    fclose($request->getResultFileHandle());

introduced 2018-07-08 20:56 UTC by

Function fclose() should not be referenced via a fallback global name, but via a use statement.

518

});

519

520

521

        if ($this->xClickHouseProgress) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

522

            $request->setFunctionProgress([$this, '__findXClickHouseProgress']);

523

524

        // ---------------------------------------------------------------------------------

525

        return $request;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

introduced 2020-12-21 16:16 UTC by

Expected 0 lines after "return", found 1.

526

527

Coding Style introduced 2018-07-08 20:56 UTC by

Function closing brace must go on the next line following the body; found 1 blank lines before brace

528

529

    public function cleanQueryDegeneration(): bool

530

531

        $this->_query_degenerations = [];

Coding Style introduced 2020-12-21 16:16 UTC by

The variable $_query_degenerations should be in camel caps format.

532

        return true;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

533

534

535

    public function addQueryDegeneration(Degeneration $degeneration): bool

536

537

        $this->_query_degenerations[] = $degeneration;

Coding Style introduced 2020-12-21 16:16 UTC by

The variable $_query_degenerations should be in camel caps format.

538

        return true;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

539

540

541

/**

542

     * @param Query $query

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::getRequestWrite() has useless @param annotation for parameter $query.

543

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::getRequestWrite() has useless @return annotation.

544

     * @throws \ClickHouseDB\Exception\TransportException

introduced 2018-07-08 20:56 UTC by

Class \ClickHouseDB\Exception\TransportException should not be referenced via a fully qualified name, but via a use statement.

545

*/

546

    public function getRequestWrite(Query $query): CurlerRequest

547

548

        $urlParams = ['readonly' => 0];

549

        return $this->makeRequest($query, $urlParams);

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

550

551

552

/**

553

     * @throws TransportException

554

*/

555

    public function ping(): bool

556

557

        $request = new CurlerRequest();

558

        $request->url($this->getUri())->verbose(false)->GET()->connectTimeOut($this->getConnectTimeOut());

559

        $this->_curler->execOne($request);

560

561

        return $request->response()->body() === 'Ok.' . PHP_EOL;

562

563

564

/**

565

     * @param string $sql

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

Coding Style introduced 2018-09-26 10:51 UTC by

Expected 2 spaces after parameter type; 1 found

566

     * @param mixed[] $bindings

567

     * @return Query

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::prepareQuery() has useless @return annotation.

568

*/

569

    private function prepareQuery($sql, $bindings): Query

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::prepareQuery() does not have native type hint for its parameter $sql but it should be possible to add it based on @param annotation "string".

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::prepareQuery() does not have native type hint for its parameter $bindings but it should be possible to add it based on @param annotation "mixed[]".

570

Coding Style introduced 2018-07-08 20:56 UTC by

Expected 0 blank lines after opening function brace; 1 found

571

572

        // add Degeneration query

573

        foreach ($this->_query_degenerations as $degeneration) {

Coding Style introduced 2020-12-21 16:16 UTC by

The variable $_query_degenerations should be in camel caps format.

574

            $degeneration->bindParams($bindings);

575

576

577

        return new Query($sql, $this->_query_degenerations);

Coding Style introduced 2020-12-21 16:16 UTC by

The variable $_query_degenerations should be in camel caps format.

578

Coding Style introduced 2020-12-21 16:16 UTC by

Expected 1 blank line after function; 2 found

579

580

581

/**

582

     * @param Query|string $sql

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

Coding Style introduced 2018-07-08 20:56 UTC by

Expected 5 spaces after parameter type; 1 found

583

     * @param mixed[] $bindings

Coding Style introduced 2018-09-26 10:51 UTC by

Expected 10 spaces after parameter type; 1 found

584

     * @param null|WhereInFile $whereInFile

introduced 2020-12-21 16:16 UTC by

Null type hint should be on last position in "null|WhereInFile".

585

     * @param null|WriteToFile $writeToFile

introduced 2020-12-21 16:16 UTC by

Null type hint should be on last position in "null|WriteToFile".

586

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::prepareSelect() has useless @return annotation.

587

     * @throws \Exception

introduced 2018-09-26 10:27 UTC by

Class \Exception should not be referenced via a fully qualified name, but via a use statement.

588

*/

589

    private function prepareSelect($sql, $bindings, $whereInFile, $writeToFile = null): CurlerRequest

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::prepareSelect() does not have native type hint for its parameter $bindings but it should be possible to add it based on @param annotation "mixed[]".

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::prepareSelect() does not have native type hint for its parameter $whereInFile but it should be possible to add it based on @param annotation "null|WhereInFile".

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::prepareSelect() does not have native type hint for its parameter $writeToFile but it should be possible to add it based on @param annotation "null|WriteToFile".

590

591

        if ($sql instanceof Query) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

592

            return $this->getRequestWrite($sql);

593

594

        $query = $this->prepareQuery($sql, $bindings);

595

        $query->setFormat('JSON');

596

        return $this->getRequestRead($query, $whereInFile, $writeToFile);

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

597

Coding Style introduced 2020-12-21 16:16 UTC by

Expected 1 blank line after function; 2 found

598

599

600

/**

601

     * @param Query|string $sql

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

602

     * @param mixed[] $bindings

Coding Style introduced 2018-09-26 10:51 UTC by

Expected 6 spaces after parameter type; 1 found

603

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::prepareWrite() has useless @return annotation.

604

     * @throws \ClickHouseDB\Exception\TransportException

introduced 2018-07-08 20:56 UTC by

Class \ClickHouseDB\Exception\TransportException should not be referenced via a fully qualified name, but via a use statement.

605

*/

606

    private function prepareWrite($sql, $bindings = []): CurlerRequest

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::prepareWrite() does not have native type hint for its parameter $bindings but it should be possible to add it based on @param annotation "mixed[]".

607

608

        if ($sql instanceof Query) {

609

            return $this->getRequestWrite($sql);

610

611

612

        $query = $this->prepareQuery($sql, $bindings);

613

        return $this->getRequestWrite($query);

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

614

615

616

/**

617

     * @return bool

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::executeAsync() has useless @return annotation.

618

     * @throws \ClickHouseDB\Exception\TransportException

introduced 2018-07-08 20:56 UTC by

Class \ClickHouseDB\Exception\TransportException should not be referenced via a fully qualified name, but via a use statement.

619

*/

620

    public function executeAsync(): bool

621

622

        return $this->_curler->execLoopWait();

623

624

625

/**

626

     * @param Query|string $sql

introduced 2018-10-17 23:01 UTC by

Incorrect annotations group.

Coding Style introduced 2018-07-08 20:56 UTC by

Expected 5 spaces after parameter type; 1 found

627

     * @param mixed[] $bindings

Coding Style introduced 2018-09-26 10:51 UTC by

Expected 10 spaces after parameter type; 1 found

628

     * @param null|WhereInFile $whereInFile

introduced 2020-12-21 16:16 UTC by

Null type hint should be on last position in "null|WhereInFile".

629

     * @param null|WriteToFile $writeToFile

introduced 2020-12-21 16:16 UTC by

Null type hint should be on last position in "null|WriteToFile".

630

     * @return Statement

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::select() has useless @return annotation.

631

     * @throws \ClickHouseDB\Exception\TransportException

introduced 2018-07-08 20:56 UTC by

Class \ClickHouseDB\Exception\TransportException should not be referenced via a fully qualified name, but via a use statement.

632

     * @throws \Exception

introduced 2018-09-26 10:27 UTC by

Class \Exception should not be referenced via a fully qualified name, but via a use statement.

633

*/

634

    public function select($sql, array $bindings = [], $whereInFile = null, $writeToFile = null): Statement

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::select() does not have native type hint for its parameter $whereInFile but it should be possible to add it based on @param annotation "null|WhereInFile".

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::select() does not have native type hint for its parameter $writeToFile but it should be possible to add it based on @param annotation "null|WriteToFile".

635

636

        $request = $this->prepareSelect($sql, $bindings, $whereInFile, $writeToFile);

637

        $this->_curler->execOne($request);

638

        return new Statement($request);

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

639

640

641

/**

642

     * @param Query|string $sql

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

Coding Style introduced 2018-07-08 20:56 UTC by

Expected 5 spaces after parameter type; 1 found

643

     * @param mixed[] $bindings

Coding Style introduced 2018-09-26 10:51 UTC by

Expected 10 spaces after parameter type; 1 found

644

     * @param null|WhereInFile $whereInFile

introduced 2020-12-21 16:16 UTC by

Null type hint should be on last position in "null|WhereInFile".

645

     * @param null|WriteToFile $writeToFile

introduced 2020-12-21 16:16 UTC by

Null type hint should be on last position in "null|WriteToFile".

646

     * @return Statement

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::selectAsync() has useless @return annotation.

647

     * @throws \ClickHouseDB\Exception\TransportException

introduced 2018-07-08 20:56 UTC by

Class \ClickHouseDB\Exception\TransportException should not be referenced via a fully qualified name, but via a use statement.

648

     * @throws \Exception

introduced 2018-09-26 10:27 UTC by

Class \Exception should not be referenced via a fully qualified name, but via a use statement.

649

*/

650

    public function selectAsync($sql, array $bindings = [], $whereInFile = null, $writeToFile = null): Statement

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::selectAsync() does not have native type hint for its parameter $whereInFile but it should be possible to add it based on @param annotation "null|WhereInFile".

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::selectAsync() does not have native type hint for its parameter $writeToFile but it should be possible to add it based on @param annotation "null|WriteToFile".

651

652

        $request = $this->prepareSelect($sql, $bindings, $whereInFile, $writeToFile);

653

        $this->_curler->addQueLoop($request);

654

        return new Statement($request);

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

655

656

657

/**

658

     * @param callable $callback

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::setProgressFunction() has useless @param annotation for parameter $callback.

659

*/

660

    public function setProgressFunction(callable $callback) : void

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::setProgressFunction() does not need documentation comment.

introduced 2021-01-19 17:19 UTC by

There must be no whitespace between closing parenthesis and return type colon.

661

662

        $this->xClickHouseProgress = $callback;

663

664

665

/**

666

     * @param string $sql

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

Coding Style introduced 2018-09-26 10:51 UTC by

Expected 2 spaces after parameter type; 1 found

667

     * @param mixed[] $bindings

668

     * @param bool $exception

Coding Style introduced 2018-09-26 10:51 UTC by

Expected 4 spaces after parameter type; 1 found

669

     * @return Statement

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::write() has useless @return annotation.

670

     * @throws \ClickHouseDB\Exception\TransportException

introduced 2018-07-15 14:29 UTC by

Class \ClickHouseDB\Exception\TransportException should not be referenced via a fully qualified name, but via a use statement.

671

*/

672

    public function write($sql, array $bindings = [], $exception = true): Statement

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::write() does not have native type hint for its parameter $sql but it should be possible to add it based on @param annotation "string".

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::write() does not have native type hint for its parameter $exception but it should be possible to add it based on @param annotation "bool".

673

674

        $request = $this->prepareWrite($sql, $bindings);

675

        $this->_curler->execOne($request);

676

        $response = new Statement($request);

677

        if ($exception) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

678

            if ($response->isError()) {

679

                $response->error();

680

681

682

        return $response;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

683

684

685

/**

686

     * @param Stream $streamRW

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

Coding Style introduced 2018-07-08 20:56 UTC by

Expected 8 spaces after parameter type; 1 found

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::streaming() has useless @param annotation for parameter $streamRW.

687

     * @param CurlerRequest $request

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::streaming() has useless @param annotation for parameter $request.

688

     * @return Statement

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::streaming() has useless @return annotation.

689

     * @throws \ClickHouseDB\Exception\TransportException

introduced 2018-07-08 20:56 UTC by

Class \ClickHouseDB\Exception\TransportException should not be referenced via a fully qualified name, but via a use statement.

690

*/

691

    private function streaming(Stream $streamRW, CurlerRequest $request): Statement

692

693

        $callable = $streamRW->getClosure();

694

        $stream = $streamRW->getStream();

Coding Style introduced 2019-11-28 14:43 UTC by

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

695

Coding Style introduced 2019-11-28 14:43 UTC by

Functions must not contain multiple empty lines in a row; found 2 empty lines

696

697

        try {

Coding Style introduced 2018-07-08 20:56 UTC by

Blank line found at start of control structure

introduced 2020-12-21 16:16 UTC by

Expected 0 lines after "try", found 2.

698

Coding Style introduced 2018-07-08 20:56 UTC by

Functions must not contain multiple empty lines in a row; found 2 empty lines

699

700

            if (!is_callable($callable)) {

Coding Style introduced 2019-03-13 07:05 UTC by

Expected 1 space(s) after NOT operator; 0 found

introduced 2018-07-08 20:56 UTC by

Function is_callable() should not be referenced via a fallback global name, but via a use statement.

701

                if ($streamRW->isWrite()) {

Coding Style introduced 2018-10-17 23:01 UTC by

Blank line found at start of control structure

702

703

                    $callable = function ($ch, $fd, $length) use ($stream) {

introduced 2018-09-26 10:27 UTC by

Closure not using "$this" should be declared static.

704

                        return ($line = fread($stream, $length)) ? $line : '';

introduced 2018-07-08 20:56 UTC by

Function fread() should not be referenced via a fallback global name, but via a use statement.

705

};

706

                } else {

707

                    $callable = function ($ch, $fd) use ($stream) {

introduced 2018-09-26 10:27 UTC by

Closure not using "$this" should be declared static.

708

                        return fwrite($stream, $fd);

introduced 2018-07-08 20:56 UTC by

Function fwrite() should not be referenced via a fallback global name, but via a use statement.

709

};

710

711

712

713

            if ($streamRW->isGzipHeader()) {

Coding Style introduced 2018-07-08 20:56 UTC by

Blank line found at start of control structure

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 2.

714

715

                if ($streamRW->isWrite()) {

introduced 2020-12-21 16:16 UTC by

Expected 0 lines after "if", found 1.

716

                    $request->header('Content-Encoding', 'gzip');

717

                    $request->header('Content-Type', 'application/x-www-form-urlencoded');

718

                } else {

719

                    $request->header('Accept-Encoding', 'gzip');

720

721

Coding Style introduced 2018-07-08 20:56 UTC by

Blank line found at end of control structure

722

723

Coding Style introduced 2019-11-28 14:43 UTC by

Functions must not contain multiple empty lines in a row; found 2 empty lines

724

725

            $request->header('Transfer-Encoding', 'chunked');

726

Coding Style introduced 2018-07-08 20:56 UTC by

Functions must not contain multiple empty lines in a row; found 2 empty lines

727

728

            if ($streamRW->isWrite()) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 2.

729

                $request->setReadFunction($callable);

730

            } else {

731

                $request->setWriteFunction($callable);

732

Coding Style introduced 2019-11-28 14:43 UTC by

Functions must not contain multiple empty lines in a row; found 2 empty lines

733

734

//                $request->setHeaderFunction($callableHead);

735

736

Coding Style introduced 2018-07-08 20:56 UTC by

Functions must not contain multiple empty lines in a row; found 2 empty lines

737

738

            $this->_curler->execOne($request, true);

739

            $response = new Statement($request);

740

            if ($response->isError()) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

741

                $response->error();

742

743

            return $response;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

744

        } finally {

745

            if ($streamRW->isWrite())

Coding Style Best Practice introduced 2018-07-08 20:56 UTC by

It is generally a best practice to always use braces with control structures.

746

                fclose($stream);

introduced 2018-07-08 20:56 UTC by

Function fclose() should not be referenced via a fallback global name, but via a use statement.

747

748

Coding Style introduced 2020-12-21 16:16 UTC by

Functions must not contain multiple empty lines in a row; found 2 empty lines

749

750

Coding Style introduced 2018-07-08 20:56 UTC by

Function closing brace must go on the next line following the body; found 2 blank lines before brace

Coding Style introduced 2020-12-21 16:16 UTC by

Expected 1 blank line after function; 2 found

751

752

753

/**

754

     * @param Stream $streamRead

introduced 2020-12-21 16:16 UTC by

Incorrect annotations group.

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::streamRead() has useless @param annotation for parameter $streamRead.

Coding Style introduced 2020-12-21 16:16 UTC by

Expected 2 spaces after parameter type; 1 found

755

     * @param string $sql

Coding Style introduced 2020-12-21 16:16 UTC by

Expected 2 spaces after parameter type; 1 found

756

     * @param mixed[] $bindings

757

     * @return Statement

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::streamRead() has useless @return annotation.

758

     * @throws \ClickHouseDB\Exception\TransportException

introduced 2018-07-08 20:56 UTC by

Class \ClickHouseDB\Exception\TransportException should not be referenced via a fully qualified name, but via a use statement.

759

*/

760

    public function streamRead(Stream $streamRead, $sql, $bindings = []): Statement

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::streamRead() does not have native type hint for its parameter $sql but it should be possible to add it based on @param annotation "string".

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::streamRead() does not have native type hint for its parameter $bindings but it should be possible to add it based on @param annotation "mixed[]".

761

762

        $sql = $this->prepareQuery($sql, $bindings);

Coding Style introduced 2020-12-21 16:16 UTC by

Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space

763

        $request = $this->getRequestRead($sql);

764

        return $this->streaming($streamRead, $request);

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

introduced 2020-12-21 16:16 UTC by

Expected 0 lines after "return", found 1.

765

766

Coding Style introduced 2020-12-21 16:16 UTC by

Function closing brace must go on the next line following the body; found 1 blank lines before brace

767

768

/**

769

     * @param Stream $streamWrite

introduced 2020-12-21 16:16 UTC by

Incorrect annotations group.

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::streamWrite() has useless @param annotation for parameter $streamWrite.

Coding Style introduced 2020-12-21 16:16 UTC by

Expected 2 spaces after parameter type; 1 found

770

     * @param string $sql

Coding Style introduced 2020-12-21 16:16 UTC by

Expected 2 spaces after parameter type; 1 found

771

     * @param mixed[] $bindings

772

     * @return Statement

introduced 2021-02-28 10:12 UTC by

Method \ClickHouseDB\Transport\Http::streamWrite() has useless @return annotation.

773

     * @throws \ClickHouseDB\Exception\TransportException

introduced 2018-07-08 20:56 UTC by

Class \ClickHouseDB\Exception\TransportException should not be referenced via a fully qualified name, but via a use statement.

774

*/

775

    public function streamWrite(Stream $streamWrite, $sql, $bindings = []): Statement

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::streamWrite() does not have native type hint for its parameter $sql but it should be possible to add it based on @param annotation "string".

introduced 2020-12-21 16:16 UTC by

Method \ClickHouseDB\Transport\Http::streamWrite() does not have native type hint for its parameter $bindings but it should be possible to add it based on @param annotation "mixed[]".

776

777

        $sql = $this->prepareQuery($sql, $bindings);

Coding Style introduced 2020-12-21 16:16 UTC by

Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space

778

        $request = $this->writeStreamData($sql);

779

        return $this->streaming($streamWrite, $request);

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

780

781

782

smi2 / phpClickHouse

Push — master ( 9a3a1b...103669 )

Http::__findXClickHouseProgress() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like