smi2 / phpClickHouse

src/Transport/CurlerResponse.php

<?php

Missing declare(strict_types=1).

namespace ClickHouseDB\Transport;

class CurlerResponse
{
    /**

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

     * @var mixed
     */
    public $_headers;

Public member variable "_headers" must not contain a leading underscore

    /**

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

     * @var mixed
     */
    public $_info;

Public member variable "_info" must not contain a leading underscore

    /**

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

     * @var mixed
     */
    public $_error;

Public member variable "_error" must not contain a leading underscore

    /**

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

     * @var int
     */
    public $_errorNo = 0;

Public member variable "_errorNo" must not contain a leading underscore

    /**

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

     * @var float
     */
    public $_useTime;

Public member variable "_useTime" must not contain a leading underscore

    /**

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

     * @var string
     */
    public $_body;

Public member variable "_body" must not contain a leading underscore

    /**
     * Response constructor.

Documentation comment contains forbidden comment "Response constructor.".

     */
    public function __construct() {}

Expected 1 blank line before function; 2 found

Expected 1 blank line after function; 2 found

    /**
     * @return int
     */
    public function error_no()

Method name "CurlerResponse::error_no" is not in camel caps format

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

    {
        return $this->_errorNo;
    }

    /**
     * @return mixed
     */
    public function error()
    {
        return $this->_error;
    }

    /**
     * @return mixed
     */
    public function url()
    {
        return $this->_info['url'];
    }

    /**
     * @return mixed
     */
    public function total_time()

Method name "CurlerResponse::total_time" is not in camel caps format

    {
        return round($this->_info['total_time'], 3);

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

    }

    /**
     * @return string
     */
    public function starttransfer_time()

Method name "CurlerResponse::starttransfer_time" is not in camel caps format

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

    {
        return round($this->_info['starttransfer_time'], 3);

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

    }

    /**
     * @return string
     */
    public function connect_time()

Method name "CurlerResponse::connect_time" is not in camel caps format

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

    {
        return round($this->_info['connect_time'], 3);

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

    }

    /**
     * @return string
     */
    public function pretransfer_time()

Method name "CurlerResponse::pretransfer_time" is not in camel caps format

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

    {
        return round($this->_info['pretransfer_time'], 3);

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

    }

    /**
     * @return mixed
     */
    public function content_type()

Method name "CurlerResponse::content_type" is not in camel caps format

    {
        return $this->_info['content_type'];
    }

    /**
     * @return mixed
     */
    public function http_code()

Method name "CurlerResponse::http_code" is not in camel caps format

    {
        return $this->_info['http_code'];
    }

    /**
     * @param string $name

Incorrect annotations group.

     * @return null|string

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

     */
    public function headers($name)

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

Method \ClickHouseDB\Transport\CurlerResponse::headers() does not have native return type hint for its return value but it should be possible to add it based on @return annotation "null|string".

    {
        if (isset($this->_headers[$name])) {
            return $this->_headers[$name];
        }

        return null;
    }

    /**
     * @return null|string

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

     */
    public function connection()

Method \ClickHouseDB\Transport\CurlerResponse::connection() does not have native return type hint for its return value but it should be possible to add it based on @return annotation "null|string".

    {
        return $this->headers('Connection');
    }

    /**
     * @return mixed
     */
    public function body()
    {
        return $this->_body;
    }

    /**
     * @return mixed
     */
    public function as_string()

Method name "CurlerResponse::as_string" is not in camel caps format

    {
        return $this->body();
    }

    /**

Empty comment

     *
     */
    public function dump_json()

Method name "CurlerResponse::dump_json" is not in camel caps format

Method \ClickHouseDB\Transport\CurlerResponse::dump_json() does not have void return type hint.

Method \ClickHouseDB\Transport\CurlerResponse::dump_json() does not need documentation comment.

    {
        print_r($this->json());

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

    }

    public function getDetails(): array

Method \ClickHouseDB\Transport\CurlerResponse::getDetails() does not have @return annotation for its traversable return value.

    {
        return [
            'body'    => $this->_body,
            'headers' => $this->_headers,
            'error'   => $this->error(),
            'info'    => $this->_info,
        ];
    }

    /**
     * @param bool $result

Incorrect annotations group.

     * @return string
     */
    public function dump($result = false)

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

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

    {
        $msg = "\n--------------------------- Response -------------------------------------\nBODY:\n";

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

        $msg .= print_r($this->_body, true);

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

        $msg .= "\nHEAD:\n";
        $msg .= print_r($this->_headers, true);

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

        $msg .= "\nERROR:\n" . $this->error();
        $msg .= "\nINFO:\n";
        $msg .= json_encode($this->_info);

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

        $msg .= "\n----------------------------------------------------------------------\n";

        if ($result) {
            return $msg;
        }

        echo $msg;
    }

    /**
     * @param int $size

Incorrect annotations group.

Expected 4 spaces after parameter type; 1 found

     * @param string $unit
     * @return string
     */
    private function humanFileSize($size, $unit = '')

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

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

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

    {
        if ((!$unit && $size >= 1 << 30) || $unit == 'GB') {

Expected 1 lines after "if", found 0.

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

Expected 1 space after NOT operator; 0 found

            return number_format($size / (1 << 30), 2) . ' GB';

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

        }
        if ((!$unit && $size >= 1 << 20) || $unit == 'MB') {

Expected 1 lines after "if", found 0.

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

Expected 1 space after NOT operator; 0 found

            return number_format($size / (1 << 20), 2) . ' MB';

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

        }
        if ((!$unit && $size >= 1 << 10) || $unit == 'KB') {

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

Expected 1 space after NOT operator; 0 found

            return number_format($size / (1 << 10), 2) . ' KB';

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

        }

        return number_format($size) . ' bytes';

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

    }

    /**
     * @return string
     */
    public function upload_content_length()

Method name "CurlerResponse::upload_content_length" is not in camel caps format

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

    {
        return $this->humanFileSize($this->_info['upload_content_length']);
    }

    /**
     * @return string
     */
    public function speed_upload()

Method name "CurlerResponse::speed_upload" is not in camel caps format

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

    {
        $SPEED_UPLOAD = $this->_info['speed_upload'];

The variable $SPEED_UPLOAD should be in camel caps format.

        return round(($SPEED_UPLOAD * 8) / (1000 * 1000), 2) . ' Mbps';

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

Expected 1 lines before "return", found 0.

Useless parentheses.

The variable $SPEED_UPLOAD should be in camel caps format.

    }

    /**
     * @return string
     */
    public function speed_download()

Method name "CurlerResponse::speed_download" is not in camel caps format

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

    {
        $SPEED_UPLOAD = $this->_info['speed_download'];

The variable $SPEED_UPLOAD should be in camel caps format.

        return round(($SPEED_UPLOAD * 8) / (1000 * 1000), 2) . ' Mbps';

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

Expected 1 lines before "return", found 0.

Useless parentheses.

The variable $SPEED_UPLOAD should be in camel caps format.

    }

    /**
     * @return string
     */
    public function size_upload()

Method name "CurlerResponse::size_upload" is not in camel caps format

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

    {
        return $this->humanFileSize($this->_info['size_upload']);
    }

    /**
     * @return string
     */
    public function request_size()

Method name "CurlerResponse::request_size" is not in camel caps format

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

    {
        return $this->humanFileSize($this->_info['request_size']);
    }

    /**
     * @return string
     */
    public function header_size()

Method name "CurlerResponse::header_size" is not in camel caps format

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

    {
        return $this->humanFileSize($this->_info['header_size']);
    }

    /**
     * @return string
     */
    public function size_download()

Method name "CurlerResponse::size_download" is not in camel caps format

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

    {
        return $this->humanFileSize($this->_info['size_download']);
    }

    /**
     * @return mixed
     */
    public function info()
    {
        return $this->_info;
    }

Expected 1 blank line after function; 0 found

    /**
     * @param string|null $key

Incorrect annotations group.

     * @return bool|mixed
     */
    public function json($key = null)

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

    {
        $d = json_decode($this->body(), true);

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

        if (!$key) {

Expected 1 space after NOT operator; 0 found

            return $d;
        }

        if (!isset($d[$key])) {

Expected 1 space after NOT operator; 0 found

            return false;
        }

        return $d[$key];
    }

    /**
     * @return mixed
     */
    public function rawDataOrJson($format)

Method \ClickHouseDB\Transport\CurlerResponse::rawDataOrJson() does not have parameter type hint nor @param annotation for its parameter $format.

    {
        // JSONCompact // JSONEachRow

        if (stripos($format, 'json') !== false)

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

Expected 1 lines after "if", found 0.

        {
            if (stripos($format,'JSONEachRow')===false)

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

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

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

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

            return $this->json();

Expected 1 lines before "return", found 0.

        }
        return $this->body();

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

}