smi2 / phpClickHouse

src/Settings.php

<?php

Missing declare(strict_types=1).

namespace ClickHouseDB;

class Settings
{
    /**

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

     * @var array

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

     */
    private $settings = [];

    private $_ReadOnlyUser = false;

Property \ClickHouseDB\Settings::$_ReadOnlyUser does not have @var annotation for its value.

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

    /**
     * Settings constructor.

Documentation comment contains forbidden comment "Settings constructor.".

     */
    public function __construct()
    {
        $default = [
            'extremes' => false,
            'readonly' => true,
            'max_execution_time' => 20.0,
            'enable_http_compression' => 1,
            'https' => false,
        ];

        $this->settings = $default;
    }

    /**
     * @param string|int $key

Incorrect annotations group.

     * @return mixed
     */
    public function get($key)
    {
        if (!$this->is($key)) {

Expected 1 lines after "if", found 0.

Expected 1 space after NOT operator; 0 found

            return null;
        }
        return $this->settings[$key];

Expected 1 lines before "return", found 0.

    }

    /**
     * @param string|int $key

Incorrect annotations group.

     * @return bool
     */
    public function is($key)

Method \ClickHouseDB\Settings::is() 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 isset($this->settings[$key]);
    }

Expected 1 blank line after function; 2 found

    /**
     * @param string|int $key

Incorrect annotations group.

     * @param mixed $value

Expected 6 spaces after parameter type; 1 found

     * @return $this
     */
    public function set($key, $value)
    {
        $this->settings[$key] = $value;
        return $this;

Expected 1 lines before "return", found 0.

    }

    /**
     * @return mixed
     */
    public function getDatabase()
    {
        return $this->get('database');
    }

    /**
     * @param string $db

Incorrect annotations group.

     * @return $this
     */
    public function database($db)

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

    {
        $this->set('database', $db);
        return $this;

Expected 1 lines before "return", found 0.

    }

    /**
     * @return int

Method \ClickHouseDB\Settings::getTimeOut() has useless @return annotation.

     */
    public function getTimeOut(): int

Method \ClickHouseDB\Settings::getTimeOut() does not need documentation comment.

    {
        return intval($this->get('max_execution_time'));

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

    }

    /**
     * @return mixed|null
     */
    public function isEnableHttpCompression()
    {
        return $this->getSetting('enable_http_compression');
    }

    /**
     * @param bool|int $flag

Incorrect annotations group.

     * @return $this
     */
    public function enableHttpCompression($flag)
    {
        $this->set('enable_http_compression', intval($flag));

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

        return $this;

Expected 1 lines before "return", found 0.

    }

Expected 1 blank line after function; 2 found

    public function https($flag = true)

Method \ClickHouseDB\Settings::https() does not have parameter type hint nor @param annotation for its parameter $flag.

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

    {
        $this->set('https', $flag);
        return $this;

Expected 1 lines before "return", found 0.

    }

    public function isHttps()

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

    {
        return $this->get('https');
    }

Expected 1 blank line after function; 2 found

    /**
     * @param int|bool $flag

Incorrect annotations group.

     * @return $this
     */
    public function readonly($flag)
    {
        $this->set('readonly', $flag);
        return $this;

Expected 1 lines before "return", found 0.

    }

    /**
     * @param string $session_id

Incorrect annotations group.

     * @return $this
     */
    public function session_id($session_id)

Method name "Settings::session_id" is not in camel caps format

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

The variable $session_id should be in camel caps format.

    {
        $this->set('session_id', $session_id);

The variable $session_id should be in camel caps format.

        return $this;

Expected 1 lines before "return", found 0.

    }

    /**
     * @return mixed|bool
     */
    public function getSessionId()
    {
        if (empty($this->settings['session_id'])) {

Expected 1 lines after "if", found 0.

            return false;
        }
        return $this->get('session_id');

Expected 1 lines before "return", found 0.

    }

    /**
     * @return string|bool
     */
    public function makeSessionId()
    {
        $this->session_id(sha1(uniqid('', true)));

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

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

        return $this->getSessionId();

Expected 1 lines before "return", found 0.

    }

    /**
     *
     * max_execution_time - is integer in Seconds clickhouse source

Expected 0 lines before first content, found 1.

     *
     * @param int $time

Incorrect annotations group.

Method \ClickHouseDB\Settings::max_execution_time() has useless @param annotation for parameter $time.

     * @return $this
     */
    public function max_execution_time(int $time)

Method name "Settings::max_execution_time" is not in camel caps format

    {
        $this->set('max_execution_time',$time);
        return $this;

Expected 1 lines before "return", found 0.

    }

    /**
     * @return array

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

     */
    public function getSettings()

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

    {
        return $this->settings;
    }

    /**
     * @param array $settings_array

Incorrect annotations group.

@param annotation of method \ClickHouseDB\Settings::apply() does not specify type hint for items of its traversable parameter $settings_array.

     * @return $this
     */
    public function apply(array $settings_array)

The variable $settings_array should be in camel caps format.

    {
        foreach ($settings_array as $key => $value) {

The variable $settings_array should be in camel caps format.

            $this->set($key, $value);
        }

        return $this;
    }

    /**
     * @param int|bool $flag
     */
    public function setReadOnlyUser($flag):void

There must be exactly one space between return type hint colon and return type hint.

    {
        $this->_ReadOnlyUser = $flag;

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

    }

    /**
     * @return bool

Method \ClickHouseDB\Settings::isReadOnlyUser() has useless @return annotation.

     */
    public function isReadOnlyUser():bool

Method \ClickHouseDB\Settings::isReadOnlyUser() does not need documentation comment.

There must be exactly one space between return type hint colon and return type hint.

    {
        return $this->_ReadOnlyUser;

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

    }

    /**
     * @param string $name

Incorrect annotations group.

Method \ClickHouseDB\Settings::getSetting() has useless @param annotation for parameter $name.

     * @return mixed|null
     */
    public function getSetting(string $name)
    {
        if (!isset($this->settings[$name])) {

Expected 1 space after NOT operator; 0 found

            return null;
        }

        return $this->get($name);
    }

    public function clear():void

There must be exactly one space between return type hint colon and return type hint.

    {
        $this->settings = [];
    }
}