ClickHouseDB\Query\Query

Complexity

Total Complexity

15

Size/Duplication

Total Lines	128
Duplicated Lines	0 %

Test Coverage

Coverage

88.24%

Importance

Changes	5
Bugs	1	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setFormat()	0	3	1
A	__construct()	0	8	2
A	__toString()	0	3	1
A	applyFormatQuery()	0	25	5
A	getFormat()	0	4	1
A	toSql()	0	17	5

<?php

Missing declare(strict_types=1).

namespace ClickHouseDB\Query;

use ClickHouseDB\Exception\QueryException;
use function sizeof;

class Query
{
    /**

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

     * @var string
     */
    protected $sql;

    /**

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

     * @var string|null
     */
    protected $format = null;

    /**

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

     * @var array

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

     */
    private $degenerations = [];

    private $supportFormats=[

Property \ClickHouseDB\Query\Query::$supportFormats does not have @var annotation.

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

        "FORMAT\\s+TSVRaw",

The string literal FORMAT\\s+TSVRaw does not require double quotes, as per coding-style, please use single quotes.

        "FORMAT\\s+TSVWithNamesAndTypes",

The string literal FORMAT\\s+TSVWithNamesAndTypes does not require double quotes, as per coding-style, please use single quotes.

        "FORMAT\\s+TSVWithNames",

The string literal FORMAT\\s+TSVWithNames does not require double quotes, as per coding-style, please use single quotes.

        "FORMAT\\s+TSV",

The string literal FORMAT\\s+TSV does not require double quotes, as per coding-style, please use single quotes.

        "FORMAT\\s+Vertical",

The string literal FORMAT\\s+Vertical does not require double quotes, as per coding-style, please use single quotes.

        "FORMAT\\s+JSONCompact",

The string literal FORMAT\\s+JSONCompact does not require double quotes, as per coding-style, please use single quotes.

        "FORMAT\\s+JSONEachRow",

The string literal FORMAT\\s+JSONEachRow does not require double quotes, as per coding-style, please use single quotes.

        "FORMAT\\s+TSKV",

The string literal FORMAT\\s+TSKV does not require double quotes, as per coding-style, please use single quotes.

        "FORMAT\\s+TabSeparatedWithNames",

The string literal FORMAT\\s+TabSeparatedWithNames does not require double quotes, as per coding-style, please use single quotes.

        "FORMAT\\s+TabSeparatedWithNamesAndTypes",

The string literal FORMAT\\s+TabSeparatedWithNamesAndTypes does not require double quotes, as per coding-style, please use single quotes.

        "FORMAT\\s+TabSeparatedRaw",

The string literal FORMAT\\s+TabSeparatedRaw does not require double quotes, as per coding-style, please use single quotes.

        "FORMAT\\s+BlockTabSeparated",

The string literal FORMAT\\s+BlockTabSeparated does not require double quotes, as per coding-style, please use single quotes.

        "FORMAT\\s+CSVWithNames",

The string literal FORMAT\\s+CSVWithNames does not require double quotes, as per coding-style, please use single quotes.

        "FORMAT\\s+CSV",

The string literal FORMAT\\s+CSV does not require double quotes, as per coding-style, please use single quotes.

        "FORMAT\\s+JSON",

The string literal FORMAT\\s+JSON does not require double quotes, as per coding-style, please use single quotes.

        "FORMAT\\s+TabSeparated"

MultiLine arrays must have a trailing comma after the last element.

The string literal FORMAT\\s+TabSeparated does not require double quotes, as per coding-style, please use single quotes.

    ];

    /**
     * Query constructor.

Documentation comment contains forbidden comment "Query constructor.".

     * @param string $sql

Expected 1 lines between description and annotations, found 0.

     * @param array $degenerations

@param annotation of method \ClickHouseDB\Query\Query::__construct() does not specify type hint for items of its traversable parameter $degenerations.

Expected 2 spaces after parameter type; 1 found

     */
    public function __construct($sql, $degenerations = [])

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

Method \ClickHouseDB\Query\Query::__construct() does not have parameter type hint for its parameter $degenerations but it should be possible to add it based on @param annotation "array".

    {
        if (!trim($sql))

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

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

        {
            throw new QueryException('Empty Query');
        }
        $this->sql = $sql;

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

        $this->degenerations = $degenerations;
    }

    /**
     * @param string|null $format
     */
    public function setFormat($format)

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

Method \ClickHouseDB\Query\Query::setFormat() does not have void return type hint.

    {
        $this->format = $format;
    }


    private function applyFormatQuery()

Method \ClickHouseDB\Query\Query::applyFormatQuery() does not have return type hint nor @return annotation for its return value.

    {
        // FORMAT\s(\w)*$
        if (null === $this->format) {

Yoda comparisons are disallowed.

            return false;
        }
        $supportFormats = implode("|",$this->supportFormats);

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

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

        $this->sql = trim($this->sql);

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

        if (substr($this->sql, -1) == ';') {

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

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

            $this->sql = substr($this->sql, 0, -1);

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

        }

        $matches = [];
        if (preg_match_all('%(' . $supportFormats . ')%ius', $this->sql, $matches)) {

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

Blank line found at start of control structure

            // skip add "format json"
            if (isset($matches[0]))
            {

Blank line found at start of control structure

                $this->format = trim(str_ireplace('format', '', $matches[0][0]));

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

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

Blank line found at end of control structure

            }
        } else {
            $this->sql = $this->sql . ' FORMAT ' . $this->format;

Use ".=" operator instead of "=" and ".".

        }

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

    }

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

    /**
     * @return null|string

Null type hint should be on last position.

     */
    public function getFormat()

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

    {

Expected 0 blank lines after opening function brace; 1 found

        return $this->format;
    }

    public function toSql()

Method \ClickHouseDB\Query\Query::toSql() does not have return type hint nor @return annotation for its return value.

    {
        if ($this->format !== null) {
            $this->applyFormatQuery();
        }

        if (sizeof($this->degenerations))

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

        {
            foreach ($this->degenerations as $degeneration)
            {
                if ($degeneration instanceof Degeneration) {

Use early exit to reduce code nesting.

                    $this->sql = $degeneration->process($this->sql);
                }
            }
        }

        return $this->sql;
    }

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

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

    {
        return $this->toSql();
    }
}