Cycle\ORM\Select\QueryBuilder

Complexity

Total Complexity

38

Size/Duplication

Total Lines	268
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getQuery()	0	3	1
A	getLoader()	0	3	1
A	withForward()	0	6	1
A	__construct()	0	5	1
A	withQuery()	0	6	1
A	__call()	0	8	2
A	resolve()	0	27	4
B	findLoader()	0	14	7
A	proxyArgs()	0	21	5
A	wrap()	0	9	3
A	with()	0	5	1
A	walkRecursive()	0	19	6
A	targetFunc()	0	17	5

<?php
/**
 * Cycle DataMapper ORM
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */
declare(strict_types=1);

namespace Cycle\ORM\Select;

use Cycle\ORM\Exception\BuilderException;
use Cycle\ORM\ORMInterface;
use Spiral\Database\Driver\Compiler;
use Spiral\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 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
{
    /** @var ORMInterface @internal */
    private $orm;

    /** @var SelectQuery */
    private $query;

    /** @var AbstractLoader @internal */
    private $loader;

    /** @var string|null */
    private $forward;

    /**
     * @param ORMInterface   $orm
     * @param SelectQuery    $query
     * @param AbstractLoader $loader
     */
    public function __construct(ORMInterface $orm, SelectQuery $query, AbstractLoader $loader)
    {
        $this->orm = $orm;
        $this->query = $query;
        $this->loader = $loader;
    }

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

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

    /**
     * Select query method prefix for all "where" queries. Can route "where" to "onWhere".
     *
     * @param string $forward "where", "onWhere"
     * @return QueryBuilder
     */
    public function withForward(string $forward = null): self
    {
        $builder = clone $this;
        $builder->forward = $forward;

        return $builder;
    }

    /**
     * @param SelectQuery $query
     * @return QueryBuilder
     */
    public function withQuery(SelectQuery $query): self
    {
        $builder = clone $this;
        $builder->query = $query;

        return $builder;
    }

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

        return $result;
    }

    /**
     * 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 string $identifier
     * @param bool   $autoload If set to true (default) target relation will be automatically loaded.
     * @return string
     *
     * @throws BuilderException
     */
    public function resolve(string $identifier, bool $autoload = true): string
    {
        if ($identifier === '*') {
            return '*';
        }

        if (strpos($identifier, '.') === false) {
            // parent element
            return sprintf(
                '%s.%s',
                $this->loader->getAlias(),
                $this->loader->fieldAlias($identifier)
            );
        }

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

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

        return $identifier;
    }

    /**
     * Join relation without loading it's data.
     *
     * @param string $relation
     * @param array  $options
     * @return QueryBuilder
     */
    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 string $name
     * @param bool   $autoload When set to true relation will be automatically loaded.
     * @return AbstractLoader|null
     */
    protected 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).
     *
     * @param string $call
     * @return callable
     */
    protected function targetFunc(string $call): callable
    {
        if ($this->forward != null) {

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.

            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.
     *
     * @param array $args
     * @return array
     */
    protected 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] = $args[0] = function ($q) use ($args) {
                $args[0]($this->withQuery($q));
            };
        }

        return $args;
    }

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

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

    /**
     * Walk thought method arguments using given function.
     *
     * @param array    $input
     * @param callable $func
     * @param bool     $complex
     * @return array
     */
    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])) {
                    // complex expression like @OR and @AND
                    $result[$k] = $this->walkRecursive($v, $func, true);
                    continue;
                } elseif ($complex) {
                    $v = $this->walkRecursive($v, $func);
                }
            }

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

        return $result;
    }
}