ValueFormatter::escapeString() - Code Metrics - smi2/phpClickHouse - Measure and Improve Code Quality continuously with Scrutinizer

ValueFormatter::escapeString() A
last analyzed 2024-07-17 07:54 UTC

↳ Parent: ValueFormatter

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10

<?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;

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

     * @param bool $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

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

    {
        return addslashes($value);
    }

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

    {
        return sprintf("'%s'", $value);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace ClickHouseDB\Quote;
6
7		use ClickHouseDB\Exception\UnsupportedValueType;
8		use ClickHouseDB\Query\Expression\Expression;
9		use ClickHouseDB\Type\Type;
10		use DateTimeInterface;
11		use function addslashes;
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Expected 1 lines between different types of use statement, found 0. Loading history...
12		use function is_bool;
13		use function is_callable;
14		use function is_float;
15		use function is_int;
16		use function is_object;
17		use function is_string;
18		use function sprintf;
19
20		class ValueFormatter
21		{
22		/**
23		* @param mixed $value
		0 ignored issues – show introduced 2020-01-17 20:52 UTC by Report Bug Copy Issue Report Incorrect annotations group. Loading history...
24		* @param bool $addQuotes
		0 ignored issues – show Coding Style introduced 2020-01-17 20:52 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter type; 1 found Loading history... introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Quote\ValueFormatter::formatValue() has useless @param annotation for parameter $addQuotes. Loading history...
25		* @return mixed
26		*/
27	36	public static function formatValue($value, bool $addQuotes = true)
28		{
29	36	if ($value instanceof DateTimeInterface) {
30	2	$value = $value->format('Y-m-d H:i:s');
31		}
32
33	36	if (is_float($value) \|\| is_int($value) \|\| is_bool($value) \|\| $value === null) {
34	21	return $value;
35		}
36
37	31	if ($value instanceof Type) {
38	1	return $value->getValue();
39		}
40
41	31	if ($value instanceof Expression) {
42	1	return $value->getValue();
43		}
44
45	30	if (is_object($value) && is_callable([$value, '__toString'])) {
46	1	$value = (string) $value;
47		}
48
49	30	if (is_string($value)) {
50	29	if ($addQuotes) {
51	19	return self::formatStringParameter(self::escapeString($value));
52		}
53
54	10	return $value;
55		}
56
57	1	throw UnsupportedValueType::new($value);
58		}
59
60		/**
61		* Escape an string
62		*
63		* @param string $value
		0 ignored issues – show introduced 2018-09-26 10:27 UTC by Report Bug Copy Issue Report Incorrect annotations group. Loading history...
64		* @return string
65		*/
66	19	private static function escapeString($value)
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report 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". Loading history... introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report 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". Loading history...
67		{
68	19	return addslashes($value);
69		}
70
71		/**
72		* @return string
73		*/
74	19	private static function formatStringParameter($value)
		0 ignored issues – show introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Quote\ValueFormatter::formatStringParameter() does not have parameter type hint nor @param annotation for its parameter $value. Loading history... introduced 2020-12-21 16:16 UTC by Report Bug Copy Issue Report 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". Loading history...
75		{
76	19	return sprintf("'%s'", $value);
77		}
78		}
79

smi2 / phpClickHouse

ValueFormatter::escapeString() A last analyzed 2024-07-17 07:54 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ValueFormatter::escapeString() A
last analyzed 2024-07-17 07:54 UTC