QueryBuilder::getQuery() - Code Metrics - Inspection of "Pass arguments directly to the database join metho..." - cycle/orm - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 2.x (#447)

by Maxim

created 2023-12-07 13:11 UTC

QueryBuilder::getQuery() A

↳ Parent: QueryBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Cycle\ORM\Select;

use Closure;
use Cycle\ORM\Exception\BuilderException;
use JetBrains\PhpStorm\ExpectedValues;
use Cycle\Database\Driver\Compiler;
use Cycle\Database\Query\SelectQuery;

/**
 * Mocks SelectQuery and automatically resolves identifiers for the loaded relations.
 *
 * @method QueryBuilder distinct()
 * @method QueryBuilder where(...$args);
 * @method QueryBuilder andWhere(...$args);
 * @method QueryBuilder orWhere(...$args);
 * @method QueryBuilder having(...$args);
 * @method QueryBuilder andHaving(...$args);
 * @method QueryBuilder orHaving(...$args);
 * @method QueryBuilder orderBy($expression, $direction = 'ASC');
 * @method QueryBuilder limit(int $limit)
 * @method QueryBuilder offset(int $offset)
 * @method QueryBuilder forUpdate()
 * @method QueryBuilder whereJson(string $path, mixed $value)
 * @method QueryBuilder orWhereJson(string $path, mixed $value)
 * @method QueryBuilder whereJsonContains(string $path, mixed $value, bool $encode = true, bool $validate = true)
 * @method QueryBuilder orWhereJsonContains(string $path, mixed $value, bool $encode = true, bool $validate = true)
 * @method QueryBuilder whereJsonDoesntContain(string $path, mixed $value, bool $encode = true, bool $validate = true)
 * @method QueryBuilder orWhereJsonDoesntContain(string $path, mixed $value, bool $encode = true, bool $validate = true)
 * @method QueryBuilder whereJsonContainsKey(string $path)
 * @method QueryBuilder orWhereJsonContainsKey(string $path)
 * @method QueryBuilder whereJsonDoesntContainKey(string $path)
 * @method QueryBuilder orWhereJsonDoesntContainKey(string $path)
 * @method QueryBuilder whereJsonLength(string $path, int $length, string $operator = '=')
 * @method QueryBuilder orWhereJsonLength(string $path, int $length, string $operator = '=')
 * @method int avg($identifier) Perform aggregation (AVG) based on column or expression value.
 * @method int min($identifier) Perform aggregation (MIN) based on column or expression value.
 * @method int max($identifier) Perform aggregation (MAX) based on column or expression value.
 * @method int sum($identifier) Perform aggregation (SUM) based on column or expression value.
 */
final class QueryBuilder
{
    private ?string $forward = null;

    public function __construct(
        private SelectQuery $query,
        /** @internal */
        private AbstractLoader $loader
    ) {
    }

    /**
     * Forward call to underlying target.
     *
     * @return mixed|SelectQuery
     */
    public function __call(string $func, array $args)
    {
        $result = \call_user_func_array(
            $this->targetFunc($func),
            $this->isJoin($func) ? $args : $this->proxyArgs($args)
        );

        if ($result === $this->query) {
            return $this;
        }

        return $result;
    }

    /**
     * Get currently associated query. Immutable.
     */
    public function getQuery(): ?SelectQuery
    {
        return clone $this->query;
    }

    /**
     * Access to underlying loader. Immutable.
     */
    public function getLoader(): AbstractLoader
    {
        return clone $this->loader;
    }

    /**
     * Select query method prefix for all "where" queries. Can route "where" to "onWhere".
     */
    public function withForward(
        #[ExpectedValues(values: ['where', 'onWhere'])]
        string $forward = null
    ): self {
        $builder = clone $this;
        $builder->forward = $forward;

        return $builder;
    }

    public function withQuery(SelectQuery $query): self
    {
        $builder = clone $this;
        $builder->query = $query;

        return $builder;
    }

    /**
     * Resolve given object.field identifier into proper table alias and column name.
     * Attention, calling this method would not affect loaded relations, you must call with/load directly!
     *
     * Use this method for complex relation queries in combination with Expression()
     *
     * @param bool $autoload If set to true (default) target relation will be automatically loaded.
     *
     * @throws BuilderException
     */
    public function resolve(string $identifier, bool $autoload = true): string
    {
        if ($identifier === '*') {
            return '*';
        }

        if (!\str_contains($identifier, '.')) {
            $current = $this->loader;

            do {
                $column = $current->fieldAlias($identifier);

                // Find an inheritance parent that has this field
                if ($column === null) {
                    $parent = $current->getParentLoader();
                    if ($parent !== null) {
                        $current = $parent;
                        continue;
                    }
                }

                return \sprintf('%s.%s', $current->getAlias(), $column ?? $identifier);
            } while (true);
        }

        $split = \strrpos($identifier, '.');

        $loader = $this->findLoader(\substr($identifier, 0, $split), $autoload);
        if ($loader !== null) {
            $identifier = \substr($identifier, $split + 1);
            return \sprintf(
                '%s.%s',
                $loader->getAlias(),
                $loader->fieldAlias($identifier) ?? $identifier,
            );
        }

        return $identifier;
    }

    /**
     * Join relation without loading it's data.
     */
    public function with(string $relation, array $options = []): self
    {
        $this->loader->loadRelation($relation, $options, true, false);

        return $this;
    }

    /**
     * Find loader associated with given entity/relation alias.
     *
     * @param bool $autoload When set to true relation will be automatically loaded.
     */
    private function findLoader(string $name, bool $autoload = true): ?LoaderInterface
    {
        if (strpos($name, '(')) {
            // expressions are not allowed
            return null;
        }

        if ($name == '' || $name == '@' || $name == $this->loader->getTarget() || $name == $this->loader->getAlias()) {
            return $this->loader;
        }

        $loader = $autoload ? $this->loader : clone $this->loader;

        return $loader->loadRelation($name, [], true);
    }

    /**
     * Replace target where call with another compatible method (for example join or having).
     */
    private function targetFunc(string $call): callable
    {
        if ($this->forward != null) {

            switch (strtolower($call)) {
                case 'where':
                    $call = $this->forward;
                    break;
                case 'orwhere':
                    $call = 'or' . ucfirst($this->forward);
                    break;
                case 'andwhere':
                    $call = 'and' . ucfirst($this->forward);
                    break;
            }
        }

        return [$this->query, $call];
    }

    /**
     * Automatically modify all identifiers to mount table prefix. Provide ability to automatically resolve
     * relations.
     */
    private function proxyArgs(array $args): array
    {
        if (!isset($args[0])) {
            return $args;
        }

        if (\is_string($args[0])) {
            $args[0] = $this->resolve($args[0]);
        }

        if (\is_array($args[0])) {
            $args[0] = $this->walkRecursive($args[0], [$this, 'wrap']);
        }

        if ($args[0] instanceof Closure) {
            $args[0] = function ($q) use ($args): void {
                $args[0]($this->withQuery($q));
            };
        }

        return $args;
    }

    /**
     * Automatically resolve identifier value or wrap the expression.
     *
     * @param mixed $value
     */
    private function wrap(int|string &$identifier, &$value): void
    {
        if (!\is_numeric($identifier)) {
            $identifier = $this->resolve($identifier);
        }

        if ($value instanceof Closure) {
            $value = function ($q) use ($value): void {
                $value($this->withQuery($q));
            };
        }
    }

    /**
     * Walk through method arguments using given function.
     */
    private function walkRecursive(array $input, callable $func, bool $complex = false): array
    {
        $result = [];
        foreach ($input as $k => $v) {
            if (\is_array($v)) {
                if (!\is_numeric($k) && \in_array(\strtoupper($k), [Compiler::TOKEN_AND, Compiler::TOKEN_OR], true)) {
                    // complex expression like @OR and @AND
                    $result[$k] = $this->walkRecursive($v, $func, true);
                    continue;
                }

                if ($complex) {
                    $v = $this->walkRecursive($v, $func);
                }
            }

            $func(...[&$k, &$v]);
            $result[$k] = $v;
        }

        return $result;
    }

    private function isJoin(string $method): bool
    {
        return \in_array($method, ['join', 'innerJoin', 'rightJoin', 'leftJoin', 'fullJoin'], true);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Cycle\ORM\Select;
6
7		use Closure;
8		use Cycle\ORM\Exception\BuilderException;
9		use JetBrains\PhpStorm\ExpectedValues;
10		use Cycle\Database\Driver\Compiler;
11		use Cycle\Database\Query\SelectQuery;
12
13		/**
14		* Mocks SelectQuery and automatically resolves identifiers for the loaded relations.
15		*
16		* @method QueryBuilder distinct()
17		* @method QueryBuilder where(...$args);
18		* @method QueryBuilder andWhere(...$args);
19		* @method QueryBuilder orWhere(...$args);
20		* @method QueryBuilder having(...$args);
21		* @method QueryBuilder andHaving(...$args);
22		* @method QueryBuilder orHaving(...$args);
23		* @method QueryBuilder orderBy($expression, $direction = 'ASC');
24		* @method QueryBuilder limit(int $limit)
25		* @method QueryBuilder offset(int $offset)
26		* @method QueryBuilder forUpdate()
27		* @method QueryBuilder whereJson(string $path, mixed $value)
28		* @method QueryBuilder orWhereJson(string $path, mixed $value)
29		* @method QueryBuilder whereJsonContains(string $path, mixed $value, bool $encode = true, bool $validate = true)
30		* @method QueryBuilder orWhereJsonContains(string $path, mixed $value, bool $encode = true, bool $validate = true)
31		* @method QueryBuilder whereJsonDoesntContain(string $path, mixed $value, bool $encode = true, bool $validate = true)
32		* @method QueryBuilder orWhereJsonDoesntContain(string $path, mixed $value, bool $encode = true, bool $validate = true)
33		* @method QueryBuilder whereJsonContainsKey(string $path)
34		* @method QueryBuilder orWhereJsonContainsKey(string $path)
35	6834	* @method QueryBuilder whereJsonDoesntContainKey(string $path)
36		* @method QueryBuilder orWhereJsonDoesntContainKey(string $path)
37		* @method QueryBuilder whereJsonLength(string $path, int $length, string $operator = '=')
38		* @method QueryBuilder orWhereJsonLength(string $path, int $length, string $operator = '=')
39		* @method int avg($identifier) Perform aggregation (AVG) based on column or expression value.
40		* @method int min($identifier) Perform aggregation (MIN) based on column or expression value.
41		* @method int max($identifier) Perform aggregation (MAX) based on column or expression value.
42		* @method int sum($identifier) Perform aggregation (SUM) based on column or expression value.
43		*/
44		final class QueryBuilder
45		{
46		private ?string $forward = null;
47	6044
48		public function __construct(
49	6044	private SelectQuery $query,
50	6044	/** @internal */
51	6028	private AbstractLoader $loader
52		) {
53		}
54	72
55		/**
56		* Forward call to underlying target.
57		*
58		* @return mixed\|SelectQuery
59		*/
60	744	public function __call(string $func, array $args)
61		{
62	744	$result = \call_user_func_array(
63		$this->targetFunc($func),
64		$this->isJoin($func) ? $args : $this->proxyArgs($args)
65		);
66
67		if ($result === $this->query) {
68		return $this;
69		}
70
71		return $result;
72		}
73
74		/**
75		* Get currently associated query. Immutable.
76	1016	*/
77		public function getQuery(): ?SelectQuery
78		{
79		return clone $this->query;
80	1016	}
81	1016
82		/**
83	1016	* Access to underlying loader. Immutable.
84		*/
85		public function getLoader(): AbstractLoader
86	520	{
87		return clone $this->loader;
88	520	}
89	520
90		/**
91	520	* Select query method prefix for all "where" queries. Can route "where" to "onWhere".
92		*/
93		public function withForward(
94		#[ExpectedValues(values: ['where', 'onWhere'])]
95		string $forward = null
96		): self {
97		$builder = clone $this;
98		$builder->forward = $forward;
99
100		return $builder;
101		}
102
103		public function withQuery(SelectQuery $query): self
104	5298	{
105		$builder = clone $this;
106	5298	$builder->query = $query;
107	24
108		return $builder;
109		}
110	5298
111		/**
112	2514	* Resolve given object.field identifier into proper table alias and column name.
113		* Attention, calling this method would not affect loaded relations, you must call with/load directly!
114	2514	*
115	2514	* Use this method for complex relation queries in combination with Expression()
116		*
117		* @param bool $autoload If set to true (default) target relation will be automatically loaded.
118		*
119	4176	* @throws BuilderException
120		*/
121	4176	public function resolve(string $identifier, bool $autoload = true): string
122	4176	{
123	4160	if ($identifier === '*') {
124		return '*';
125	4160	}
126	4160
127		if (!\str_contains($identifier, '.')) {
128		$current = $this->loader;
129
130	48	do {
131		$column = $current->fieldAlias($identifier);
132
133		// Find an inheritance parent that has this field
134		if ($column === null) {
135		$parent = $current->getParentLoader();
136	8	if ($parent !== null) {
137		$current = $parent;
138	8	continue;
139		}
140	8	}
141
142		return \sprintf('%s.%s', $current->getAlias(), $column ?? $identifier);
143		} while (true);
144		}
145
146		$split = \strrpos($identifier, '.');
147
148	4176	$loader = $this->findLoader(\substr($identifier, 0, $split), $autoload);
149		if ($loader !== null) {
150	4176	$identifier = \substr($identifier, $split + 1);
151		return \sprintf(
152	48	'%s.%s',
153		$loader->getAlias(),
154		$loader->fieldAlias($identifier) ?? $identifier,
155	4160	);
156	3824	}
157
158		return $identifier;
159	376	}
160
161	376	/**
162		* Join relation without loading it's data.
163		*/
164		public function with(string $relation, array $options = []): self
165		{
166		$this->loader->loadRelation($relation, $options, true, false);
167	6044
168		return $this;
169	6044	}
170	1016
171	1016	/**
172	680	* Find loader associated with given entity/relation alias.
173	680	*
174	640	* @param bool $autoload When set to true relation will be automatically loaded.
175	8	*/
176	8	private function findLoader(string $name, bool $autoload = true): ?LoaderInterface
177	640	{
178		if (strpos($name, '(')) {
179		// expressions are not allowed
180		return null;
181		}
182
183	6044	if ($name == '' \|\| $name == '@' \|\| $name == $this->loader->getTarget() \|\| $name == $this->loader->getAlias()) {
184		return $this->loader;
185		}
186
187		$loader = $autoload ? $this->loader : clone $this->loader;
188
189		return $loader->loadRelation($name, [], true);
190	6044	}
191
192	6044	/**
193	2612	* Replace target where call with another compatible method (for example join or having).
194		*/
195		private function targetFunc(string $call): callable
196	5896	{
197	4304	if ($this->forward != null) {
		0 ignored issues – show Bug introduced 2019-02-08 11:53 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$this->forward` of type `null\|string` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `!==` instead. Loading history...
198		switch (strtolower($call)) {
199		case 'where':
200	5896	$call = $this->forward;
201	4016	break;
202		case 'orwhere':
203		$call = 'or' . ucfirst($this->forward);
204	5896	break;
205	472	case 'andwhere':
206	472	$call = 'and' . ucfirst($this->forward);
207		break;
208		}
209		}
210	5896
211		return [$this->query, $call];
212		}
213
214		/**
215		* Automatically modify all identifiers to mount table prefix. Provide ability to automatically resolve
216		* relations.
217		*/
218	2306	private function proxyArgs(array $args): array
219		{
220	2306	if (!isset($args[0])) {
221	2306	return $args;
222		}
223
224	2306	if (\is_string($args[0])) {
225		$args[0] = $this->resolve($args[0]);
226		}
227
228		if (\is_array($args[0])) {
229		$args[0] = $this->walkRecursive($args[0], [$this, 'wrap']);
230		}
231
232		if ($args[0] instanceof Closure) {
233		$args[0] = function ($q) use ($args): void {
234	4016	$args[0]($this->withQuery($q));
235		};
236	4016	}
237	4016
238	2306	return $args;
239	304	}
240
241	16	/**
242	16	* Automatically resolve identifier value or wrap the expression.
243		*
244	304	* @param mixed $value
245	16	*/
246		private function wrap(int\|string &$identifier, &$value): void
247		{
248		if (!\is_numeric($identifier)) {
249	2306	$identifier = $this->resolve($identifier);
250	2306	}
251
252		if ($value instanceof Closure) {
253	4016	$value = function ($q) use ($value): void {
254		$value($this->withQuery($q));
255		};
256		}
257		}
258
259		/**
260		* Walk through method arguments using given function.
261		*/
262		private function walkRecursive(array $input, callable $func, bool $complex = false): array
263		{
264		$result = [];
265		foreach ($input as $k => $v) {
266		if (\is_array($v)) {
267		if (!\is_numeric($k) && \in_array(\strtoupper($k), [Compiler::TOKEN_AND, Compiler::TOKEN_OR], true)) {
268		// complex expression like @OR and @AND
269		$result[$k] = $this->walkRecursive($v, $func, true);
270		continue;
271		}
272
273		if ($complex) {
274		$v = $this->walkRecursive($v, $func);
275		}
276		}
277
278		$func(...[&$k, &$v]);
279		$result[$k] = $v;
280		}
281
282		return $result;
283		}
284
285		private function isJoin(string $method): bool
286		{
287		return \in_array($method, ['join', 'innerJoin', 'rightJoin', 'leftJoin', 'fullJoin'], true);
288		}
289		}
290

cycle / orm

Pull Request — 2.x (#447)

QueryBuilder::getQuery() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like