ClickHouseDB\Statement

Complexity

Total Complexity

66

Size/Duplication

Total Lines	556
Duplicated Lines	0 %

Test Coverage

Coverage

73.77%

Importance

Changes	9
Bugs	0	Features	2

30 Methods

Rating	Name	Duplication	Size	Complexity
A	response()	0	3	1
A	getRequest()	0	3	1
A	responseInfo()	0	3	1
A	extremes()	0	4	1
A	dump()	0	4	1
A	extremesMax()	0	9	2
A	extremesMin()	0	9	2
A	parseErrorClickHouse()	0	14	2
A	isError()	0	3	2
A	totals()	0	4	1
B	init()	0	56	11
A	countAll()	0	4	1
A	totalTimeRequest()	0	4	1
A	check()	0	11	3
A	sql()	0	3	1
A	dumpRaw()	0	3	1
A	__construct()	0	6	1
A	error()	0	25	5
B	array_to_tree()	0	33	6
A	info()	0	11	1
A	rowsAsTree()	0	11	2
A	statistics()	0	15	4
A	fetchRow()	0	20	4
A	info_upload()	0	8	1
A	rawData()	0	9	2
A	resetIterator()	0	3	1
A	count()	0	4	1
A	fetchOne()	0	16	4
A	getFormat()	0	3	1
A	rows()	0	4	1

<?php

Missing declare(strict_types=1).

An error occurred during processing; checking has been aborted. The error message was: "if" without curly braces is not supported.

namespace ClickHouseDB;

use ClickHouseDB\Exception\DatabaseException;
use ClickHouseDB\Exception\QueryException;
use ClickHouseDB\Query\Query;
use ClickHouseDB\Transport\CurlerRequest;
use ClickHouseDB\Transport\CurlerResponse;

class Statement
{
    /**

Found multi-line comment for property \ClickHouseDB\Statement::$_rawData with single line content, use one-line comment instead.

     * @var string|mixed
     */
    private $_rawData;

    /**

Found multi-line comment for property \ClickHouseDB\Statement::$_http_code with single line content, use one-line comment instead.

     * @var int
     */
    private $_http_code = -1;

Class Statement contains unused property $_http_code.

    /**

Found multi-line comment for property \ClickHouseDB\Statement::$_request with single line content, use one-line comment instead.

     * @var CurlerRequest
     */
    private $_request = null;

    /**

Found multi-line comment for property \ClickHouseDB\Statement::$_init with single line content, use one-line comment instead.

     * @var bool
     */
    private $_init = false;

    /**

Found multi-line comment for property \ClickHouseDB\Statement::$query with single line content, use one-line comment instead.

     * @var Query
     */
    private $query;

Class Statement contains write-only property $query.

    /**

Found multi-line comment for property \ClickHouseDB\Statement::$format with single line content, use one-line comment instead.

     * @var mixed
     */
    private $format;

    /**

Found multi-line comment for property \ClickHouseDB\Statement::$sql with single line content, use one-line comment instead.

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

    /**

Found multi-line comment for property \ClickHouseDB\Statement::$meta with single line content, use one-line comment instead.

     * @var array

@var annotation of property \ClickHouseDB\Statement::$meta does not specify type hint for its items.

     */
    private $meta;

    /**

Found multi-line comment for property \ClickHouseDB\Statement::$totals with single line content, use one-line comment instead.

     * @var array

@var annotation of property \ClickHouseDB\Statement::$totals does not specify type hint for its items.

     */
    private $totals;

    /**

Found multi-line comment for property \ClickHouseDB\Statement::$extremes with single line content, use one-line comment instead.

     * @var array

@var annotation of property \ClickHouseDB\Statement::$extremes does not specify type hint for its items.

     */
    private $extremes;

    /**

Found multi-line comment for property \ClickHouseDB\Statement::$rows with single line content, use one-line comment instead.

     * @var int
     */
    private $rows;

    /**

Found multi-line comment for property \ClickHouseDB\Statement::$rows_before_limit_at_least with single line content, use one-line comment instead.

     * @var bool|integer

Expected "int" but found "integer" in @var annotation.

     */
    private $rows_before_limit_at_least = false;

    /**

Found multi-line comment for property \ClickHouseDB\Statement::$array_data with single line content, use one-line comment instead.

     * @var array

@var annotation of property \ClickHouseDB\Statement::$array_data does not specify type hint for its items.

     */
    private $array_data = [];

    /**

Found multi-line comment for property \ClickHouseDB\Statement::$statistics with single line content, use one-line comment instead.

     * @var array|null

@var annotation of property \ClickHouseDB\Statement::$statistics does not specify type hint for its items.

     */
    private $statistics = null;

    /**

Found multi-line comment for property \ClickHouseDB\Statement::$iterator with single line content, use one-line comment instead.

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

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

    public function __construct(CurlerRequest $request)

Missing doc comment for function __construct()

    {
        $this->_request = $request;
        $this->format = $this->_request->getRequestExtendedInfo('format');

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

        $this->query = $this->_request->getRequestExtendedInfo('query');

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

        $this->sql = $this->_request->getRequestExtendedInfo('sql');

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

    }

    /**
     * @return CurlerRequest
     */
    public function getRequest()

Method \ClickHouseDB\Statement::getRequest() does not have return type hint for its return value but it should be possible to add it based on @return annotation "CurlerRequest".

    {
        return $this->_request;
    }

    /**
     * @return CurlerResponse

Incorrect annotations group.

     * @throws Exception\TransportException

Comment missing for @throws tag in function comment

     */
    private function response()

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

    {
        return $this->_request->response();
    }

    /**
     * @return mixed

Incorrect annotations group.

     * @throws Exception\TransportException

Comment missing for @throws tag in function comment

     */
    public function responseInfo()
    {
        return $this->response()->info();
    }

    /**
     * @return mixed|string
     */
    public function sql()
    {
        return $this->sql;
    }

    /**
     * @param string $body

Incorrect annotations group.

Missing parameter comment

     * @return array|bool

@return annotation of method \ClickHouseDB\Statement::parseErrorClickHouse() does not specify type hint for items of its traversable return value.

Expected "array|boolean" but found "array|bool" for function return type

     */
    private function parseErrorClickHouse($body)

Method \ClickHouseDB\Statement::parseErrorClickHouse() does not have parameter type hint for its parameter $body but it should be possible to add it based on @param annotation "string".

Type hint "string" missing for $body

    {
        $body = trim($body);

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

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

        $mathes = [];

        // Code: 115, e.displayText() = DB::Exception: Unknown setting readonly[0], e.what() = DB::Exception
        // Code: 192, e.displayText() = DB::Exception: Unknown user x, e.what() = DB::Exception
        // Code: 60, e.displayText() = DB::Exception: Table default.ZZZZZ doesn't exist., e.what() = DB::Exception

        if (preg_match("%Code: (\d+),\se\.displayText\(\) \=\s*DB\:\:Exception\s*:\s*(.*)(?:\,\s*e\.what|\(version).*%ius", $body, $mathes)) {

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

The string literal %Code: (\d+),\se\.displayText\(\) \=\s*DB\:\:Exception\s*:\s*(.*)(?:\,\s*e\.what|\(version).*%ius does not require double quotes, as per coding-style, please use single quotes.

            return ['code' => $mathes[1], 'message' => $mathes[2]];

Arrays with multiple values should not be declared on a single line.

        }

        return false;
    }

    /**
     * @return bool

Incorrect annotations group.

Expected "boolean" but found "bool" for function return type

     * @throws Exception\TransportException

Comment missing for @throws tag in function comment

     */
    public function error()

Method \ClickHouseDB\Statement::error() does not have return type hint for its return value but it should be possible to add it based on @return annotation "bool".

    {
        if (!$this->isError()) {

Expected 1 space(s) after NOT operator; 0 found

            return false;
        }

        $body = $this->response()->body();

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

        $error_no = $this->response()->error_no();
        $error = $this->response()->error();

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

        if (!$error_no && !$error) {

Expected 1 space(s) after NOT operator; 0 found

            $parse = $this->parseErrorClickHouse($body);

            if ($parse) {

The expression $parse of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

$parse is a non-empty array, thus is always true.

                throw new DatabaseException($parse['message'] . "\nIN:" . $this->sql(), $parse['code']);
            } else {
                $code = $this->response()->http_code();

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

                $message = "HttpCode:" . $this->response()->http_code() . " ; " . $this->response()->error() . " ;" . $body;

The string literal HttpCode: does not require double quotes, as per coding-style, please use single quotes.

The string literal ; does not require double quotes, as per coding-style, please use single quotes.

The string literal ; does not require double quotes, as per coding-style, please use single quotes.

            }
        } else {
            $code = $error_no;

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

            $message = $this->response()->error();
        }

        throw new QueryException($message, $code);
    }

    /**
     * @return bool

Incorrect annotations group.

Expected "boolean" but found "bool" for function return type

     * @throws Exception\TransportException

Comment missing for @throws tag in function comment

     */
    public function isError()

Method \ClickHouseDB\Statement::isError() does not have return type hint for its return value but it should be possible to add it based on @return annotation "bool".

    {
        return ($this->response()->http_code() !== 200 || $this->response()->error_no());

Usage of language construct "return" with parentheses is disallowed.

    }

    private function check() : bool

Missing doc comment for function check()

    {
        if (!$this->_request->isResponseExists()) {

Expected 1 space(s) after NOT operator; 0 found

            throw QueryException::noResponse();
        }

        if ($this->isError()) {
            $this->error();
        }

        return true;
    }

    /**
     * @return bool

Incorrect annotations group.

Expected "boolean" but found "bool" for function return type

     * @throws Exception\TransportException

Comment missing for @throws tag in function comment

     */
    private function init()

Method \ClickHouseDB\Statement::init() does not have return type hint for its return value but it should be possible to add it based on @return annotation "bool".

    {
        if ($this->_init) {
            return false;
        }

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

        $this->check();

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

        $this->_rawData = $this->response()->rawDataOrJson($this->format);

        if (!$this->_rawData) {

Expected 1 space(s) after NOT operator; 0 found

            $this->_init = true;
            return false;
        }

No blank line found after control structure

        $data=[];

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

        foreach (['meta', 'data', 'totals', 'extremes', 'rows', 'rows_before_limit_at_least', 'statistics'] as $key) {

Blank line found at start of control structure

            if (isset($this->_rawData[$key])) {

Use early exit to reduce code nesting.

                if ($key=='data')

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

                {
                    $data=$this->_rawData[$key];

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

                }
                else{

Expected 1 space(s) after ELSE keyword; 0 found

                    $this->{$key} = $this->_rawData[$key];
                }

Blank line found after control structure

Blank line found at end of control structure

            }
        }

        if (empty($this->meta)) {
            throw  new QueryException('Can`t find meta');
        }

        $isJSONCompact=(stripos($this->format,'JSONCompact')!==false?true:false);

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

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

        $this->array_data = [];
        foreach ($data as $rows) {
            $r = [];

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

            if ($isJSONCompact)
            {
                $r[]=$rows;

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

            }
            else {
                foreach ($this->meta as $meta) {
                    $r[$meta['name']] = $rows[$meta['name']];
                }
            }

            $this->array_data[] = $r;
        }

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

        return true;
    }

    /**
     * @return array

Incorrect annotations group.

@return annotation of method \ClickHouseDB\Statement::extremes() does not specify type hint for items of its traversable return value.

     * @throws \Exception

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

Comment missing for @throws tag in function comment

     */
    public function extremes()

Method \ClickHouseDB\Statement::extremes() does not have return type hint for its return value but it should be possible to add it based on @return annotation "array".

    {
        $this->init();
        return $this->extremes;
    }

    /**
     * @return mixed

Incorrect annotations group.

     * @throws Exception\TransportException

Comment missing for @throws tag in function comment

     */
    public function totalTimeRequest()
    {
        $this->check();
        return $this->response()->total_time();

    }

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

    /**
     * @return array

Incorrect annotations group.

@return annotation of method \ClickHouseDB\Statement::extremesMin() does not specify type hint for items of its traversable return value.

     * @throws \Exception

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

Comment missing for @throws tag in function comment

     */
    public function extremesMin()

Method \ClickHouseDB\Statement::extremesMin() does not have return type hint for its return value but it should be possible to add it based on @return annotation "array".

    {
        $this->init();

        if (empty($this->extremes['min'])) {
            return [];
        }

        return $this->extremes['min'];
    }

    /**
     * @return array

Incorrect annotations group.

@return annotation of method \ClickHouseDB\Statement::extremesMax() does not specify type hint for items of its traversable return value.

     * @throws \Exception

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

Comment missing for @throws tag in function comment

     */
    public function extremesMax()

Method \ClickHouseDB\Statement::extremesMax() does not have return type hint for its return value but it should be possible to add it based on @return annotation "array".

    {
        $this->init();

        if (empty($this->extremes['max'])) {
            return [];
        }

        return $this->extremes['max'];
    }

    /**
     * @return array

Incorrect annotations group.

@return annotation of method \ClickHouseDB\Statement::totals() does not specify type hint for items of its traversable return value.

     * @throws Exception\TransportException

Comment missing for @throws tag in function comment

     */
    public function totals()

Method \ClickHouseDB\Statement::totals() does not have return type hint for its return value but it should be possible to add it based on @return annotation "array".

    {
        $this->init();
        return $this->totals;
    }

    /**

Empty comment

     *
     */

Missing @return tag in function comment

    public function dumpRaw()

Method \ClickHouseDB\Statement::dumpRaw() does not have void return type hint.

Method \ClickHouseDB\Statement::dumpRaw() does not need documentation comment.

    {
        print_r($this->_rawData);

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

    }

    /**

Empty comment

     *
     */

Missing @return tag in function comment

    public function dump()

Method \ClickHouseDB\Statement::dump() does not have void return type hint.

Method \ClickHouseDB\Statement::dump() does not need documentation comment.

    {
        $this->_request->dump();
        $this->response()->dump();
    }

    /**
     * @return bool|int

Incorrect annotations group.

Expected "boolean|integer" but found "bool|int" for function return type

     * @throws Exception\TransportException

Comment missing for @throws tag in function comment

     */
    public function countAll()
    {
        $this->init();
        return $this->rows_before_limit_at_least;
    }

    /**
     * @param bool $key

Incorrect annotations group.

Missing parameter comment

Expected "boolean" but found "bool" for parameter type

     * @return array|mixed|null

@return annotation of method \ClickHouseDB\Statement::statistics() does not specify type hint for items of its traversable return value.

     * @throws Exception\TransportException

Comment missing for @throws tag in function comment

     */
    public function statistics($key = false)

Method \ClickHouseDB\Statement::statistics() does not have parameter type hint for its parameter $key but it should be possible to add it based on @param annotation "bool".

Type hint "bool" missing for $key

    {
        $this->init();

        if (!is_array($this->statistics)) {

Expected 1 space(s) after NOT operator; 0 found

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

            return null;
        }

        if (!$key) return $this->statistics;

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

        if (!isset($this->statistics[$key])) {
            return null;
        }

        return $this->statistics[$key];

    }

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

    /**
     * @return int
     * @throws Exception\TransportException
     */
    public function count()
    {
        $this->init();
        return $this->rows;
    }

    /**
     * @return mixed|string
     * @throws Exception\TransportException
     */
    public function rawData()
    {
        if ($this->_init) {
            return $this->_rawData;
        }

        $this->check();

        return $this->response()->rawDataOrJson($this->format);
    }

    /**
     *
     */
    public function resetIterator()
    {
        $this->iterator=0;
    }

    public function fetchRow($key = null)
    {
        $this->init();

        $position=$this->iterator;

        if (!isset($this->array_data[$position])) {
            return null;
        }

        $this->iterator++;

        if (!$key) {
            return $this->array_data[$position];
        }
        if (!isset($this->array_data[$position][$key])) {
            return null;
        }

        return $this->array_data[$position][$key];

    }
    /**
     * @param string $key
     * @return mixed|null
     * @throws Exception\TransportException
     */
    public function fetchOne($key = null)
    {
        $this->init();
        if (!isset($this->array_data[0])) {
            return null;
        }

        if (!$key) {
            return $this->array_data[0];
        }

        if (!isset($this->array_data[0][$key])) {
            return null;
        }

        return $this->array_data[0][$key];
    }

    /**
     * @param string|null $path
     * @return array
     * @throws Exception\TransportException
     */
    public function rowsAsTree($path)
    {
        $this->init();

        $out = [];
        foreach ($this->array_data as $row) {
            $d = $this->array_to_tree($row, $path);
            $out = array_replace_recursive($d, $out);

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

        }

        return $out;
    }

    /**
     * Return size_upload,upload_content,speed_upload,time_request
     *
     * @return array
     * @throws Exception\TransportException
     */
    public function info_upload()
    {
        $this->check();
        return [
            'size_upload'    => $this->response()->size_upload(),
            'upload_content' => $this->response()->upload_content_length(),
            'speed_upload'   => $this->response()->speed_upload(),
            'time_request'   => $this->response()->total_time()
        ];
    }

    /**
     * Return size_upload,upload_content,speed_upload,time_request,starttransfer_time,size_download,speed_download
     *
     * @return array
     * @throws Exception\TransportException
     */
    public function info()
    {
        $this->check();
        return [
            'starttransfer_time'    => $this->response()->starttransfer_time(),
            'size_download'    => $this->response()->size_download(),
            'speed_download'    => $this->response()->speed_download(),
            'size_upload'    => $this->response()->size_upload(),
            'upload_content' => $this->response()->upload_content_length(),
            'speed_upload'   => $this->response()->speed_upload(),
            'time_request'   => $this->response()->total_time()
        ];
    }

    /**
     * get format in sql
     * @return mixed
     */
    public function getFormat()
    {
        return $this->format;
    }

    /**
     * @return array
     * @throws Exception\TransportException
     */
    public function rows()
    {
        $this->init();
        return $this->array_data;
    }

    /**
     * @param array|string $arr
     * @param null|string|array $path
     * @return array
     */
    private function array_to_tree($arr, $path = null)
    {
        if (is_array($path)) {

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

            $keys = $path;
        } else {
            $args = func_get_args();

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

            array_shift($args);

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

            if (sizeof($args) < 2) {

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

                $separator = '.';
                $keys = explode($separator, $path);

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

            } else {
                $keys = $args;
            }
        }

        //
        $tree = $arr;
        while (count($keys)) {

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

            $key = array_pop($keys);

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

            if (isset($arr[$key])) {
                $val = $arr[$key];
            } else {
                $val = $key;
            }

            $tree = array($val => $tree);
        }
        if (!is_array($tree)) {

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

            return [];
        }
        return $tree;
    }
}