smi2 / phpClickHouse

src/Quote/ValueFormatter.php

<?php

declare(strict_types=1);

namespace ClickHouseDB\Quote;

use ClickHouseDB\Exception\UnsupportedValueType;
use ClickHouseDB\Query\Expression\Expression;
use ClickHouseDB\Type\Type;
use DateTimeInterface;
use function addslashes;

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

use function is_bool;
use function is_callable;
use function is_float;
use function is_int;
use function is_object;
use function is_string;
use function sprintf;

class ValueFormatter
{
    /**
     * @param mixed $value

Incorrect annotations group.

     * @param bool $addQuotes

Expected 2 spaces after parameter type; 1 found

Method \ClickHouseDB\Quote\ValueFormatter::formatValue() has useless @param annotation for parameter $addQuotes.

     * @return mixed
     */
    public static function formatValue($value, bool $addQuotes = true)
    {
        if ($value instanceof DateTimeInterface) {
            $value = $value->format('Y-m-d H:i:s');
        }

        if (is_float($value) || is_int($value) || is_bool($value) || $value === null) {
            return $value;
        }

        if ($value instanceof Type) {
            return $value->getValue();
        }

        if ($value instanceof Expression) {
            return $value->getValue();
        }

        if (is_object($value) && is_callable([$value, '__toString'])) {
            $value = (string) $value;
        }

        if (is_string($value)) {
            if ($addQuotes) {
                return self::formatStringParameter(self::escapeString($value));
            }

            return $value;
        }

        throw UnsupportedValueType::new($value);
    }

    /**
     * Escape an string
     *
     * @param string $value

Incorrect annotations group.

     * @return string
     */
    private static function escapeString($value)

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

Method \ClickHouseDB\Quote\ValueFormatter::escapeString() 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 addslashes($value);
    }

    /**
     * @return string
     */
    private static function formatStringParameter($value)

Method \ClickHouseDB\Quote\ValueFormatter::formatStringParameter() does not have parameter type hint nor @param annotation for its parameter $value.

Method \ClickHouseDB\Quote\ValueFormatter::formatStringParameter() 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 sprintf("'%s'", $value);
    }
}