Http::getRequestWrite() - Code Metrics - Inspection of "Support KeepAlive to avoid duplicate connections" - smi2/phpClickHouse - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#220)

unknown

created 2024-07-15 06:56 UTC

Http::getRequestWrite() A

↳ Parent: Http

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	1

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

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

/**

introduced 2024-07-15 07:05 UTC by

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

100

     * @var null|resource

introduced 2024-07-15 07:05 UTC by

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

101

*/

102

    private $handle = null;

103

104

/**

105

     * Http constructor.

introduced 2018-07-08 20:56 UTC by

Documentation comment contains forbidden comment "Http constructor.".

106

     * @param string $host

introduced 2018-09-26 10:27 UTC by

Expected 1 lines between description and annotations, found 0.

107

     * @param int $port

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

Expected 4 spaces after parameter type; 1 found

108

     * @param string $username

109

     * @param string $password

110

     * @param int $authMethod

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

Expected 4 spaces after parameter type; 1 found

111

*/

112

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

113

114

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

115

116

        $this->_username = $username;

117

        $this->_password = $password;

118

        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.

119

            $this->_authMethod = $authMethod;

120

121

122

        $this->_settings = new Settings();

123

124

        $this->setCurler();

125

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

Expected 1 blank line after function; 2 found

126

127

128

    public function setCurler() : void

introduced 2021-02-28 10:12 UTC by

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

129

130

        $this->_curler = new CurlerRolling();

131

132

133

/**

134

     * @param CurlerRolling $curler

introduced 2020-12-21 16:16 UTC by

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

135

*/

136

    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.

137

138

        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.

139

            $this->_curler = $curler;

140

141

142

143

/**

144

     * @return CurlerRolling

introduced 2021-02-28 10:12 UTC by

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

145

*/

146

    public function getCurler(): ?CurlerRolling

introduced 2021-02-28 10:12 UTC by

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

147

148

        return $this->_curler;

149

150

151

/**

152

     * @param string $host

introduced 2021-02-28 10:12 UTC by

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

153

     * @param int $port

introduced 2022-04-20 19:38 UTC by

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

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

Expected 4 spaces after parameter type; 1 found

154

*/

155

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

introduced 2022-04-20 19:38 UTC by

Method \ClickHouseDB\Transport\Http::setHost() 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.

156

157

        if ($port > 0) {

158

            $this->_port = $port;

159

160

161

        $this->_host = $host;

162

163

164

/**

165

     * Sets client SSL certificate for Yandex Cloud

166

167

     * @param string $caPath

introduced 2021-02-28 10:12 UTC by

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

168

*/

169

    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.

170

171

        $this->sslCA = $caPath;

172

173

174

/**

175

     * @return string

introduced 2021-02-28 10:12 UTC by

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

176

*/

177

    public function getUri(): string

introduced 2021-02-28 10:12 UTC by

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

178

179

        $proto = 'http';

180

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

181

            $proto = 'https';

182

183

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

184

        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.

185

            return $uri;

186

187

        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.

188

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

189

190

        return $uri;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

191

192

193

/**

194

     * @return Settings

introduced 2021-02-28 10:12 UTC by

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

195

*/

196

    public function settings(): Settings

introduced 2021-02-28 10:12 UTC by

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

197

198

        return $this->_settings;

199

200

201

/**

202

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

203

     * @return bool

introduced 2021-02-28 10:12 UTC by

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

204

*/

205

    public function verbose(bool $flag): bool

introduced 2022-04-20 19:38 UTC by

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

206

207

        $this->_verbose = $flag;

208

        return $flag;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

209

210

211

/**

212

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

213

     * @return string

introduced 2021-02-28 10:12 UTC by

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

214

*/

215

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

216

217

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

218

219

        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

220

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

221

222

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

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

223

224

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

225

            unset($settings['extremes']);

226

            unset($settings['readonly']);

227

            unset($settings['enable_http_compression']);

228

            unset($settings['max_execution_time']);

229

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

Blank line found at end of control structure

230

231

232

        unset($settings['https']);

233

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

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

234

235

        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.

236

237

238

/**

239

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

240

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

241

*/

242

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

243

244

        $new = new CurlerRequest(false, $this->getHandle());

245

246

        switch ($this->_authMethod) {

247

            case self::AUTH_METHOD_QUERY_STRING:

248

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

249

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

250

*/

251

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

252

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

253

                break;

254

            case self::AUTH_METHOD_BASIC_AUTH:

255

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

256

                break;

257

            default:

258

                // Auth with headers by default

259

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

260

                break;

261

262

263

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

264

265

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

266

267

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

268

            $new->persistent();

269

270

        if ($this->sslCA) {

271

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

272

273

274

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

275

        $new->connectTimeOut($this->_connectTimeOut);

276

        $new->keepAlive();

277

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

278

279

        return $new;

280

281

282

/**

283

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

284

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

285

     * @param bool $query_as_string

introduced 2022-04-20 19:38 UTC by

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

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

Expected 2 spaces after parameter type; 1 found

286

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

287

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

288

*/

289

    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.

290

291

        $sql = $query->toSql();

292

293

        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.

294

            $urlParams['query'] = $sql;

295

296

297

        $extendInfo = [

298

            'sql' => $sql,

299

            'query' => $query,

300

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

introduced 2020-12-21 16:16 UTC by

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

301

];

302

303

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

304

305

/*

306

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

307

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

308

*/

309

310

        if ($query->isUseInUrlBindingsParams()) {

311

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

312

313

314

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

315

        $new->url($url);

316

317

        if (!$query_as_string) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

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

Expected 1 space after NOT operator; 0 found

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

The variable $query_as_string should be in camel caps format.

318

            $new->parameters_json($sql);

319

320

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

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

321

322

        return $new;

323

324

325

/**

326

     * @param resource $stream

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

327

     * @return void

328

*/

329

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

330

331

        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.

332

            $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

333

334

335

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

336

337

/**

338

     * @param string|Query $sql

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

339

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

340

*/

341

    public function writeStreamData($sql): CurlerRequest

342

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

Expected 0 blank lines after opening function brace; 1 found

343

344

        if ($sql instanceof Query) {

345

            $query = $sql;

346

        } else {

347

            $query = new Query($sql);

348

349

350

        $extendInfo = [

351

            'sql' => $sql,

352

            'query' => $query,

353

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

introduced 2020-12-21 16:16 UTC by

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

354

];

355

356

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

357

358

/*

359

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

360

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

361

*/

362

        $url = $this->getUrl([

363

            'readonly' => 0,

364

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

introduced 2020-12-21 16:16 UTC by

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

365

]);

366

367

        $request->url($url);

368

        return $request;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

369

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

Expected 1 blank line after function; 2 found

370

371

372

/**

373

     * @param string $sql

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

374

     * @param string $file_name

375

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

376

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

377

*/

378

    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.

379

380

        $query = new Query($sql);

381

382

        $extendinfo = [

383

            'sql' => $sql,

384

            'query' => $query,

385

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

introduced 2020-12-21 16:16 UTC by

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

386

];

387

388

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

389

390

/*

391

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

392

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

393

*/

394

        $url = $this->getUrl([

395

            'readonly' => 0,

396

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

introduced 2020-12-21 16:16 UTC by

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

397

]);

398

399

        $request->url($url);

400

401

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

402

            $handle = $request->getInfileHandle();

403

            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.

404

                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.

405

406

});

407

408

        $request->setInfile($file_name);

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

The variable $file_name should be in camel caps format.

409

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

410

411

        return new Statement($request);

412

413

414

/**

415

     * get Count Pending Query in Queue

416

417

     * @return int

introduced 2021-02-28 10:12 UTC by

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

418

*/

419

    public function getCountPendingQueue(): int

420

421

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

422

423

424

/**

425

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

426

427

     * @param float $connectTimeOut

introduced 2021-02-28 10:12 UTC by

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

428

*/

429

    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.

430

431

        $this->_connectTimeOut = $connectTimeOut;

432

433

434

/**

435

     * get ConnectTimeOut in seconds

436

437

     * @return float

introduced 2021-02-28 10:12 UTC by

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

438

*/

439

    public function getConnectTimeOut(): float

440

441

        return $this->_connectTimeOut;

442

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

Expected 1 blank line after function; 2 found

443

444

445

    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.

446

447

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

448

449

        // Search X-ClickHouse-Progress

450

        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.

451

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

452

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

453

            if (!$header_size) {

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

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

454

                return false;

455

456

457

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

458

            if (!$header) {

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

Expected 1 space after NOT operator; 0 found

459

                return false;

460

461

462

            $match = [];

463

            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.

464

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

465

                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

466

467

                    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.

468

                        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.

469

                    } else {

470

                        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.

471

472

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

Blank line found at end of control structure

473

474

475

476

        return false;

introduced 2021-02-28 10:12 UTC by

Expected 1 lines before "return", found 0.

477

478

479

/**

480

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

481

     * @param null|WhereInFile $whereInFile

introduced 2020-12-21 16:16 UTC by

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

482

     * @param null|WriteToFile $writeToFile

introduced 2020-12-21 16:16 UTC by

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

483

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

484

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

485

*/

486

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

487

488

        $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

489

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

490

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

491

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

492

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

493

            $structure = $whereInFile->fetchUrlParams();

494

            // $structure = [];

495

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

496

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

497

498

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

499

        // if result to file

500

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

501

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

502

            unset($urlParams['extremes']);

503

504

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

505

        // makeRequest read

506

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

507

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

508

        // attach files

509

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

510

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

511

512

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

513

        // result to file

514

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

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

Blank line found at start of control structure

515

516

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

517

            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

518

519

                $isGz = $writeToFile->getGzip();

520

521

                if ($isGz) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 2.

522

                    // write gzip header

523

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

524

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

525

                    // write the original file name

526

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

527

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

528

529

                    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.

530

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

Blank line found at end of control structure

531

532

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

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

533

534

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

535

                    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.

536

});

537

538

539

540

        if ($this->stdErrOut) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

541

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

542

543

        if ($this->xClickHouseProgress) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

544

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

545

546

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

547

        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.

548

549

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

550

551

    public function cleanQueryDegeneration(): bool

552

553

        $this->_query_degenerations = [];

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

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

554

        return true;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

555

556

557

    public function addQueryDegeneration(Degeneration $degeneration): bool

558

559

        $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

560

        return true;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

561

562

563

/**

564

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

565

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

566

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

567

*/

568

    public function getRequestWrite(Query $query): CurlerRequest

569

570

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

571

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

572

573

574

/**

575

     * @throws TransportException

576

*/

577

    public function ping(): bool

578

579

        $request = new CurlerRequest(false, $this->getHandle());

580

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

581

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

582

583

        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.

584

585

586

/**

587

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

588

     * @param mixed[] $bindings

589

     * @return Query

introduced 2021-02-28 10:12 UTC by

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

590

*/

591

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

592

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

Expected 0 blank lines after opening function brace; 1 found

593

594

        // add Degeneration query

595

        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

596

            $degeneration->bindParams($bindings);

597

598

599

        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

600

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

Expected 1 blank line after function; 2 found

601

602

603

/**

604

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

605

     * @param mixed[] $bindings

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

Expected 10 spaces after parameter type; 1 found

606

     * @param null|WhereInFile $whereInFile

introduced 2020-12-21 16:16 UTC by

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

607

     * @param null|WriteToFile $writeToFile

introduced 2020-12-21 16:16 UTC by

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

608

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

609

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

610

*/

611

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

612

613

        if ($sql instanceof Query) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

614

            return $this->getRequestWrite($sql);

615

616

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

617

        $query->setFormat('JSON');

618

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

619

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

Expected 1 blank line after function; 2 found

620

621

622

/**

623

     * @param Query|string $sql

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

624

     * @param mixed[] $bindings

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

Expected 6 spaces after parameter type; 1 found

625

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

626

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

627

*/

628

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

629

630

        if ($sql instanceof Query) {

631

            return $this->getRequestWrite($sql);

632

633

634

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

635

636

        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.

637

            return $this->getRequestWrite($query);

638

639

640

        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.

641

            $query->setFormat('JSON');

642

643

644

        return $this->getRequestWrite($query);

645

646

647

/**

648

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

649

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

650

*/

651

    public function executeAsync(): bool

652

653

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

654

655

656

/**

657

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

658

     * @param mixed[] $bindings

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

Expected 10 spaces after parameter type; 1 found

659

     * @param null|WhereInFile $whereInFile

introduced 2020-12-21 16:16 UTC by

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

660

     * @param null|WriteToFile $writeToFile

introduced 2020-12-21 16:16 UTC by

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

661

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

662

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

663

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

664

*/

665

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

666

667

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

668

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

669

        return new Statement($request);

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

670

671

672

/**

673

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

674

     * @param mixed[] $bindings

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

Expected 10 spaces after parameter type; 1 found

675

     * @param null|WhereInFile $whereInFile

introduced 2020-12-21 16:16 UTC by

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

676

     * @param null|WriteToFile $writeToFile

introduced 2020-12-21 16:16 UTC by

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

677

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

678

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

679

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

680

*/

681

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

682

683

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

684

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

685

        return new Statement($request);

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

686

687

688

/**

689

     * @param callable $callback

introduced 2020-12-21 16:16 UTC by

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

690

*/

691

    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.

692

693

        $this->xClickHouseProgress = $callback;

694

695

696

/**

697

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

698

     * @param mixed[] $bindings

699

     * @param bool $exception

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

Expected 4 spaces after parameter type; 1 found

700

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

701

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

702

*/

703

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

704

705

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

706

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

707

        $response = new Statement($request);

708

        if ($exception) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

709

            if ($response->isError()) {

710

                $response->error();

711

712

713

        return $response;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

714

715

716

/**

717

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

718

     * @param CurlerRequest $request

introduced 2020-12-21 16:16 UTC by

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

719

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

720

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

721

*/

722

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

723

724

        $callable = $streamRW->getClosure();

725

        $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

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

        try {

introduced 2020-12-21 16:16 UTC by

Expected 0 lines after "try", found 2.

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

Blank line found at start of control structure

729

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

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

730

731

            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.

732

                if ($streamRW->isWrite()) {

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

Blank line found at start of control structure

733

734

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

introduced 2018-09-26 10:27 UTC by

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

735

                        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.

736

};

737

                } else {

738

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

introduced 2018-09-26 10:27 UTC by

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

739

                        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.

740

};

741

742

743

744

            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

745

746

                if ($streamRW->isWrite()) {

introduced 2022-04-20 19:38 UTC by

Expected 0 lines after "if", found 1.

747

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

748

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

749

                } else {

750

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

751

752

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

Blank line found at end of control structure

753

754

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

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

755

756

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

757

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

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

758

759

            if ($streamRW->isWrite()) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 2.

760

                $request->setReadFunction($callable);

761

            } else {

762

                $request->setWriteFunction($callable);

763

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

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

764

765

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

766

767

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

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

768

769

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

770

            $response = new Statement($request);

771

            if ($response->isError()) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

772

                $response->error();

773

774

            return $response;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

775

        } finally {

776

            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.

777

                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.

778

779

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

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

780

781

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

782

783

784

/**

785

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

786

     * @param string $sql

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

Expected 2 spaces after parameter type; 1 found

787

     * @param mixed[] $bindings

788

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

789

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

790

*/

791

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

792

793

        $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

794

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

795

        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.

796

797

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

798

799

/**

800

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

801

     * @param string $sql

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

Expected 2 spaces after parameter type; 1 found

802

     * @param mixed[] $bindings

803

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

804

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

805

*/

806

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

807

808

        $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

809

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

810

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

811

812

813

    public function __destruct()

814

815

        if ($this->handle) {

introduced 2024-07-15 07:05 UTC by

Use early exit to reduce code nesting.

816

            curl_close($this->handle);

introduced 2018-07-08 20:56 UTC by

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

817

818

Coding Style introduced 2024-07-15 07:05 UTC by

Expected 1 blank line after function; 2 found

819

820

821

    public function getHandle()

introduced 2024-07-15 07:05 UTC by

Method \ClickHouseDB\Transport\Http::getHandle() does not have return type hint nor @return annotation for its return value.

822

823

        if (!$this->handle) {

Coding Style introduced 2024-07-15 07:05 UTC by

Expected 1 space after NOT operator; 0 found

824

            $this->handle = curl_init();

Documentation Bug introduced 2024-07-15 07:05 UTC by

It seems like curl_init() can also be of type CurlHandle. However, the property $handle is declared as type null|resource. Maybe add an additional type check?

introduced 2024-07-15 07:05 UTC by

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

825

826

827

        return $this->handle;

828

Coding Style introduced 2024-07-15 07:05 UTC by

Expected 0 blank lines after function; 1 found

829

830

introduced 2024-07-15 07:05 UTC by

There must be exactly 0 empty lines before class closing brace.

831

smi2 / phpClickHouse

Pull Request — master (#220)

Http::getRequestWrite() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like