smi2 / phpClickHouse

src/Settings.php

<?php

namespace ClickHouseDB;

class Settings
{
    /**
     * @var array
     */
    private $settings = [];

    private $_ReadOnlyUser = false;

    /**
     * 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
     * @return mixed
     */
    public function get($key)
    {
        if (!$this->is($key)) {
            return null;
        }
        return $this->settings[$key];
    }

    /**
     * @param string|int $key
     * @return bool
     */
    public function is($key)
    {
        return isset($this->settings[$key]);
    }


    /**
     * @param string|int $key
     * @param mixed $value
     * @return $this
     */
    public function set($key, $value)
    {
        $this->settings[$key] = $value;
        return $this;
    }

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

    /**
     * @param string $db
     * @return $this
     */
    public function database($db)
    {
        $this->set('database', $db);
        return $this;
    }

    /**
     * @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'));
    }

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

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


    public function https($flag = true)
    {
        $this->set('https', $flag);
        return $this;
    }

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


    /**
     * @param int|bool $flag
     * @return $this
     */
    public function readonly($flag)
    {
        $this->set('readonly', $flag);
        return $this;
    }

    /**
     * @param string $session_id
     * @return $this
     */
    public function session_id($session_id)
    {
        $this->set('session_id', $session_id);
        return $this;
    }

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

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

    /**
     *
     * max_execution_time - is integer in Seconds clickhouse source
     *
     * @param int $time

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

     * @return $this
     */
    public function max_execution_time(int $time)
    {
        $this->set('max_execution_time',$time);
        return $this;
    }

    /**
     * @return array
     */
    public function getSettings()
    {
        return $this->settings;
    }

    /**
     * @param array $settings_array
     * @return $this
     */
    public function apply(array $settings_array)
    {
        foreach ($settings_array as $key => $value) {
            $this->set($key, $value);
        }

        return $this;
    }

    /**
     * @param int|bool $flag
     */
    public function setReadOnlyUser($flag):void
    {
        $this->_ReadOnlyUser = $flag;
    }

    /**
     * @return bool
     */
    public function isReadOnlyUser():bool
    {
        return $this->_ReadOnlyUser;
    }

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

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

    public function clear():void
    {
        $this->settings = [];
    }
}