Config::createParameter() - Code Metrics - Inspection of "update workflow" - kuperwood/eav - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 0272f5...3a0c5f )

by Aleksandr

created 2025-03-09 14:38 UTC

Config::createParameter() A

↳ Parent: Config

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/**
 * This file is part of the eav package.
 * @author    Aleksandr Drobotik <[email protected]>
 * @copyright 2023 Aleksandr Drobotik
 * @license   https://opensource.org/license/mit  The MIT License
 */
declare(strict_types=1);

namespace Drobotik\Eav\QueryBuilder;

use Drobotik\Eav\Enum\_ATTR;
use Drobotik\Eav\Enum\ATTR_TYPE;
use Drobotik\Eav\Enum\QB_CONDITION;
use Drobotik\Eav\Enum\QB_CONFIG;
use Drobotik\Eav\Enum\QB_JOIN;
use Drobotik\Eav\Enum\QB_OPERATOR;
use Drobotik\Eav\Exception\QueryBuilderException;
use Drobotik\Eav\Value\ValueEmpty;
use InvalidArgumentException;

class Config
{
    // :domainKey
    private string $domainKeyParam;
    // :setKey
    private string $setKeyParam;
    // joins which will be performed
    private array $joins = [];
    // eav attributes array for internal usage to not allow wrong fields to query
    private array $attributes = [];
    // result columns which should be visible on grid
    private array $columns = [];
    // fields that need to be in the SELECT statement
    private array $selected = [];
    // query bind parameters with values
    private array $parameters = [];
    // query expressions recursive array
    /** @var Expression[] $expressions */
    private array $expressions = [];

    public function getDomainKeyParam() : string
    {
        return $this->domainKeyParam;
    }

    public function setDomainKey(int $key) : void
    {
        $paramName = $this->createParameter('domainKey', $key);
        $this->domainKeyParam = $paramName;
    }

    public function getSetKeyParam() : string
    {
        return $this->setKeyParam;
    }

    public function setSetKey(int $key) : void
    {
        $paramName = $this->createParameter('setKey', $key);
        $this->setKeyParam = $paramName;
    }

    public function hasJoin(string $name) : bool
    {
        return key_exists($name, $this->joins);
    }

    public function addJoin(string $table, string $name, int $attrKey) : void
    {
        $paramName = $this->createParameter(
            sprintf('%s_join_%s', $name, QB_JOIN::ATTR_PARAM), $attrKey);

        $this->joins[$name] = [
            QB_JOIN::NAME => $name,
            QB_JOIN::TABLE => $table,
            QB_JOIN::ATTR_PARAM => $paramName
        ];
    }

    public function getJoins() : array
    {
        return $this->joins;
    }

    public function getJoin(string $name) : array
    {
        return $this->joins[$name];
    }

    public function addColumns(array $columns) : void
    {
        $this->columns = array_values(array_unique($columns));
    }

    public function getColumns() : array
    {
        return $this->columns;
    }

    public function addAttributes(array $attributes) : void
    {
        foreach ($attributes as $attribute)
            $this->addAttribute($attribute);
    }

    public function getAttributes(): array
    {
        return $this->attributes;
    }

    public function addAttribute(array $attribute): void
    {
        $this->attributes[$attribute[_ATTR::NAME]] = $attribute;
    }

    public function getAttribute(string $name) : array
    {
        return $this->attributes[$name];
    }

    public function hasAttribute(string $name) : bool
    {
        return key_exists($name, $this->attributes);
    }

    public function addSelect(string $field) : void
    {
        $this->selected[] = $field;
    }

    public function getSelected() : array
    {
        $selected = $this->selected;
        $columns = $this->getColumns();
        usort($selected, function ($a, $b) use ( $columns) {
            $indexA = array_search($a, $columns);
            $indexB = array_search($b, $columns);
            return $indexA - $indexB;
        });
        $selected = array_unique($selected);
        return array_merge(array_intersect($columns, $selected), array_diff($selected, $columns));
    }
    public function isSelected(string $field) : bool
    {
        return in_array($field, $this->selected);
    }

    public function hasParameter(string $name): bool
    {
        return key_exists($name, $this->parameters);
    }

    public function getParameterValue(string $name) : mixed
    {
        return $this->parameters[$name];
    }

    public function createParameter(string $name, mixed $value) : string
    {
        if($this->hasParameter($name)) {
            $uniqueName = sprintf('%s_%s', $name, substr(md5(uniqid()), 0, 5));
            return $this->createParameter($uniqueName, $value);
        } else {
            $this->parameters[$name] = $value;
        }
        return $name;
    }

    public function getParameters() : array
    {
        return $this->parameters;
    }

    public function getExpressions() : array
    {
        return $this->expressions;
    }

    public function handleColumns(): void
    {
        foreach($this->getColumns() as $column)
        {
            if (!$this->hasAttribute($column)) {
                QueryBuilderException::unsupportedAttribute($column);
            }

            $attribute = $this->getAttribute($column);
            $attributeKey = $attribute[_ATTR::ID];
            $table = ATTR_TYPE::valueTable(ATTR_TYPE::getCase($attribute[_ATTR::TYPE]));

            // if in search it should be joined
            if(!$this->hasJoin($column)) {
                $this->addJoin($table, $column, $attributeKey);
                if(!$this->isSelected($column)) {
                    $this->addSelect($column);
                }
            }
        }
    }

    public function handleGroup(array $group) : array
    {
        $result = [];
        $result[] = QB_CONDITION::getCase($group[QB_CONFIG::CONDITION]);
        $rules = $group[QB_CONFIG::RULES];
        foreach($rules as $rule)
        {
            if (key_exists(QB_CONFIG::CONDITION, $rule)) {
                $result[] = $this->handleGroup($rule);
            }
            else {
                $result[] = $this->handleRule($rule);
            }
        }
        return $result;
    }

    public function createExpression(string $field, $operator, mixed $value) : Expression
    {
        $operator = QB_OPERATOR::getCase($operator);
        $expression = new Expression();
        $expression->setField($field);
        $expression->setOperator($operator);

        if(QB_OPERATOR::isBetween($operator)) {
            $value1 = $value[0];
            $value2 = $value[1];
            $param1 = $this->createParameter($field .'_cond_1', $value1);
            $param2 = $this->createParameter($field .'_cond_2', $value2);
            $expression->setParam1($param1);
            $expression->setParam2($param2);

        } else if(QB_OPERATOR::isEmpty($operator)) {
            $param = $this->createParameter($field .'_cond', '');
            $expression->setParam1($param);

        } else if(!QB_OPERATOR::isNull($operator)) {
            if(QB_OPERATOR::isLike($operator)) {
                switch ($operator) {
                    case QB_OPERATOR::BEGINS_WITH:
                    case QB_OPERATOR::NOT_BEGINS_WITH:
                        $value = $value . '%';
                        break;

                    case QB_OPERATOR::CONTAINS:
                    case QB_OPERATOR::NOT_CONTAINS:
                        $value = '%' . $value . '%';
                        break;

                    case QB_OPERATOR::ENDS_WITH:
                    case QB_OPERATOR::NOT_ENDS_WITH:
                        $value = '%' . $value;
                        break;
                    default:
                        throw new InvalidArgumentException("Unhandled operator: " . $operator);
                }
            }
            $param = $this->createParameter($field .'_cond', $value);
            $expression->setParam1($param);
        }

        return $expression;
    }

    public function registerSelect(string $field) : void
    {
        if(!$this->isSelected($field)) {
            $this->addSelect($field);
        }
    }

    public function registerJoin(string $field) : void
    {
        if(!$this->hasJoin($field)) {
            $attribute = $this->getAttribute($field);
            $table = ATTR_TYPE::valueTable(ATTR_TYPE::getCase($attribute[_ATTR::TYPE]));
            $attributeKey = $attribute[_ATTR::ID];
            $this->addJoin($table, $field, $attributeKey);
        }
    }

    public function handleRule(array $rule) : Expression
    {
        $field = $rule[QB_CONFIG::NAME];
        $operator = QB_OPERATOR::getCase($rule[QB_CONFIG::OPERATOR]);
        $value = key_exists(QB_CONFIG::VALUE, $rule)
            ? $rule[QB_CONFIG::VALUE]
            : new ValueEmpty();

        $this->registerSelect($field);
        $this->registerJoin($field);

        return $this->createExpression($field, $operator, $value);
    }

    public function parse(array $config) : void
    {
        if(empty($config))
            return;

        $this->expressions = $this->handleGroup($config);
    }

}

1		<?php
2		/**
3		* This file is part of the eav package.
4		* @author Aleksandr Drobotik <[email protected]>
5		* @copyright 2023 Aleksandr Drobotik
6		* @license https://opensource.org/license/mit The MIT License
7		*/
8		declare(strict_types=1);
9
10		namespace Drobotik\Eav\QueryBuilder;
11
12		use Drobotik\Eav\Enum\_ATTR;
13		use Drobotik\Eav\Enum\ATTR_TYPE;
14		use Drobotik\Eav\Enum\QB_CONDITION;
15		use Drobotik\Eav\Enum\QB_CONFIG;
16		use Drobotik\Eav\Enum\QB_JOIN;
17		use Drobotik\Eav\Enum\QB_OPERATOR;
18		use Drobotik\Eav\Exception\QueryBuilderException;
19		use Drobotik\Eav\Value\ValueEmpty;
20		use InvalidArgumentException;
21
22		class Config
23		{
24		// :domainKey
25		private string $domainKeyParam;
26		// :setKey
27		private string $setKeyParam;
28		// joins which will be performed
29		private array $joins = [];
30		// eav attributes array for internal usage to not allow wrong fields to query
31		private array $attributes = [];
32		// result columns which should be visible on grid
33		private array $columns = [];
34		// fields that need to be in the SELECT statement
35		private array $selected = [];
36		// query bind parameters with values
37		private array $parameters = [];
38		// query expressions recursive array
39		/** @var Expression[] $expressions */
40		private array $expressions = [];
41
42	1	public function getDomainKeyParam() : string
43		{
44	1	return $this->domainKeyParam;
45		}
46
47	1	public function setDomainKey(int $key) : void
48		{
49	1	$paramName = $this->createParameter('domainKey', $key);
50	1	$this->domainKeyParam = $paramName;
51		}
52
53	1	public function getSetKeyParam() : string
54		{
55	1	return $this->setKeyParam;
56		}
57
58	1	public function setSetKey(int $key) : void
59		{
60	1	$paramName = $this->createParameter('setKey', $key);
61	1	$this->setKeyParam = $paramName;
62		}
63
64	1	public function hasJoin(string $name) : bool
65		{
66	1	return key_exists($name, $this->joins);
67		}
68
69	1	public function addJoin(string $table, string $name, int $attrKey) : void
70		{
71	1	$paramName = $this->createParameter(
72	1	sprintf('%s_join_%s', $name, QB_JOIN::ATTR_PARAM), $attrKey);
73
74	1	$this->joins[$name] = [
75	1	QB_JOIN::NAME => $name,
76	1	QB_JOIN::TABLE => $table,
77	1	QB_JOIN::ATTR_PARAM => $paramName
78	1	];
79		}
80
81	1	public function getJoins() : array
82		{
83	1	return $this->joins;
84		}
85
86	1	public function getJoin(string $name) : array
87		{
88	1	return $this->joins[$name];
89		}
90
91	2	public function addColumns(array $columns) : void
92		{
93	2	$this->columns = array_values(array_unique($columns));
94		}
95
96	2	public function getColumns() : array
97		{
98	2	return $this->columns;
99		}
100
101	1	public function addAttributes(array $attributes) : void
102		{
103	1	foreach ($attributes as $attribute)
104	1	$this->addAttribute($attribute);
105		}
106
107	1	public function getAttributes(): array
108		{
109	1	return $this->attributes;
110		}
111
112	1	public function addAttribute(array $attribute): void
113		{
114	1	$this->attributes[$attribute[_ATTR::NAME]] = $attribute;
115		}
116
117	1	public function getAttribute(string $name) : array
118		{
119	1	return $this->attributes[$name];
120		}
121
122	1	public function hasAttribute(string $name) : bool
123		{
124	1	return key_exists($name, $this->attributes);
125		}
126
127	1	public function addSelect(string $field) : void
128		{
129	1	$this->selected[] = $field;
130		}
131
132	2	public function getSelected() : array
133		{
134	2	$selected = $this->selected;
135	2	$columns = $this->getColumns();
136	2	usort($selected, function ($a, $b) use ( $columns) {
137	1	$indexA = array_search($a, $columns);
138	1	$indexB = array_search($b, $columns);
139	1	return $indexA - $indexB;
140	2	});
141	2	$selected = array_unique($selected);
142	2	return array_merge(array_intersect($columns, $selected), array_diff($selected, $columns));
143		}
144	1	public function isSelected(string $field) : bool
145		{
146	1	return in_array($field, $this->selected);
147		}
148
149	1	public function hasParameter(string $name): bool
150		{
151	1	return key_exists($name, $this->parameters);
152		}
153
154	1	public function getParameterValue(string $name) : mixed
155		{
156	1	return $this->parameters[$name];
157		}
158
159	2	public function createParameter(string $name, mixed $value) : string
160		{
161	2	if($this->hasParameter($name)) {
162	1	$uniqueName = sprintf('%s_%s', $name, substr(md5(uniqid()), 0, 5));
163	1	return $this->createParameter($uniqueName, $value);
164		} else {
165	2	$this->parameters[$name] = $value;
166		}
167	2	return $name;
168		}
169
170	1	public function getParameters() : array
171		{
172	1	return $this->parameters;
173		}
174
175	1	public function getExpressions() : array
176		{
177	1	return $this->expressions;
178		}
179
180	3	public function handleColumns(): void
181		{
182	3	foreach($this->getColumns() as $column)
183		{
184	3	if (!$this->hasAttribute($column)) {
185	1	QueryBuilderException::unsupportedAttribute($column);
186		}
187
188	2	$attribute = $this->getAttribute($column);
189	2	$attributeKey = $attribute[_ATTR::ID];
190	2	$table = ATTR_TYPE::valueTable(ATTR_TYPE::getCase($attribute[_ATTR::TYPE]));
191
192		// if in search it should be joined
193	1	if(!$this->hasJoin($column)) {
194	1	$this->addJoin($table, $column, $attributeKey);
195	1	if(!$this->isSelected($column)) {
196	1	$this->addSelect($column);
197		}
198		}
199		}
200		}
201
202	2	public function handleGroup(array $group) : array
203		{
204	2	$result = [];
205	2	$result[] = QB_CONDITION::getCase($group[QB_CONFIG::CONDITION]);
206	1	$rules = $group[QB_CONFIG::RULES];
207	1	foreach($rules as $rule)
208		{
209	1	if (key_exists(QB_CONFIG::CONDITION, $rule)) {
210	1	$result[] = $this->handleGroup($rule);
211		}
212		else {
213	1	$result[] = $this->handleRule($rule);
214		}
215		}
216	1	return $result;
217		}
218
219	5	public function createExpression(string $field, $operator, mixed $value) : Expression
220		{
221	5	$operator = QB_OPERATOR::getCase($operator);
222	5	$expression = new Expression();
223	5	$expression->setField($field);
224	5	$expression->setOperator($operator);
225
226	5	if(QB_OPERATOR::isBetween($operator)) {
227	1	$value1 = $value[0];
228	1	$value2 = $value[1];
229	1	$param1 = $this->createParameter($field .'_cond_1', $value1);
230	1	$param2 = $this->createParameter($field .'_cond_2', $value2);
231	1	$expression->setParam1($param1);
232	1	$expression->setParam2($param2);
233
234	4	} else if(QB_OPERATOR::isEmpty($operator)) {
235	1	$param = $this->createParameter($field .'_cond', '');
236	1	$expression->setParam1($param);
237
238	3	} else if(!QB_OPERATOR::isNull($operator)) {
239	2	if(QB_OPERATOR::isLike($operator)) {
240		switch ($operator) {
241		case QB_OPERATOR::BEGINS_WITH:
242		case QB_OPERATOR::NOT_BEGINS_WITH:
243	1	$value = $value . '%';
244	1	break;
245
246		case QB_OPERATOR::CONTAINS:
247		case QB_OPERATOR::NOT_CONTAINS:
248	1	$value = '%' . $value . '%';
249	1	break;
250
251		case QB_OPERATOR::ENDS_WITH:
252		case QB_OPERATOR::NOT_ENDS_WITH:
253	1	$value = '%' . $value;
254	1	break;
255		default:
256		throw new InvalidArgumentException("Unhandled operator: " . $operator);
257		}
258		}
259	2	$param = $this->createParameter($field .'_cond', $value);
260	2	$expression->setParam1($param);
261		}
262
263	5	return $expression;
264		}
265
266	2	public function registerSelect(string $field) : void
267		{
268	2	if(!$this->isSelected($field)) {
269	1	$this->addSelect($field);
270		}
271		}
272
273	3	public function registerJoin(string $field) : void
274		{
275	3	if(!$this->hasJoin($field)) {
276	2	$attribute = $this->getAttribute($field);
277	2	$table = ATTR_TYPE::valueTable(ATTR_TYPE::getCase($attribute[_ATTR::TYPE]));
278	1	$attributeKey = $attribute[_ATTR::ID];
279	1	$this->addJoin($table, $field, $attributeKey);
280		}
281		}
282
283	3	public function handleRule(array $rule) : Expression
284		{
285	3	$field = $rule[QB_CONFIG::NAME];
286	3	$operator = QB_OPERATOR::getCase($rule[QB_CONFIG::OPERATOR]);
287	2	$value = key_exists(QB_CONFIG::VALUE, $rule)
288	1	? $rule[QB_CONFIG::VALUE]
289	1	: new ValueEmpty();
290
291	2	$this->registerSelect($field);
292	2	$this->registerJoin($field);
293
294	2	return $this->createExpression($field, $operator, $value);
295		}
296
297	2	public function parse(array $config) : void
298		{
299	2	if(empty($config))
300	1	return;
301
302	1	$this->expressions = $this->handleGroup($config);
303		}
304
305		}

kuperwood / eav

Push — master ( 0272f5...3a0c5f )

Config::createParameter() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like