smi2 / phpClickHouse

src/Query/WriteToFile.php

<?php

Missing declare(strict_types=1).

namespace ClickHouseDB\Query;

use ClickHouseDB\Exception\QueryException;

class WriteToFile
{
    /**

Empty comment

     *
     */
    const FORMAT_TabSeparated          = 'TabSeparated';

Constant \ClickHouseDB\Query\WriteToFile::FORMAT_TabSeparated visibility missing.

This class constant is not uppercase (expected FORMAT_TABSEPARATED).

    const FORMAT_TabSeparatedWithNames = 'TabSeparatedWithNames';

Constant \ClickHouseDB\Query\WriteToFile::FORMAT_TabSeparatedWithNames visibility missing.

This class constant is not uppercase (expected FORMAT_TABSEPARATEDWITHNAMES).

    const FORMAT_CSV                   = 'CSV';

Constant \ClickHouseDB\Query\WriteToFile::FORMAT_CSV visibility missing.

    const FORMAT_CSVWithNames          = 'CSVWithNames';

Constant \ClickHouseDB\Query\WriteToFile::FORMAT_CSVWithNames visibility missing.

This class constant is not uppercase (expected FORMAT_CSVWITHNAMES).

    const FORMAT_JSONEACHROW           = 'JSONEachRow';

Constant \ClickHouseDB\Query\WriteToFile::FORMAT_JSONEACHROW visibility missing.

    private $support_format = ['TabSeparated', 'TabSeparatedWithNames', 'CSV', 'CSVWithNames', 'JSONEachRow'];

Property \ClickHouseDB\Query\WriteToFile::$support_format does not have @var annotation for its value.

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

    /**

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

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

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

    /**

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

     * @var string
     */
    private $format = 'CSV';

    /**

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

     * @var bool
     */
    private $gzip = false;
    /**
     * WriteToFile constructor.

Documentation comment contains forbidden comment "WriteToFile constructor.".

     * @param string $file_name

Expected 1 lines between description and annotations, found 0.

Expected 6 spaces after parameter type; 1 found

     * @param bool $overwrite

Expected 8 spaces after parameter type; 1 found

     * @param string|null $format
     */
    public function __construct($file_name, $overwrite = true, $format = null) {

Expected 0 blank lines after opening function brace; 2 found

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

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

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

Expected 1 blank line before function; 0 found

The variable $file_name should be in camel caps format.

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

        if (!$file_name)

The variable $file_name should be in camel caps format.

Expected 1 space after NOT operator; 0 found

        {
            throw new QueryException('Bad file path');
        }

        if (is_file($file_name))

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

Expected 1 lines after "if", found 0.

The variable $file_name should be in camel caps format.

        {
            if (!$overwrite)

Expected 1 lines after "if", found 0.

Expected 1 space after NOT operator; 0 found

            {
                throw new QueryException('File exists: ' . $file_name);

The variable $file_name should be in camel caps format.

            }
            if (!unlink($file_name))

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

The variable $file_name should be in camel caps format.

Expected 1 space after NOT operator; 0 found

            {
                throw new QueryException('Can`t delete: ' . $file_name);

The variable $file_name should be in camel caps format.

            }
        }
        $dir = dirname($file_name);

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

The variable $file_name should be in camel caps format.

        if (!is_writable($dir))

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

Expected 1 lines after "if", found 0.

Expected 1 space after NOT operator; 0 found

        {
            throw new QueryException('Can`t writable dir: ' . $dir);
        }
        if (is_string($format))

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

Expected 1 lines after "if", found 0.

        {
            $this->setFormat($format);
        }
        $this->file_name = $file_name;

The variable $file_name should be in camel caps format.

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

    }

    /**
     * @return bool
     */
    public function getGzip()

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

    {
        return $this->gzip;
    }

    /**
     * @param bool $flag
     */
    public function setGzip($flag)

Method \ClickHouseDB\Query\WriteToFile::setGzip() does not have native type hint for its parameter $flag but it should be possible to add it based on @param annotation "bool".

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

    {
        $this->gzip = $flag;
    }

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

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

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

    {
        if (!in_array($format, $this->support_format))

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

Expected 1 lines after "if", found 0.

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

Expected 1 space after NOT operator; 0 found

        {
            throw new QueryException('Unsupport format: ' . $format);
        }
        $this->format = $format;
    }

Expected 1 blank line after function; 0 found

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

Method \ClickHouseDB\Query\WriteToFile::size() 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 filesize($this->file_name);

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

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

    }

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

Method \ClickHouseDB\Query\WriteToFile::fetchFile() 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->file_name;

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

    }

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

Method \ClickHouseDB\Query\WriteToFile::fetchFormat() 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->format;
    }

Expected 0 blank lines after function; 1 found

}

There must be exactly 0 empty lines before class closing brace.