smi2 / phpClickHouse

src/Transport/Http.php

<?php

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;

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

Type PHP_EOL is not used in this file.

class Http
{
    const AUTH_METHOD_HEADER       = 1;

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

    const AUTH_METHOD_QUERY_STRING = 2;

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

    const AUTH_METHOD_BASIC_AUTH   = 3;

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

    const AUTH_METHODS_LIST = [

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

        self::AUTH_METHOD_HEADER,
        self::AUTH_METHOD_QUERY_STRING,
        self::AUTH_METHOD_BASIC_AUTH,
    ];

    /**

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

     * @var string
     */
    private $_username = null;

    /**

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/

Incorrect annotations group.

     * @var int
     */
    private $_authMethod = self::AUTH_METHOD_HEADER;

    /**

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

     * @var string
     */
    private $_host = '';

    /**

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

     * @var int
     */
    private $_port = 0;

    /**

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;

    /**

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

     * @var CurlerRolling
     */
    private $_curler = null;

    /**

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

     * @var Settings
     */
    private $_settings = null;

    /**

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

     * @var array

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

     */
    private $_query_degenerations = [];

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

    /**
     * Count seconds (int)
     *
     * @var float
     */
    private $_connectTimeOut = 5.0;

    /**

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

     * @var callable
     */
    private $xClickHouseProgress = null;

    /**

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

     * @var null|string

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

     */
    private $sslCA = null;

    /**

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

     * @var null|resource

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

     */
    private $stdErrOut = null;
    /**
     * Http constructor.

Documentation comment contains forbidden comment "Http constructor.".

     * @param string $host

Expected 1 lines between description and annotations, found 0.

     * @param int $port

Expected 4 spaces after parameter type; 1 found

     * @param string $username
     * @param string $password
     * @param int $authMethod

Expected 4 spaces after parameter type; 1 found

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

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

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

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

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

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

Expected 1 blank line before function; 0 found

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

        $this->_username = $username;
        $this->_password = $password;
        if ($authMethod) {

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.

            $this->_authMethod = $authMethod;
        }

        $this->_settings = new Settings();

        $this->setCurler();
    }

Expected 1 blank line after function; 2 found

    public function setCurler() : void

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

    {
        $this->_curler = new CurlerRolling();
    }

    /**
     * @param CurlerRolling $curler

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

     */
    public function setDirtyCurler(CurlerRolling $curler) : void

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

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

    {
        if ($curler instanceof CurlerRolling) {

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

Use early exit to reduce code nesting.

            $this->_curler = $curler;
        }
    }

    /**
     * @return CurlerRolling

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

     */
    public function getCurler(): ?CurlerRolling

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

    {
        return $this->_curler;
    }

    /**
     * @param string $host

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

     * @param int $port

Expected 4 spaces after parameter type; 1 found

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

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

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

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

    {
        if ($port > 0) {
            $this->_port = $port;
        }

        $this->_host = $host;
    }

    /**
     * Sets client SSL certificate for Yandex Cloud
     *
     * @param string $caPath

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

     */
    public function setSslCa(string $caPath) : void

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

    {
        $this->sslCA = $caPath;
    }

    /**
     * @return string

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

     */
    public function getUri(): string

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

    {
        $proto = 'http';
        if ($this->settings()->isHttps()) {

Expected 1 lines after "if", found 0.

            $proto = 'https';
        }
        $uri = $proto . '://' . $this->_host;
        if (stripos($this->_host, '/') !== false || stripos($this->_host, ':') !== false) {

Expected 1 lines after "if", found 0.

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

            return $uri;
        }
        if (intval($this->_port) > 0) {

Expected 1 lines after "if", found 0.

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

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

Expected 1 lines before "return", found 0.

    }

    /**
     * @return Settings

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

     */
    public function settings(): Settings

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

    {
        return $this->_settings;
    }

    /**
     * @param bool $flag

Incorrect annotations group.

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

     * @return bool

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

     */
    public function verbose(bool $flag): bool

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

    {
        $this->_verbose = $flag;
        return $flag;

Expected 1 lines before "return", found 0.

    }

    /**
     * @param array $params

Incorrect annotations group.

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

     * @return string

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

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

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

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

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

Expected 1 lines after "if", found 2.

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

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

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

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

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

        }

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

        if ($this->settings()->isReadOnlyUser()) {
            unset($settings['extremes']);
            unset($settings['readonly']);
            unset($settings['enable_http_compression']);
            unset($settings['max_execution_time']);

Blank line found at end of control structure

        }

        unset($settings['https']);

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

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

Expected 1 lines before "return", found 2.

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

    }

    /**
     * @param array $extendinfo

Incorrect annotations group.

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

     * @return CurlerRequest

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

     */
    private function newRequest($extendinfo): CurlerRequest

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

    {
        $new = new CurlerRequest();

        switch ($this->_authMethod) {
            case self::AUTH_METHOD_QUERY_STRING:
                /* @todo: Move this implementation to CurlerRequest class. Possible options: the authentication method
                 *        should be applied in method `CurlerRequest:prepareRequest()`.
                 */
                $this->settings()->set('user', $this->_username);
                $this->settings()->set('password', $this->_password);
                break;
            case self::AUTH_METHOD_BASIC_AUTH:
                $new->authByBasicAuth($this->_username, $this->_password);
                break;
            default:
                // Auth with headers by default
                $new->authByHeaders($this->_username, $this->_password);
                break;
        }

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

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

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

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

Expected 1 lines after "if", found 0.

            $new->persistent();
        }
        if ($this->sslCA) {
            $new->setSslCa($this->sslCA);
        }

        $new->timeOut($this->settings()->getTimeOut());
        $new->connectTimeOut($this->_connectTimeOut);//->keepAlive(); // one sec
        $new->verbose(boolval($this->_verbose));

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

        return $new;
    }

    /**
     * @param Query $query

Incorrect annotations group.

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

     * @param array $urlParams

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

     * @param bool $query_as_string

Expected 2 spaces after parameter type; 1 found

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

     * @return CurlerRequest

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

     * @throws \ClickHouseDB\Exception\TransportException

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

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

The variable $query_as_string should be in camel caps format.

    {
        $sql = $query->toSql();

        if ($query_as_string) {

The variable $query_as_string should be in camel caps format.

            $urlParams['query'] = $sql;
        }

        $extendInfo = [
            'sql' => $sql,
            'query' => $query,
            'format' => $query->getFormat()

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

        ];

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

        /*
         * Build URL after request making, since URL may contain auth data. This will not matter after the
         * implantation of the todo in the `HTTP:newRequest()` method.
         */

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

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

        }

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

        if (!$query_as_string) {

Expected 1 lines after "if", found 0.

The variable $query_as_string should be in camel caps format.

Expected 1 space after NOT operator; 0 found

            $new->parameters_json($sql);
        }
        $new->httpCompression($this->settings()->isEnableHttpCompression());

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

        return $new;
    }

    /**
     * @param resource $stream

Incorrect annotations group.

     * @return void
     */
    public function setStdErrOut($stream)

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

    {
        if (is_resource($stream)) {

Expected 0 lines after "if", found 1.

Use early exit to reduce code nesting.

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

            $this->stdErrOut=$stream;

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

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

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

        }

    }

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

    /**
     * @param string|Query $sql

Incorrect annotations group.

     * @return CurlerRequest

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

     */
    public function writeStreamData($sql): CurlerRequest
    {

Expected 0 blank lines after opening function brace; 1 found

        if ($sql instanceof Query) {
            $query = $sql;
        } else {
            $query = new Query($sql);
        }

        $extendInfo = [
            'sql' => $sql,
            'query' => $query,
            'format' => $query->getFormat()

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

        ];

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

        /*
         * Build URL after request making, since URL may contain auth data. This will not matter after the
         * implantation of the todo in the `HTTP:newRequest()` method.
         */
        $url = $this->getUrl([
            'readonly' => 0,
            'query' => $query->toSql()

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

        ]);

        $request->url($url);
        return $request;

Expected 1 lines before "return", found 0.

    }

Expected 1 blank line after function; 2 found

    /**
     * @param string $sql

Incorrect annotations group.

     * @param string $file_name
     * @return Statement

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

     * @throws \ClickHouseDB\Exception\TransportException

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

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

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

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

The variable $file_name should be in camel caps format.

    {
        $query = new Query($sql);

        $extendinfo = [
            'sql' => $sql,
            'query' => $query,
            'format' => $query->getFormat()

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

        ];

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

        /*
         * Build URL after request making, since URL may contain auth data. This will not matter after the
         * implantation of the todo in the `HTTP:newRequest()` method.
         */
        $url = $this->getUrl([
            'readonly' => 0,
            'query' => $query->toSql()

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

        ]);

        $request->url($url);

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

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

Closure does not have void return type hint.

            $handle = $request->getInfileHandle();
            if (is_resource($handle)) {

Use early exit to reduce code nesting.

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

                fclose($handle);

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

            }
        });

        $request->setInfile($file_name);

The variable $file_name should be in camel caps format.

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

        return new Statement($request);
    }

    /**
     * get Count Pending Query in Queue
     *
     * @return int

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

     */
    public function getCountPendingQueue(): int
    {
        return $this->_curler->countPending();
    }

    /**
     * set Connect TimeOut in seconds [CURLOPT_CONNECTTIMEOUT] ( int )
     *
     * @param float $connectTimeOut

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

     */
    public function setConnectTimeOut(float $connectTimeOut)

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

    {
        $this->_connectTimeOut = $connectTimeOut;
    }

    /**
     * get ConnectTimeOut in seconds
     *
     * @return float

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

     */
    public function getConnectTimeOut(): float
    {
        return $this->_connectTimeOut;
    }

Expected 1 blank line after function; 2 found

    public function __findXClickHouseProgress($handle): bool

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

    {
        $code = curl_getinfo($handle, CURLINFO_HTTP_CODE);

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

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

        // Search X-ClickHouse-Progress
        if ($code == 200) {

Expected 1 lines after "if", found 0.

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

            $response = curl_multi_getcontent($handle);

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

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

            $header_size = curl_getinfo($handle, CURLINFO_HEADER_SIZE);

The variable $header_size should be in camel caps format.

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

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

            if (!$header_size) {

The variable $header_size should be in camel caps format.

Expected 1 space after NOT operator; 0 found

                return false;
            }

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

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

The variable $header_size should be in camel caps format.

            if (!$header) {

Expected 1 space after NOT operator; 0 found

                return false;
            }

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

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

                $data = @json_decode(end($match[1]), true);

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

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

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

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

Blank line found at start of control structure

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

Expected 0 lines after "if", found 1.

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

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

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

                    } else {
                        call_user_func($this->xClickHouseProgress, $data);

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

                    }

Blank line found at end of control structure

                }
            }
        }
        return false;

Expected 1 lines before "return", found 0.

    }

    /**
     * @param Query $query

Incorrect annotations group.

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

Expected 12 spaces after parameter type; 1 found

     * @param null|WhereInFile $whereInFile

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

     * @param null|WriteToFile $writeToFile

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

     * @return CurlerRequest

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

     * @throws \Exception

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

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

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

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

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

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

        $query_as_string = false;

The variable $query_as_string should be in camel caps format.

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

Expected 1 lines after "if", found 0.

            // $request = $this->prepareSelectWhereIn($request, $whereInFile);
            $structure = $whereInFile->fetchUrlParams();
            // $structure = [];
            $urlParams = array_merge($urlParams, $structure);

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

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

            $query_as_string = true;

The variable $query_as_string should be in camel caps format.

        }
        // ---------------------------------------------------------------------------------
        // if result to file
        if ($writeToFile instanceof WriteToFile && $writeToFile->fetchFormat()) {

Expected 1 lines after "if", found 0.

            $query->setFormat($writeToFile->fetchFormat());
            unset($urlParams['extremes']);
        }
        // ---------------------------------------------------------------------------------
        // makeRequest read
        $request = $this->makeRequest($query, $urlParams, $query_as_string);

The variable $query_as_string should be in camel caps format.

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

Expected 1 lines after "if", found 0.

            $request->attachFiles($whereInFile->fetchFiles());
        }
        // ---------------------------------------------------------------------------------
        // result to file
        if ($writeToFile instanceof WriteToFile && $writeToFile->fetchFormat()) {

Blank line found at start of control structure

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

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

            if (is_resource($fout)) {

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

Blank line found at start of control structure

                $isGz = $writeToFile->getGzip();

                if ($isGz) {

Expected 1 lines after "if", found 2.

                    // write gzip header
                    // "\x1f\x8b\x08\x00\x00\x00\x00\x00"
                    // fwrite($fout, "\x1F\x8B\x08\x08".pack("V", time())."\0\xFF", 10);
                    // write the original file name
                    // $oname = str_replace("\0", "", basename($writeToFile->fetchFile()));
                    // fwrite($fout, $oname."\0", 1+strlen($oname));

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

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

Blank line found at end of control structure

                }

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

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

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

Closure does not have void return type hint.

                    fclose($request->getResultFileHandle());

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

                });
            }
        }

        if ($this->stdErrOut) {

Expected 1 lines after "if", found 0.

            $request->setStdErrOut($this->stdErrOut);
        }
        if ($this->xClickHouseProgress) {

Expected 1 lines after "if", found 0.

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

Expected 1 lines before "return", found 0.

Expected 0 lines after "return", found 1.

    }

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

    public function cleanQueryDegeneration(): bool
    {
        $this->_query_degenerations = [];

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

        return true;

Expected 1 lines before "return", found 0.

    }

    public function addQueryDegeneration(Degeneration $degeneration): bool
    {
        $this->_query_degenerations[] = $degeneration;

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

        return true;

Expected 1 lines before "return", found 0.

    }

    /**
     * @param Query $query

Incorrect annotations group.

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

     * @return CurlerRequest

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

     * @throws \ClickHouseDB\Exception\TransportException

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

     */
    public function getRequestWrite(Query $query): CurlerRequest
    {
        $urlParams = ['readonly' => 0];
        return $this->makeRequest($query, $urlParams);

Expected 1 lines before "return", found 0.

    }

    /**
     * @throws TransportException
     */
    public function ping(): bool
    {
        $request = new CurlerRequest();
        $request->url($this->getUri())->verbose(false)->GET()->connectTimeOut($this->getConnectTimeOut());
        $this->_curler->execOne($request);

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

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

    }

    /**
     * @param string $sql

Incorrect annotations group.

Expected 2 spaces after parameter type; 1 found

     * @param mixed[] $bindings
     * @return Query

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

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

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

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

    {

Expected 0 blank lines after opening function brace; 1 found

        // add Degeneration query
        foreach ($this->_query_degenerations as $degeneration) {

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

            $degeneration->bindParams($bindings);
        }

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

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

    }

Expected 1 blank line after function; 2 found

    /**
     * @param Query|string $sql

Incorrect annotations group.

Expected 5 spaces after parameter type; 1 found

     * @param mixed[] $bindings

Expected 10 spaces after parameter type; 1 found

     * @param null|WhereInFile $whereInFile

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

     * @param null|WriteToFile $writeToFile

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

     * @return CurlerRequest

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

     * @throws \Exception

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

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

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

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

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

    {
        if ($sql instanceof Query) {

Expected 1 lines after "if", found 0.

            return $this->getRequestWrite($sql);
        }
        $query = $this->prepareQuery($sql, $bindings);
        $query->setFormat('JSON');
        return $this->getRequestRead($query, $whereInFile, $writeToFile);

Expected 1 lines before "return", found 0.

    }

Expected 1 blank line after function; 2 found

    /**
     * @param Query|string $sql

Incorrect annotations group.

     * @param mixed[] $bindings

Expected 6 spaces after parameter type; 1 found

     * @return CurlerRequest

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

     * @throws \ClickHouseDB\Exception\TransportException

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

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

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

    {
        if ($sql instanceof Query) {
            return $this->getRequestWrite($sql);
        }

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

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

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

            return $this->getRequestWrite($query);
        }

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

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

            $query->setFormat('JSON');
        }

        return $this->getRequestWrite($query);
    }

    /**
     * @return bool

Incorrect annotations group.

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

     * @throws \ClickHouseDB\Exception\TransportException

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

     */
    public function executeAsync(): bool
    {
        return $this->_curler->execLoopWait();
    }

    /**
     * @param Query|string $sql

Incorrect annotations group.

Expected 5 spaces after parameter type; 1 found

     * @param mixed[] $bindings

Expected 10 spaces after parameter type; 1 found

     * @param null|WhereInFile $whereInFile

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

     * @param null|WriteToFile $writeToFile

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

     * @return Statement

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

     * @throws \ClickHouseDB\Exception\TransportException

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

     * @throws \Exception

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

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

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

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

    {
        $request = $this->prepareSelect($sql, $bindings, $whereInFile, $writeToFile);
        $this->_curler->execOne($request);
        return new Statement($request);

Expected 1 lines before "return", found 0.

    }

    /**
     * @param Query|string $sql

Incorrect annotations group.

Expected 5 spaces after parameter type; 1 found

     * @param mixed[] $bindings

Expected 10 spaces after parameter type; 1 found

     * @param null|WhereInFile $whereInFile

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

     * @param null|WriteToFile $writeToFile

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

     * @return Statement

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

     * @throws \ClickHouseDB\Exception\TransportException

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

     * @throws \Exception

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

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

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

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

    {
        $request = $this->prepareSelect($sql, $bindings, $whereInFile, $writeToFile);
        $this->_curler->addQueLoop($request);
        return new Statement($request);

Expected 1 lines before "return", found 0.

    }

    /**
     * @param callable $callback

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

     */
    public function setProgressFunction(callable $callback) : void

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

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

    {
        $this->xClickHouseProgress = $callback;
    }

    /**
     * @param string $sql

Incorrect annotations group.

Expected 2 spaces after parameter type; 1 found

     * @param mixed[] $bindings
     * @param bool $exception

Expected 4 spaces after parameter type; 1 found

     * @return Statement

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

     * @throws \ClickHouseDB\Exception\TransportException

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

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

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

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

    {
        $request = $this->prepareWrite($sql, $bindings);
        $this->_curler->execOne($request);
        $response = new Statement($request);
        if ($exception) {

Expected 1 lines after "if", found 0.

            if ($response->isError()) {
                $response->error();
            }
        }
        return $response;

Expected 1 lines before "return", found 0.

    }

    /**
     * @param Stream $streamRW

Incorrect annotations group.

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

Expected 8 spaces after parameter type; 1 found

     * @param CurlerRequest $request

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

     * @return Statement

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

     * @throws \ClickHouseDB\Exception\TransportException

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

     */
    private function streaming(Stream $streamRW, CurlerRequest $request): Statement
    {
        $callable = $streamRW->getClosure();
        $stream = $streamRW->getStream();

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

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

        try {

Blank line found at start of control structure

Expected 0 lines after "try", found 2.

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

            if (!is_callable($callable)) {

Expected 1 space after NOT operator; 0 found

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

                if ($streamRW->isWrite()) {

Blank line found at start of control structure

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

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

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

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

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

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

                        return fwrite($stream, $fd);

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

                    };
                }
            }

            if ($streamRW->isGzipHeader()) {

Expected 1 lines after "if", found 2.

Blank line found at start of control structure

                if ($streamRW->isWrite()) {

Expected 0 lines after "if", found 1.

                    $request->header('Content-Encoding', 'gzip');
                    $request->header('Content-Type', 'application/x-www-form-urlencoded');
                } else {
                    $request->header('Accept-Encoding', 'gzip');
                }

Blank line found at end of control structure

            }

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

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

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

            if ($streamRW->isWrite()) {

Expected 1 lines after "if", found 2.

                $request->setReadFunction($callable);
            } else {
                $request->setWriteFunction($callable);

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

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

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

            $this->_curler->execOne($request, true);
            $response = new Statement($request);
            if ($response->isError()) {

Expected 1 lines after "if", found 0.

                $response->error();
            }
            return $response;

Expected 1 lines before "return", found 0.

        } finally {
            if ($streamRW->isWrite())

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

                fclose($stream);

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

        }

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

    }

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

Expected 1 blank line after function; 2 found

    /**
     * @param Stream $streamRead

Incorrect annotations group.

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

Expected 2 spaces after parameter type; 1 found

     * @param string $sql

Expected 2 spaces after parameter type; 1 found

     * @param mixed[] $bindings
     * @return Statement

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

     * @throws \ClickHouseDB\Exception\TransportException

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

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

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

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

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

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

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

Expected 1 lines before "return", found 0.

Expected 0 lines after "return", found 1.

    }

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

    /**
     * @param Stream $streamWrite

Incorrect annotations group.

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

Expected 2 spaces after parameter type; 1 found

     * @param string $sql

Expected 2 spaces after parameter type; 1 found

     * @param mixed[] $bindings
     * @return Statement

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

     * @throws \ClickHouseDB\Exception\TransportException

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

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

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

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

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

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

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

Expected 1 lines before "return", found 0.

    }
}