Bindings::escapeString() - Code Metrics - Inspection of "Fix bindings" - smi2/phpClickHouse - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#84)

by Šimon

created 2018-08-14 14:29 UTC

Bindings::escapeString() A

↳ Parent: Bindings

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

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

<?php

declare(strict_types=1);

namespace ClickHouseDB\Query\Degeneration;

use ClickHouseDB\Exception\UnsupportedParameterType;
use ClickHouseDB\Query\Degeneration;
use DateTimeInterface;
use function array_map;
use function implode;
use function is_array;
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 Bindings implements Degeneration
{
    /**

     * @var array

     */
    protected $bindings = [];

    /**
     * @param array $bindings

     */
    public function bindParams(array $bindings)

    {
        $this->bindings = [];
        foreach ($bindings as $column => $value) {
            $this->bindParam($column, $value);
        }
    }

    /**
     * @param string $column
     * @param mixed  $value
     */
    public function bindParam($column, $value)

    {
        $this->bindings[$column] = $value;
    }

    /**
     * Escape an string
     *
     * @param string $value
     * @return string
     */
    private function escapeString($value)

    {
        return addslashes($value);

    }

    /**
     * Binds a list of values to the corresponding parameters.
     * This is similar to [[bindValue()]] except that it binds multiple values at a time.
     *
     * @param string $sql
     * @param array $binds

     * @param string $pattern
     * @return string
     */
    public function compile_binds($sql, $binds,$pattern)

    {
        return preg_replace_callback($pattern, function($m) use ($binds){

            if(isset($binds[$m[1]])){ // If it exists in our array

                return $binds[$m[1]]; // Then replace it from our array
            }

            return $m[0]; // Otherwise return the whole match (basically we won't change it)
        }, $sql);
    }

    /**
     * Compile Bindings
     *
     * @param string $sql
     * @return mixed
     */
    public function process($sql)

    {
        $bindFormatted=[];
$a = "a";
$ab = "ab";
$abc = "abc";
        $bindRaw=[];
$a = "a";
$ab = "ab";
$abc = "abc";
        foreach ($this->bindings as $key => $value) {
            if (is_array($value)) {
                $valueSet = implode(', ', $value);

                $values = array_map(
                    function ($value) {
                        return $this->formatParameter($value);
                    },
                    $value
                );

                $formattedParameter = implode(',', $values);
            } else {
                $valueSet           = $value;
                $formattedParameter = $this->formatParameter($value);
            }

            if ($formattedParameter !== null) {
                $bindFormatted[$key]=$formattedParameter;

            }

            if ($valueSet !== null) {

                $bindRaw[$key]=$valueSet;

            }
        }

        for ($loop=0;$loop<2;$loop++)

        {
            // dipping in binds
            // example ['A' => '{B}' , 'B'=>':C','C'=>123]
            $sql=$this->compile_binds($sql,$bindRaw,'#{([\w+]+)}#');

        }
        $sql=$this->compile_binds($sql,$bindFormatted,'#:([\w+]+)#');


        return $sql;
    }

    /**
     * @param mixed $value
     * @return mixed
     */
    private function formatParameter($value)
    {
        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 (is_object($value) && is_callable([$value, '__toString'])) {
            $value = (string) $value;
        }

        if (is_string($value)) {
            return $this->formatStringParameter($this->escapeString($value));
        }

        throw UnsupportedParameterType::new($value);
    }

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

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


1		<?php
2
3		declare(strict_types=1);
4
5		namespace ClickHouseDB\Query\Degeneration;
6
7		use ClickHouseDB\Exception\UnsupportedParameterType;
8		use ClickHouseDB\Query\Degeneration;
9		use DateTimeInterface;
10		use function array_map;
11		use function implode;
12		use function is_array;
13		use function is_bool;
14		use function is_callable;
15		use function is_float;
16		use function is_int;
17		use function is_object;
18		use function is_string;
19		use function sprintf;
20
21		class Bindings implements Degeneration
22		{
23		/**
		0 ignored issues – show introduced 2018-08-14 14:10 UTC by Report Bug Copy Issue Report Found multi-line comment for property \ClickHouseDB\Query\Degeneration\Bindings::$bindings with single line content, use one-line comment instead. Loading history...
24		* @var array
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report @var annotation of property \ClickHouseDB\Query\Degeneration\Bindings::$bindings does not specify type hint for its items. Loading history...
25		*/
26		protected $bindings = [];
27
28		/**
29		* @param array $bindings
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report @param annotation of method \ClickHouseDB\Query\Degeneration\Bindings::bindParams() does not specify type hint for items of its traversable parameter $bindings. Loading history...
30		*/
31	57	public function bindParams(array $bindings)
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Query\Degeneration\Bindings::bindParams() does not have void return type hint. Loading history...
32		{
33	57	$this->bindings = [];
34	57	foreach ($bindings as $column => $value) {
35	22	$this->bindParam($column, $value);
36		}
37	57	}
38
39		/**
40		* @param string $column
41		* @param mixed $value
42		*/
43	22	public function bindParam($column, $value)
		0 ignored issues – show introduced 2018-08-14 14:10 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Query\Degeneration\Bindings::bindParam() does not have parameter type hint for its parameter $column but it should be possible to add it based on @param annotation "string". Loading history... introduced 2018-08-14 14:10 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Query\Degeneration\Bindings::bindParam() does not have void return type hint. Loading history...
44		{
45	22	$this->bindings[$column] = $value;
46	22	}
47
48		/**
49		* Escape an string
50		*
51		* @param string $value
52		* @return string
53		*/
54	17	private function escapeString($value)
		0 ignored issues – show introduced 2018-08-14 14:10 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Query\Degeneration\Bindings::escapeString() does not have parameter type hint for its parameter $value but it should be possible to add it based on @param annotation "string". Loading history... introduced 2018-08-14 14:10 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Query\Degeneration\Bindings::escapeString() does not have return type hint for its return value but it should be possible to add it based on @return annotation "string". Loading history...
55		{
56	17	return addslashes($value);
		0 ignored issues – show introduced 2018-08-14 14:10 UTC by Report Bug Copy Issue Report Function addslashes() should not be referenced via a fallback global name, but via a use statement. Loading history...
57		}
58
59		/**
60		* Binds a list of values to the corresponding parameters.
61		* This is similar to [[bindValue()]] except that it binds multiple values at a time.
62		*
63		* @param string $sql
64		* @param array $binds
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report @param annotation of method \ClickHouseDB\Query\Degeneration\Bindings::compile_binds() does not specify type hint for items of its traversable parameter $binds. Loading history... Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter type; 1 found Loading history...
65		* @param string $pattern
66		* @return string
67		*/
68	57	public function compile_binds($sql, $binds,$pattern)
		0 ignored issues – show Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method name "Bindings::compile_binds" is not in camel caps format Loading history... introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Query\Degeneration\Bindings::compile_binds() does not have parameter type hint for its parameter $sql but it should be possible to add it based on @param annotation "string". Loading history... introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Query\Degeneration\Bindings::compile_binds() does not have parameter type hint for its parameter $binds but it should be possible to add it based on @param annotation "array". Loading history... introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Query\Degeneration\Bindings::compile_binds() does not have parameter type hint for its parameter $pattern but it should be possible to add it based on @param annotation "string". Loading history... introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Query\Degeneration\Bindings::compile_binds() does not have return type hint for its return value but it should be possible to add it based on @return annotation "string". Loading history... Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Expected 1 space between comma and argument "$pattern"; 0 found Loading history...
69		{
70		return preg_replace_callback($pattern, function($m) use ($binds){
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Function preg_replace_callback() should not be referenced via a fallback global name, but via a use statement. Loading history... Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Expected 1 space after FUNCTION keyword; 0 found Loading history... Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Expected 1 space before opening brace; found 0 Loading history...
71	21	if(isset($binds[$m[1]])){ // If it exists in our array
		0 ignored issues – show Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Expected 1 space(s) after IF keyword; 0 found Loading history...
72	21	return $binds[$m[1]]; // Then replace it from our array
73		}
74
75	3	return $m[0]; // Otherwise return the whole match (basically we won't change it)
76	57	}, $sql);
77		}
78
79		/**
80		* Compile Bindings
81		*
82		* @param string $sql
83		* @return mixed
84		*/
85	57	public function process($sql)
		0 ignored issues – show introduced 2018-08-14 14:10 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Query\Degeneration\Bindings::process() does not have parameter type hint for its parameter $sql but it should be possible to add it based on @param annotation "string". Loading history...
86		{
87	57	$bindFormatted=[];
		0 ignored issues – show Coding Style introduced 2018-08-14 14:10 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 1 space but found 0 spaces This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
88	57	$bindRaw=[];
		0 ignored issues – show Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 7 spaces but found 0 spaces This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
89	57	foreach ($this->bindings as $key => $value) {
90	22	if (is_array($value)) {
91	6	$valueSet = implode(', ', $value);
92
93	6	$values = array_map(
94		function ($value) {
95	6	return $this->formatParameter($value);
96	6	},
97	6	$value
98		);
99
100	6	$formattedParameter = implode(',', $values);
101		} else {
102	18	$valueSet = $value;
103	18	$formattedParameter = $this->formatParameter($value);
104		}
105
106	21	if ($formattedParameter !== null) {
107	21	$bindFormatted[$key]=$formattedParameter;
		0 ignored issues – show Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Equals sign not aligned correctly; expected 1 space but found 0 spaces Loading history...
108		}
109
110	21	if ($valueSet !== null) {
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Use early exit to reduce code nesting. Loading history...
111	21	$bindRaw[$key]=$valueSet;
		0 ignored issues – show Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Equals sign not aligned correctly; expected 1 space but found 0 spaces Loading history...
112		}
113		}
114
115	57	for ($loop=0;$loop<2;$loop++)
		0 ignored issues – show Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Expected 1 space after first semicolon of FOR loop; 0 found Loading history... Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Expected 1 space after second semicolon of FOR loop; 0 found Loading history...
116		{
117		// dipping in binds
118		// example ['A' => '{B}' , 'B'=>':C','C'=>123]
119	57	$sql=$this->compile_binds($sql,$bindRaw,'#{([\w+]+)}#');
		0 ignored issues – show Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Equals sign not aligned correctly; expected 1 space but found 0 spaces Loading history...
120		}
121	57	$sql=$this->compile_binds($sql,$bindFormatted,'#:([\w+]+)#');
		0 ignored issues – show Coding Style introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Equals sign not aligned correctly; expected 1 space but found 0 spaces Loading history...
122
123	57	return $sql;
124		}
125
126		/**
127		* @param mixed $value
128		* @return mixed
129		*/
130	22	private function formatParameter($value)
131		{
132	22	if ($value instanceof DateTimeInterface) {
133	1	$value = $value->format('Y-m-d H:i:s');
134		}
135
136	22	if (is_float($value) \|\| is_int($value) \|\| is_bool($value) \|\| $value === null) {
137	9	return $value;
138		}
139
140	18	if (is_object($value) && is_callable([$value, '__toString'])) {
141	1	$value = (string) $value;
142		}
143
144	18	if (is_string($value)) {
145	17	return $this->formatStringParameter($this->escapeString($value));
146		}
147
148	1	throw UnsupportedParameterType::new($value);
149		}
150
151		/**
152		* @return string
153		*/
154	17	private function formatStringParameter($value)
		0 ignored issues – show introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Query\Degeneration\Bindings::formatStringParameter() does not have parameter type hint nor @param annotation for its parameter $value. Loading history... introduced 2018-07-08 20:56 UTC by Report Bug Copy Issue Report Method \ClickHouseDB\Query\Degeneration\Bindings::formatStringParameter() does not have return type hint for its return value but it should be possible to add it based on @return annotation "string". Loading history...
155		{
156	17	return sprintf("'%s'", $value);
157		}
158		}
159

smi2 / phpClickHouse

Pull Request — master (#84)

Bindings::escapeString() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like