smi2 / phpClickHouse

src/Quote/StrictQuoteLine.php

<?php

Missing declare(strict_types=1).

namespace ClickHouseDB\Quote;

Expected 1 lines before namespace statement, found 0.

use ClickHouseDB\Exception\QueryException;
use ClickHouseDB\Query\Expression\Expression;
use ClickHouseDB\Type\NumericType;
use function array_map;

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

use function is_array;
use function is_float;
use function is_int;
use function is_string;
use function preg_replace;
use function str_replace;

class StrictQuoteLine
{
    private $preset = [

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

Property \ClickHouseDB\Quote\StrictQuoteLine::$preset does not have @var annotation for its value.

        'CSV'=>[

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

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

            'EnclosureArray'=>'"',

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

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

            'EncodeEnclosure'=>'"',

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

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

            'Enclosure'=>'"',

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

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

            'Null'=>"\\N",

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

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

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

            'Delimiter'=>",",

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

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

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

            'TabEncode'=>false,

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

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

        ],
        'Insert'=>[

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

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

            'EnclosureArray'=>'',

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

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

            'EncodeEnclosure'=>'\\',

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

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

            'Enclosure'=>'\'',

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

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

            'Null'=>"NULL",

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

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

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

            'Delimiter'=>",",

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

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

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

            'TabEncode'=>false,

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

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

        ],
        'TSV'=>[

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

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

            'EnclosureArray'=>'',

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

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

            'EncodeEnclosure'=>'',

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

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

            'Enclosure'=>'\\',

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

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

            'Null'=>" ",

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

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

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

            'Delimiter'=>"\t",

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

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

            'TabEncode'=>true,

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

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

        ],
    ];
    private $settings = [];

Property \ClickHouseDB\Quote\StrictQuoteLine::$settings does not have @var annotation for its value.

    public function __construct($format)

Method \ClickHouseDB\Quote\StrictQuoteLine::__construct() does not have parameter type hint nor @param annotation for its parameter $format.

    {
        if (empty($this->preset[$format]))
        {
            throw new QueryException("Unsupport format encode line:" . $format);

The string literal Unsupport format encode line: does not require double quotes, as per coding-style, please use single quotes.

        }

        $this->settings = $this->preset[$format];
    }

    /**
     * @param $row

Incorrect annotations group.

Missing parameter name

     * @param bool $skipEncode

Method \ClickHouseDB\Quote\StrictQuoteLine::quoteRow() has useless @param annotation for parameter $skipEncode.

     * @return string
     */
    public function quoteRow($row,bool $skipEncode=false )

Expected 1 space between comma and type hint "bool"; 0 found

Incorrect spacing between argument "$skipEncode" and equals sign; expected 1 but found 0

Incorrect spacing between default value and equals sign for argument "$skipEncode"; expected 1 but found 0

Expected 0 spaces before closing parenthesis; 1 found

Method \ClickHouseDB\Quote\StrictQuoteLine::quoteRow() does not have parameter type hint nor @param annotation for its parameter $row.

Method \ClickHouseDB\Quote\StrictQuoteLine::quoteRow() 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 implode($this->settings['Delimiter'], $this->quoteValue($row,$skipEncode));

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

    }

    /**
     * @param $row

Incorrect annotations group.

Missing parameter name

     * @param bool $skipEncode

Method \ClickHouseDB\Quote\StrictQuoteLine::quoteValue() has useless @param annotation for parameter $skipEncode.

     * @return array

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

     */
    public function quoteValue($row,bool $skipEncode=false)

Expected 1 space between comma and type hint "bool"; 0 found

Incorrect spacing between argument "$skipEncode" and equals sign; expected 1 but found 0

Incorrect spacing between default value and equals sign for argument "$skipEncode"; expected 1 but found 0

Method \ClickHouseDB\Quote\StrictQuoteLine::quoteValue() does not have parameter type hint nor @param annotation for its parameter $row.

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

    {
        $enclosure = $this->settings['Enclosure'];

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

        $delimiter = $this->settings['Delimiter'];

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

        $encodeEnclosure = $this->settings['EncodeEnclosure'];
        $encodeArray = $this->settings['EnclosureArray'];

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

        $null = $this->settings['Null'];

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

        $tabEncode = $this->settings['TabEncode'];

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

        $quote = function($value) use ($enclosure, $delimiter, $encodeEnclosure, $encodeArray, $null, $tabEncode, $skipEncode) {

Expected 1 space after FUNCTION keyword; 0 found

            $delimiter_esc = preg_quote($delimiter, '/');

The assignment to $delimiter_esc is dead and can be removed.

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

The variable $delimiter_esc should be in camel caps format.

            $enclosure_esc = preg_quote($enclosure, '/');

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

The variable $enclosure_esc should be in camel caps format.

            $encode_esc = preg_quote($encodeEnclosure, '/');

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

The variable $encode_esc should be in camel caps format.

            $encode = true;
            if ($value instanceof NumericType) {

Expected 1 lines after "if", found 0.

                $encode = false;
            }
            if ($value instanceof Expression) {
                $encode = $value->needsEncoding();
            }

            if (is_array($value)) {
                // Arrays are formatted as a list of values separated by commas in square brackets.
                // Elements of the array - the numbers are formatted as usual, and the dates, dates-with-time, and lines are in
                // single quotation marks with the same screening rules as above.
                // as in the TabSeparated format, and then the resulting string is output in InsertRow in double quotes.

                $value       = array_map(
                    function ($v) use ($enclosure_esc, $encode_esc) {

The variable $enclosure_esc should be in camel caps format.

The variable $encode_esc should be in camel caps format.

                        return is_string($v) ? $this->encodeString($v, $enclosure_esc, $encode_esc) : $v;

The variable $enclosure_esc should be in camel caps format.

The variable $encode_esc should be in camel caps format.

                    },
                    $value
                );
                $resultArray = FormatLine::Insert($value,($encodeEnclosure==='\\'?true:false));

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

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

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

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

Useless ternary operator.

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

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

                return $encodeArray . '[' . $resultArray . ']' . $encodeArray;

Expected 1 lines before "return", found 0.

            }

            $value = ValueFormatter::formatValue($value, false);

            if (is_float($value) || is_int($value)) {
                return (string) $value;
            }

            if (is_string($value) && $encode) {
                if ($tabEncode) {
                    return str_replace(["\t", "\n"], ['\\t', '\\n'], $value);
                }

                if (!$skipEncode)

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

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

                $value = $this->encodeString($value, $enclosure_esc, $encode_esc);

The variable $enclosure_esc should be in camel caps format.

The variable $encode_esc should be in camel caps format.

                return $enclosure . $value . $enclosure;
            }

            if ($value === null) {
                return $null;
            }

            return $value;
        };

        return array_map($quote, $row);
    }

    /**
     * @return string
     */
    public function encodeString(string $value, string $enclosureEsc, string $encodeEsc)

Method \ClickHouseDB\Quote\StrictQuoteLine::encodeString() 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 preg_replace('/(' . $enclosureEsc . '|' . $encodeEsc . ')/', $encodeEsc . '\1', $value);
    }
}