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

Passed

Pull Request — master (#220)

unknown

created 2024-07-19 08:41 UTC

Http::streamWrite() A

↳ Parent: Http

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	1
eloc	3
c	2
b	0
f	0
nc	1
nop	3
dl	0
loc	5
ccs	0
cts	0
cp	0
crap	2
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

        $this->setHandle();

126

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

Expected 1 blank line after function; 2 found

127

128

129

    public function setCurler() : void

introduced 2021-02-28 10:12 UTC by

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

130

131

        $this->_curler = new CurlerRolling();

132

133

134

/**

135

     * @param CurlerRolling $curler

introduced 2020-12-21 16:16 UTC by

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

136

*/

137

    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.

138

139

        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.

140

            $this->_curler = $curler;

141

142

143

144

/**

145

     * @return CurlerRolling

introduced 2021-02-28 10:12 UTC by

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

146

*/

147

    public function getCurler(): ?CurlerRolling

introduced 2021-02-28 10:12 UTC by

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

148

149

        return $this->_curler;

150

151

152

/**

153

     * @param string $host

introduced 2021-02-28 10:12 UTC by

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

154

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

155

*/

156

    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.

157

158

        if ($port > 0) {

159

            $this->_port = $port;

160

161

162

        $this->_host = $host;

163

164

165

/**

166

     * Sets client SSL certificate for Yandex Cloud

167

168

     * @param string $caPath

introduced 2021-02-28 10:12 UTC by

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

169

*/

170

    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.

171

172

        $this->sslCA = $caPath;

173

174

175

/**

176

     * @return string

introduced 2021-02-28 10:12 UTC by

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

177

*/

178

    public function getUri(): string

introduced 2021-02-28 10:12 UTC by

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

179

180

        $proto = 'http';

181

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

182

            $proto = 'https';

183

184

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

185

        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.

186

            return $uri;

187

188

        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.

189

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

190

191

        return $uri;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

192

193

194

/**

195

     * @return Settings

introduced 2021-02-28 10:12 UTC by

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

196

*/

197

    public function settings(): Settings

introduced 2021-02-28 10:12 UTC by

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

198

199

        return $this->_settings;

200

201

202

/**

203

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

204

     * @return bool

introduced 2021-02-28 10:12 UTC by

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

205

*/

206

    public function verbose(bool $flag): bool

introduced 2022-04-20 19:38 UTC by

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

207

208

        $this->_verbose = $flag;

209

        return $flag;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

210

211

212

/**

213

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

214

     * @return string

introduced 2021-02-28 10:12 UTC by

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

215

*/

216

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

217

218

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

219

220

        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

221

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

222

223

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

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

224

225

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

226

            unset($settings['extremes']);

227

            unset($settings['readonly']);

228

            unset($settings['enable_http_compression']);

229

            unset($settings['max_execution_time']);

230

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

Blank line found at end of control structure

231

232

233

        unset($settings['https']);

234

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

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

235

236

        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.

237

238

239

/**

240

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

241

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

242

*/

243

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

244

245

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

246

247

        switch ($this->_authMethod) {

248

            case self::AUTH_METHOD_QUERY_STRING:

249

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

250

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

251

*/

252

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

253

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

254

                break;

255

            case self::AUTH_METHOD_BASIC_AUTH:

256

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

257

                break;

258

            default:

259

                // Auth with headers by default

260

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

261

                break;

262

263

264

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

265

266

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

267

268

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

269

            $new->persistent();

270

271

        if ($this->sslCA) {

272

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

273

274

275

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

276

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

277

        $new->keepAlive();

278

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

279

280

        return $new;

281

282

283

/**

284

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

285

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

286

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

287

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

288

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

289

*/

290

    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.

291

292

        $sql = $query->toSql();

293

294

        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.

295

            $urlParams['query'] = $sql;

296

297

298

        $extendInfo = [

299

            'sql' => $sql,

300

            'query' => $query,

301

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

introduced 2020-12-21 16:16 UTC by

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

302

];

303

304

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

305

306

/*

307

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

308

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

309

*/

310

311

        if ($query->isUseInUrlBindingsParams()) {

312

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

313

314

315

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

316

        $new->url($url);

317

318

        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.

319

            $new->parameters_json($sql);

320

321

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

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

322

323

        return $new;

324

325

326

/**

327

     * @param resource $stream

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

328

     * @return void

329

*/

330

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

331

332

        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.

333

            $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

334

335

336

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

337

338

/**

339

     * @param string|Query $sql

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

340

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

341

*/

342

    public function writeStreamData($sql): CurlerRequest

343

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

Expected 0 blank lines after opening function brace; 1 found

344

345

        if ($sql instanceof Query) {

346

            $query = $sql;

347

        } else {

348

            $query = new Query($sql);

349

350

351

        $extendInfo = [

352

            'sql' => $sql,

353

            'query' => $query,

354

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

introduced 2020-12-21 16:16 UTC by

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

355

];

356

357

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

358

359

/*

360

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

361

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

362

*/

363

        $url = $this->getUrl([

364

            'readonly' => 0,

365

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

introduced 2020-12-21 16:16 UTC by

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

366

]);

367

368

        $request->url($url);

369

        return $request;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

370

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

Expected 1 blank line after function; 2 found

371

372

373

/**

374

     * @param string $sql

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

375

     * @param string $file_name

376

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

377

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

378

*/

379

    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.

380

381

        $query = new Query($sql);

382

383

        $extendinfo = [

384

            'sql' => $sql,

385

            'query' => $query,

386

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

introduced 2020-12-21 16:16 UTC by

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

387

];

388

389

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

390

391

/*

392

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

393

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

394

*/

395

        $url = $this->getUrl([

396

            'readonly' => 0,

397

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

introduced 2020-12-21 16:16 UTC by

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

398

]);

399

400

        $request->url($url);

401

402

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

403

            $handle = $request->getInfileHandle();

404

            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.

405

                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.

406

407

});

408

409

        $request->setInfile($file_name);

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

The variable $file_name should be in camel caps format.

410

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

411

412

        return new Statement($request);

413

414

415

/**

416

     * get Count Pending Query in Queue

417

418

     * @return int

introduced 2021-02-28 10:12 UTC by

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

419

*/

420

    public function getCountPendingQueue(): int

421

422

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

423

424

425

/**

426

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

427

428

     * @param float $connectTimeOut

introduced 2021-02-28 10:12 UTC by

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

429

*/

430

    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.

431

432

        $this->_connectTimeOut = $connectTimeOut;

433

434

435

/**

436

     * get ConnectTimeOut in seconds

437

438

     * @return float

introduced 2021-02-28 10:12 UTC by

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

439

*/

440

    public function getConnectTimeOut(): float

441

442

        return $this->_connectTimeOut;

443

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

Expected 1 blank line after function; 2 found

444

445

446

    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.

447

448

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

449

450

        // Search X-ClickHouse-Progress

451

        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.

452

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

453

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

454

            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.

455

                return false;

456

457

458

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

459

            if (!$header) {

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

Expected 1 space after NOT operator; 0 found

460

                return false;

461

462

463

            $match = [];

464

            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.

465

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

466

                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

467

468

                    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.

469

                        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.

470

                    } else {

471

                        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.

472

473

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

Blank line found at end of control structure

474

475

476

477

        return false;

introduced 2021-02-28 10:12 UTC by

Expected 1 lines before "return", found 0.

478

479

480

/**

481

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

482

     * @param null|WhereInFile $whereInFile

introduced 2020-12-21 16:16 UTC by

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

483

     * @param null|WriteToFile $writeToFile

introduced 2020-12-21 16:16 UTC by

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

484

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

485

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

486

*/

487

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

488

489

        $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

490

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

491

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

492

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

493

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

494

            $structure = $whereInFile->fetchUrlParams();

495

            // $structure = [];

496

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

497

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

498

499

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

500

        // if result to file

501

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

502

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

503

            unset($urlParams['extremes']);

504

505

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

506

        // makeRequest read

507

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

508

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

509

        // attach files

510

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

511

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

512

513

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

514

        // result to file

515

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

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

Blank line found at start of control structure

516

517

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

518

            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

519

520

                $isGz = $writeToFile->getGzip();

521

522

                if ($isGz) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 2.

523

                    // write gzip header

524

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

525

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

526

                    // write the original file name

527

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

528

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

529

530

                    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.

531

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

Blank line found at end of control structure

532

533

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

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

534

535

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

536

                    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.

537

});

538

539

540

541

        if ($this->stdErrOut) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

542

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

543

544

        if ($this->xClickHouseProgress) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

545

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

546

547

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

548

        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.

549

550

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

551

552

    public function cleanQueryDegeneration(): bool

553

554

        $this->_query_degenerations = [];

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

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

555

        return true;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

556

557

558

    public function addQueryDegeneration(Degeneration $degeneration): bool

559

560

        $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

561

        return true;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

562

563

564

/**

565

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

566

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

567

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

568

*/

569

    public function getRequestWrite(Query $query): CurlerRequest

570

571

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

572

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

573

574

575

/**

576

     * @throws TransportException

577

*/

578

    public function ping(): bool

579

580

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

581

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

582

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

583

584

        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.

585

586

587

/**

588

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

589

     * @param mixed[] $bindings

590

     * @return Query

introduced 2021-02-28 10:12 UTC by

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

591

*/

592

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

593

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

Expected 0 blank lines after opening function brace; 1 found

594

595

        // add Degeneration query

596

        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

597

            $degeneration->bindParams($bindings);

598

599

600

        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

601

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

Expected 1 blank line after function; 2 found

602

603

604

/**

605

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

606

     * @param mixed[] $bindings

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

Expected 10 spaces after parameter type; 1 found

607

     * @param null|WhereInFile $whereInFile

introduced 2020-12-21 16:16 UTC by

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

608

     * @param null|WriteToFile $writeToFile

introduced 2020-12-21 16:16 UTC by

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

609

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

610

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

611

*/

612

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

613

614

        if ($sql instanceof Query) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

615

            return $this->getRequestWrite($sql);

616

617

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

618

        $query->setFormat('JSON');

619

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

620

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

Expected 1 blank line after function; 2 found

621

622

623

/**

624

     * @param Query|string $sql

introduced 2018-09-26 10:27 UTC by

Incorrect annotations group.

625

     * @param mixed[] $bindings

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

Expected 6 spaces after parameter type; 1 found

626

     * @return CurlerRequest

introduced 2021-02-28 10:12 UTC by

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

627

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

628

*/

629

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

630

631

        if ($sql instanceof Query) {

632

            return $this->getRequestWrite($sql);

633

634

635

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

636

637

        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.

638

            return $this->getRequestWrite($query);

639

640

641

        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.

642

            $query->setFormat('JSON');

643

644

645

        return $this->getRequestWrite($query);

646

647

648

/**

649

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

650

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

651

*/

652

    public function executeAsync(): bool

653

654

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

655

656

657

/**

658

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

659

     * @param mixed[] $bindings

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

Expected 10 spaces after parameter type; 1 found

660

     * @param null|WhereInFile $whereInFile

introduced 2020-12-21 16:16 UTC by

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

661

     * @param null|WriteToFile $writeToFile

introduced 2020-12-21 16:16 UTC by

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

662

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

663

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

664

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

665

*/

666

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

667

668

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

669

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

670

        return new Statement($request);

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

671

672

673

/**

674

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

675

     * @param mixed[] $bindings

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

Expected 10 spaces after parameter type; 1 found

676

     * @param null|WhereInFile $whereInFile

introduced 2020-12-21 16:16 UTC by

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

677

     * @param null|WriteToFile $writeToFile

introduced 2020-12-21 16:16 UTC by

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

678

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

679

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

680

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

681

*/

682

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

683

684

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

685

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

686

        return new Statement($request);

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

687

688

689

/**

690

     * @param callable $callback

introduced 2020-12-21 16:16 UTC by

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

691

*/

692

    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.

693

694

        $this->xClickHouseProgress = $callback;

695

696

697

/**

698

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

699

     * @param mixed[] $bindings

700

     * @param bool $exception

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

Expected 4 spaces after parameter type; 1 found

701

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

702

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

703

*/

704

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

705

706

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

707

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

708

        $response = new Statement($request);

709

        if ($exception) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

710

            if ($response->isError()) {

711

                $response->error();

712

713

714

        return $response;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

715

716

717

/**

718

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

719

     * @param CurlerRequest $request

introduced 2020-12-21 16:16 UTC by

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

720

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

721

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

722

*/

723

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

724

725

        $callable = $streamRW->getClosure();

726

        $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

727

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

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

728

729

        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

730

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

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

731

732

            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.

733

                if ($streamRW->isWrite()) {

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

Blank line found at start of control structure

734

735

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

introduced 2018-09-26 10:27 UTC by

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

736

                        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.

737

};

738

                } else {

739

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

introduced 2018-09-26 10:27 UTC by

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

740

                        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.

741

};

742

743

744

745

            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

746

747

                if ($streamRW->isWrite()) {

introduced 2022-04-20 19:38 UTC by

Expected 0 lines after "if", found 1.

748

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

749

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

750

                } else {

751

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

752

753

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

Blank line found at end of control structure

754

755

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

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

756

757

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

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

764

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

765

766

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

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

767

768

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

769

            $response = new Statement($request);

770

            if ($response->isError()) {

introduced 2020-12-21 16:16 UTC by

Expected 1 lines after "if", found 0.

771

                $response->error();

772

773

            return $response;

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

774

        } finally {

775

            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.

776

                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.

777

778

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

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

779

780

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

781

782

783

/**

784

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

785

     * @param string $sql

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

Expected 2 spaces after parameter type; 1 found

786

     * @param mixed[] $bindings

787

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

788

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

789

*/

790

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

791

792

        $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

793

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

794

        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.

795

796

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

797

798

/**

799

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

800

     * @param string $sql

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

Expected 2 spaces after parameter type; 1 found

801

     * @param mixed[] $bindings

802

     * @return Statement

introduced 2021-02-28 10:12 UTC by

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

803

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

804

*/

805

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

806

807

        $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

808

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

809

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

introduced 2020-12-21 16:16 UTC by

Expected 1 lines before "return", found 0.

810

811

812

    public function __destruct()

813

814

        if ($this->handle) {

introduced 2024-07-15 07:05 UTC by

Use early exit to reduce code nesting.

815

            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.

816

817

818

819

    public function setHandle()

introduced 2024-07-17 04:34 UTC by

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

820

821

        $this->handle = curl_init();

Documentation Bug introduced 2024-07-17 04:34 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-17 04:34 UTC by

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

822

Coding Style introduced 2024-07-17 04:34 UTC by

Expected 0 blank lines after function; 1 found

823

824

introduced 2024-07-17 04:34 UTC by

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

825

smi2 / phpClickHouse

Pull Request — master (#220)

Http::streamWrite() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like