smi2 / phpClickHouse

src/Query/WhereInFile.php

<?php

Missing declare(strict_types=1).

namespace ClickHouseDB\Query;

use ClickHouseDB\Exception\QueryException;

class WhereInFile
{
    /**

Empty comment

     *
     */
    const FORMAT_TabSeparated          = 'TabSeparated';

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

This class constant is not uppercase (expected FORMAT_TABSEPARATED).

    const FORMAT_TabSeparatedWithNames = 'TabSeparatedWithNames';

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

This class constant is not uppercase (expected FORMAT_TABSEPARATEDWITHNAMES).

    const FORMAT_CSV                   = 'CSV';

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

    /**

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

     * @var array

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

     */
    private $_files = [];


    /**
     * WhereInFile constructor.

Documentation comment contains forbidden comment "WhereInFile constructor.".

     */
    public function __construct() {}

Expected 1 blank line before function; 2 found

Expected 1 blank line after function; 2 found

    /**
     * @param string $file_name
     * @param string $table_name
     * @param string $structure
     * @param string $format
     */
    public function attachFile($file_name, $table_name, $structure, $format = 'CSV')

Method \ClickHouseDB\Query\WhereInFile::attachFile() 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\WhereInFile::attachFile() does not have native type hint for its parameter $table_name but it should be possible to add it based on @param annotation "string".

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

Method \ClickHouseDB\Query\WhereInFile::attachFile() 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\WhereInFile::attachFile() does not have void return type hint.

The variable $file_name should be in camel caps format.

The variable $table_name should be in camel caps format.

    {
        if (!is_readable($file_name)) {

Function is_readable() 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 read file: ' . $file_name);

The variable $file_name should be in camel caps format.

        }

        $this->_files[$table_name] = [

The variable $table_name should be in camel caps format.

            'filename'  => $file_name,

The variable $file_name should be in camel caps format.

            'structure' => $structure,
            'format'    => $format

Multi-line arrays must have a trailing comma after the last element.

        ];
    }

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

Method \ClickHouseDB\Query\WhereInFile::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 sizeof($this->_files);

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

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

    }

    /**
     * @return array

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

     */
    public function fetchFiles()

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

    {
        $out = [];
        foreach ($this->_files as $table => $data) {
            $out[$table] = realpath($data['filename']);

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

        }

        return $out;
    }

    /**
     * @param string $table

Incorrect annotations group.

     * @return string
     */
    public function fetchStructure($table)

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

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

    {
        $structure = $this->_files[$table]['structure'];

        $out = [];
        foreach ($structure as $name => $type) {
            $out[] = $name . ' ' . $type;
        }

        return implode(',', $out);

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

    }

    /**
     * @return array

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

     */
    public function fetchUrlParams()

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

    {
        $out = [];
        foreach ($this->_files as $table => $data) {
            $out[$table . '_structure'] = $this->fetchStructure($table);
            $out[$table . '_format'] = $data['format'];

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

        }

        return $out;
    }

Expected 0 blank lines after function; 1 found

}

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