Http::prepareQuery() - Code Metrics - smi2/phpClickHouse - Measure and Improve Code Quality continuously with Scrutinizer

Http::prepareQuery() A
last analyzed 2024-07-17 07:54 UTC

↳ Parent: Http

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	2.1481

Importance

Changes	3
Bugs	0	Features	1

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

<?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.

introduced 2022-04-23 18:54 UTC by

Type PHP_EOL is not used in this file.

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 float

*/

    private $_connectTimeOut = 5.0;

/**

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;

/**

introduced 2022-04-20 19:38 UTC by

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

     * @var null|resource

introduced 2022-04-20 19:38 UTC by

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

*/

    private $stdErrOut = null;

/**

     * Http constructor.

introduced 2018-07-08 20:56 UTC by

Documentation comment contains forbidden comment "Http constructor.".

100

     * @param string $host

introduced 2018-09-26 10:27 UTC by

Expected 1 lines between description and annotations, found 0.

101

     * @param int $port

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

Expected 4 spaces after parameter type; 1 found

102

     * @param string $username

103

     * @param string $password

104

     * @param int $authMethod

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

Expected 4 spaces after parameter type; 1 found

105

*/

106

    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".

Coding Style introduced 2022-04-20 19:38 UTC by

Expected 1 blank line before function; 0 found

107

108

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

109

110

        $this->_username = $username;

111

        $this->_password = $password;

112

        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.

113

            $this->_authMethod = $authMethod;

114

115

116

        $this->_settings = new Settings();

117

118

        $this->setCurler();

119

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

Expected 1 blank line after function; 2 found

120

121

122

    public function setCurler() : void

introduced 2021-02-28 10:12 UTC by

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

123

124

        $this->_curler = new CurlerRolling();

125

126

127

/**

128

     * @param CurlerRolling $curler

introduced 2020-12-21 16:16 UTC by

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

129

*/

130

    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.

131

132

        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.

133

            $this->_curler = $curler;

134

135

136

137

/**

138

     * @return CurlerRolling

introduced 2021-02-28 10:12 UTC by

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

139

*/

140

    public function getCurler(): ?CurlerRolling

introduced 2021-02-28 10:12 UTC by

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

141

142

        return $this->_curler;

143

144

145

/**

146

     * @param string $host

introduced 2021-02-28 10:12 UTC by

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

147

     * @param int $port

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

Expected 4 spaces after parameter type; 1 found

introduced 2022-04-20 19:38 UTC by

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

148

*/

149

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

introduced 2021-02-28 10:12 UTC by

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

introduced 2022-04-20 19:38 UTC by

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

150

151

        if ($port > 0) {

152

            $this->_port = $port;

153

154

155

        $this->_host = $host;

156

157

158

/**

159

     * Sets client SSL certificate for Yandex Cloud

160

161

     * @param string $caPath

introduced 2021-02-28 10:12 UTC by

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

162

*/

163

    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.

164

165

        $this->sslCA = $caPath;

166

167

168

/**

169

     * @return string

introduced 2021-02-28 10:12 UTC by

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

170

*/

171

    public function getUri(): string

introduced 2021-02-28 10:12 UTC by

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

172

173

        $proto = 'http';

174

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

175

            $proto = 'https';

176

177

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

178

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

introduced 2018-07-24 07:04 UTC by

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

179

            return $uri;

180

181

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 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.

182

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

183

184

        return $uri;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

185

186

187

/**

188

     * @return Settings

introduced 2021-02-28 10:12 UTC by

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

189

*/

190

    public function settings(): Settings

introduced 2021-02-28 10:12 UTC by

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

191

192

        return $this->_settings;

193

194

195

/**

196

     * @param bool $flag

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

introduced 2022-04-20 19:38 UTC by

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

197

     * @return bool

introduced 2021-02-28 10:12 UTC by

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

198

*/

199

    public function verbose(bool $flag): bool

introduced 2022-04-20 19:38 UTC by

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

200

201

        $this->_verbose = $flag;

202

        return $flag;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

203

204

205

/**

206

     * @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.

207

     * @return string

introduced 2021-02-28 10:12 UTC by

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

208

*/

209

    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".

210

211

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

212

213

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 2.

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

214

            $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.

215

216

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

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

217

218

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

219

            unset($settings['extremes']);

220

            unset($settings['readonly']);

221

            unset($settings['enable_http_compression']);

222

            unset($settings['max_execution_time']);

223

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

Blank line found at end of control structure

224

225

226

        unset($settings['https']);

227

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

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

228

229

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 2.

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.

230

231

232

/**

233

     * @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.

234

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

235

*/

236

    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".

237

238

        $new = new CurlerRequest();

239

240

        switch ($this->_authMethod) {

241

            case self::AUTH_METHOD_QUERY_STRING:

242

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

243

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

244

*/

245

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

246

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

247

                break;

248

            case self::AUTH_METHOD_BASIC_AUTH:

249

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

250

                break;

251

            default:

252

                // Auth with headers by default

253

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

254

                break;

255

256

257

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

258

259

        $new->httpCompression($this->settings()->isEnableHttpCompression());

Bug introduced 2022-04-20 19:38 UTC by

It seems like $this->settings()->isEnableHttpCompression() can also be of type null; however, parameter $flag of ClickHouseDB\Transport\C...uest::httpCompression() does only seem to accept boolean, maybe add an additional type check? ( Ignorable by Annotation )

260

261

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

262

            $new->persistent();

263

264

        if ($this->sslCA) {

265

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

266

267

268

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

269

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

270

        $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.

271

272

        return $new;

273

274

275

/**

276

     * @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.

277

     * @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.

278

     * @param bool $query_as_string

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

Expected 2 spaces after parameter type; 1 found

introduced 2022-04-20 19:38 UTC by

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

279

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

280

     * @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.

281

*/

282

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

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

The variable $query_as_string should be in camel caps format.

283

284

        $sql = $query->toSql();

285

286

        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.

287

            $urlParams['query'] = $sql;

288

289

290

        $extendInfo = [

291

            'sql' => $sql,

292

            'query' => $query,

293

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

introduced 2020-12-21 16:16 UTC by

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

294

];

295

296

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

297

298

/*

299

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

300

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

301

*/

302

303

        if ($query->isUseInUrlBindingsParams()) {

304

            $urlParams = array_replace_recursive($urlParams, $query->getUrlBindingsParams());

introduced 2023-05-24 13:56 UTC by

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

305

306

307

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

308

        $new->url($url);

309

310

        if (!$query_as_string) {

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.

Coding Style introduced 2024-01-10 11:49 UTC by

Expected 1 space after NOT operator; 0 found

311

            $new->parameters_json($sql);

312

313

        $new->httpCompression($this->settings()->isEnableHttpCompression());

Bug introduced 2022-04-20 19:38 UTC by

314

315

        return $new;

316

317

318

/**

319

     * @param resource $stream

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

320

     * @return void

321

*/

322

    public function setStdErrOut($stream)

introduced 2022-04-20 19:38 UTC by

Method \ClickHouseDB\Transport\Http::setStdErrOut() does not have native return type hint for its return value but it should be possible to add it based on @return annotation "void".

323

324

        if (is_resource($stream)) {

introduced 2020-12-21 16:16 UTC by

Expected 0 lines after "if", found 1.

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.

325

            $this->stdErrOut=$stream;

Coding Style introduced 2023-05-24 13:56 UTC by

Expected at least 1 space before "="; 0 found

Coding Style introduced 2023-05-24 13:56 UTC by

Expected at least 1 space after "="; 0 found

Coding Style introduced 2023-05-24 13:56 UTC by

Equals sign not aligned correctly; expected 1 space but found 0 spaces

326

327

328

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

329

330

/**

331

     * @param string|Query $sql

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

332

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

333

*/

334

    public function writeStreamData($sql): CurlerRequest

335

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

Expected 0 blank lines after opening function brace; 1 found

336

337

        if ($sql instanceof Query) {

338

            $query = $sql;

339

        } else {

340

            $query = new Query($sql);

341

342

343

        $extendInfo = [

344

            'sql' => $sql,

345

            'query' => $query,

346

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

introduced 2020-12-21 16:16 UTC by

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

347

];

348

349

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

350

351

/*

352

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

353

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

354

*/

355

        $url = $this->getUrl([

356

            'readonly' => 0,

357

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

introduced 2020-12-21 16:16 UTC by

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

358

]);

359

360

        $request->url($url);

361

        return $request;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

362

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

Expected 1 blank line after function; 2 found

363

364

365

/**

366

     * @param string $sql

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

367

     * @param string $file_name

368

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

369

     * @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.

370

*/

371

    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.

372

373

        $query = new Query($sql);

374

375

        $extendinfo = [

376

            'sql' => $sql,

377

            'query' => $query,

378

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

introduced 2020-12-21 16:16 UTC by

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

379

];

380

381

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

382

383

/*

384

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

385

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

386

*/

387

        $url = $this->getUrl([

388

            'readonly' => 0,

389

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

introduced 2020-12-21 16:16 UTC by

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

390

]);

391

392

        $request->url($url);

393

394

        $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.

395

            $handle = $request->getInfileHandle();

396

            if (is_resource($handle)) {

introduced 2022-04-20 19:38 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.

397

                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.

398

399

});

400

401

        $request->setInfile($file_name);

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

The variable $file_name should be in camel caps format.

402

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

403

404

        return new Statement($request);

405

406

407

/**

408

     * get Count Pending Query in Queue

409

410

     * @return int

introduced 2021-02-28 10:12 UTC by

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

411

*/

412

    public function getCountPendingQueue(): int

413

414

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

415

416

417

/**

418

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

419

420

     * @param float $connectTimeOut

introduced 2021-02-28 10:12 UTC by

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

421

*/

422

    public function setConnectTimeOut(float $connectTimeOut)

introduced 2020-12-21 16:16 UTC by

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

423

424

        $this->_connectTimeOut = $connectTimeOut;

425

426

427

/**

428

     * get ConnectTimeOut in seconds

429

430

     * @return float

introduced 2021-02-28 10:12 UTC by

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

431

*/

432

    public function getConnectTimeOut(): float

433

434

        return $this->_connectTimeOut;

435

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

Expected 1 blank line after function; 2 found

436

437

438

    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.

439

440

        $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.

441

442

        // Search X-ClickHouse-Progress

443

        if ($code == 200) {

introduced 2021-02-28 10:12 UTC by

Expected 1 lines after "if", found 0.

introduced 2020-12-21 16:16 UTC by

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

444

            $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.

445

            $header_size = curl_getinfo($handle, CURLINFO_HEADER_SIZE);

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

The variable $header_size should be in camel caps format.

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.

446

            if (!$header_size) {

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

The variable $header_size should be in camel caps format.

Coding Style introduced 2024-01-10 11:49 UTC by

Expected 1 space after NOT operator; 0 found

447

                return false;

448

449

450

            $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.

451

            if (!$header) {

Coding Style introduced 2024-01-10 11:49 UTC by

Expected 1 space after NOT operator; 0 found

452

                return false;

453

454

455

            $match = [];

456

            if (preg_match_all('/^X-ClickHouse-(?:Progress|Summary):(.*?)$/im', $header, $match)) {

introduced 2022-12-15 11:47 UTC by

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

457

                $data = @json_decode(end($match[1]), 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 2022-12-15 11:47 UTC by

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

458

                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

459

460

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

introduced 2020-12-21 16:16 UTC by

Expected 0 lines after "if", found 1.

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.

461

                        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.

462

                    } else {

463

                        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.

464

465

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

Blank line found at end of control structure

466

467

468

469

        return false;

introduced 2021-02-28 10:12 UTC by

Expected 1 lines before "return", found 0.

470

471

472

/**

473

     * @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::getRequestRead() has useless @param annotation for parameter $query.

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

Expected 12 spaces after parameter type; 1 found

474

     * @param null|WhereInFile $whereInFile

introduced 2020-12-21 16:16 UTC by

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

475

     * @param null|WriteToFile $writeToFile

introduced 2020-12-21 16:16 UTC by

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

476

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

477

     * @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.

478

*/

479

    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".

480

481

        $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

482

        $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.

483

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

484

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

485

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

486

            $structure = $whereInFile->fetchUrlParams();

487

            // $structure = [];

488

            $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.

489

            $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.

490

491

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

492

        // if result to file

493

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

494

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

495

            unset($urlParams['extremes']);

496

497

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

498

        // makeRequest read

499

        $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.

500

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

501

        // attach files

502

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

503

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

504

505

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

506

        // result to file

507

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

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

Blank line found at start of control structure

508

509

            $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.

510

            if (is_resource($fout)) {

introduced 2022-04-20 19:38 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

511

512

                $isGz = $writeToFile->getGzip();

513

514

                if ($isGz) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 2.

515

                    // write gzip header

516

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

517

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

518

                    // write the original file name

519

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

520

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

521

522

                    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.

523

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

Blank line found at end of control structure

524

525

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

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

526

527

                $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.

528

                    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.

529

});

530

531

532

533

        if ($this->stdErrOut) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

534

            $request->setStdErrOut($this->stdErrOut);

535

536

        if ($this->xClickHouseProgress) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

537

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

538

539

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

540

        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.

541

542

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

543

544

    public function cleanQueryDegeneration(): bool

545

546

        $this->_query_degenerations = [];

Coding Style introduced 2021-10-08 16:39 UTC by

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

547

        return true;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

548

549

550

    public function addQueryDegeneration(Degeneration $degeneration): bool

551

552

        $this->_query_degenerations[] = $degeneration;

Coding Style introduced 2021-10-08 16:39 UTC by

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

553

        return true;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

554

555

556

/**

557

     * @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.

558

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

559

     * @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.

560

*/

561

    public function getRequestWrite(Query $query): CurlerRequest

562

563

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

564

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

565

566

567

/**

568

     * @throws TransportException

569

*/

570

    public function ping(): bool

571

572

        $request = new CurlerRequest();

573

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

574

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

575

576

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

introduced 2022-04-23 18:54 UTC by

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

577

578

579

/**

580

     * @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

581

     * @param mixed[] $bindings

582

     * @return Query

introduced 2021-02-28 10:12 UTC by

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

583

*/

584

    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[]".

585

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

Expected 0 blank lines after opening function brace; 1 found

586

587

        // add Degeneration query

588

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

Coding Style introduced 2021-10-08 16:39 UTC by

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

589

            $degeneration->bindParams($bindings);

590

591

592

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

Coding Style introduced 2021-10-08 16:39 UTC by

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

593

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

Expected 1 blank line after function; 2 found

594

595

596

/**

597

     * @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

598

     * @param mixed[] $bindings

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

Expected 10 spaces after parameter type; 1 found

599

     * @param null|WhereInFile $whereInFile

introduced 2020-12-21 16:16 UTC by

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

600

     * @param null|WriteToFile $writeToFile

introduced 2020-12-21 16:16 UTC by

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

601

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

602

     * @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.

603

*/

604

    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".

605

606

        if ($sql instanceof Query) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

607

            return $this->getRequestWrite($sql);

608

609

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

610

        $query->setFormat('JSON');

611

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

612

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

Expected 1 blank line after function; 2 found

613

614

615

/**

616

     * @param Query|string $sql

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

617

     * @param mixed[] $bindings

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

Expected 6 spaces after parameter type; 1 found

618

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

619

     * @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.

620

*/

621

    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[]".

622

623

        if ($sql instanceof Query) {

624

            return $this->getRequestWrite($sql);

625

626

627

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

628

629

        if (strpos($sql, 'ON CLUSTER') === false) {

introduced 2023-06-07 11:05 UTC by

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

630

            return $this->getRequestWrite($query);

631

632

633

        if (strpos($sql, 'CREATE') === 0 || strpos($sql, 'DROP') === 0 || strpos($sql, 'ALTER') === 0) {

introduced 2024-04-08 11:34 UTC by

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

634

            $query->setFormat('JSON');

635

636

637

        return $this->getRequestWrite($query);

638

639

640

/**

641

     * @return bool

introduced 2018-10-17 23:01 UTC by

Incorrect annotations group.

introduced 2021-02-28 10:12 UTC by

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

642

     * @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.

643

*/

644

    public function executeAsync(): bool

645

646

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

647

648

649

/**

650

     * @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

651

     * @param mixed[] $bindings

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

Expected 10 spaces after parameter type; 1 found

652

     * @param null|WhereInFile $whereInFile

introduced 2020-12-21 16:16 UTC by

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

653

     * @param null|WriteToFile $writeToFile

introduced 2020-12-21 16:16 UTC by

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

654

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

655

     * @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.

656

     * @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.

657

*/

658

    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".

659

660

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

661

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

662

        return new Statement($request);

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

663

664

665

/**

666

     * @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

667

     * @param mixed[] $bindings

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

Expected 10 spaces after parameter type; 1 found

668

     * @param null|WhereInFile $whereInFile

introduced 2020-12-21 16:16 UTC by

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

669

     * @param null|WriteToFile $writeToFile

introduced 2020-12-21 16:16 UTC by

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

670

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

671

     * @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.

672

     * @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.

673

*/

674

    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".

675

676

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

677

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

678

        return new Statement($request);

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

679

680

681

/**

682

     * @param callable $callback

introduced 2020-12-21 16:16 UTC by

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

683

*/

684

    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.

685

686

        $this->xClickHouseProgress = $callback;

687

688

689

/**

690

     * @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

691

     * @param mixed[] $bindings

692

     * @param bool $exception

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

Expected 4 spaces after parameter type; 1 found

693

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

694

     * @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.

695

*/

696

    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".

697

698

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

699

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

700

        $response = new Statement($request);

701

        if ($exception) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

702

            if ($response->isError()) {

703

                $response->error();

704

705

706

        return $response;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

707

708

709

/**

710

     * @param Stream $streamRW

introduced 2020-12-21 16:16 UTC by

Incorrect annotations group.

introduced 2020-12-21 16:16 UTC by

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

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

Expected 8 spaces after parameter type; 1 found

711

     * @param CurlerRequest $request

introduced 2020-12-21 16:16 UTC by

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

712

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

713

     * @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.

714

*/

715

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

716

717

        $callable = $streamRW->getClosure();

718

        $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

719

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

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

720

721

        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.

722

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

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

723

724

            if (!is_callable($callable)) {

Coding Style introduced 2024-01-10 11:49 UTC by

Expected 1 space 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.

725

                if ($streamRW->isWrite()) {

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

Blank line found at start of control structure

726

727

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

introduced 2018-09-26 10:27 UTC by

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

728

                        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.

729

};

730

                } else {

731

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

introduced 2018-09-26 10:27 UTC by

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

732

                        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.

733

};

734

735

736

737

            if ($streamRW->isGzipHeader()) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 2.

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

Blank line found at start of control structure

738

739

                if ($streamRW->isWrite()) {

introduced 2022-04-20 19:38 UTC by

Expected 0 lines after "if", found 1.

740

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

741

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

742

                } else {

743

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

744

745

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

Blank line found at end of control structure

746

747

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

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

748

749

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

750

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

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

751

752

            if ($streamRW->isWrite()) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 2.

753

                $request->setReadFunction($callable);

754

            } else {

755

                $request->setWriteFunction($callable);

756

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

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

757

758

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

759

760

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

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

761

762

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

763

            $response = new Statement($request);

764

            if ($response->isError()) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

765

                $response->error();

766

767

            return $response;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

768

        } finally {

769

            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.

770

                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.

771

772

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

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

773

774

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

775

776

777

/**

778

     * @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

779

     * @param string $sql

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

Expected 2 spaces after parameter type; 1 found

780

     * @param mixed[] $bindings

781

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

782

     * @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.

783

*/

784

    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[]".

785

786

        $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

787

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

788

        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.

789

790

Coding Style introduced 2022-04-20 19:38 UTC by

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

791

792

/**

793

     * @param Stream $streamWrite

introduced 2022-04-20 19:38 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

794

     * @param string $sql

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

Expected 2 spaces after parameter type; 1 found

795

     * @param mixed[] $bindings

796

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

797

     * @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.

798

*/

799

    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[]".

800

801

        $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

802

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

803

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

804

805

806

smi2 / phpClickHouse

Http::prepareQuery() A last analyzed 2024-07-17 07:54 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Http::prepareQuery() A
last analyzed 2024-07-17 07:54 UTC