CompilesWhereClauses::translateOperator() - Code Metrics - Inspection of "Feature/subqueries (#42)" - LaravelFreelancerNL/laravel-arangodb - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( ef1328...91a1d1 )

by Bas
created 2021-01-31 17:22 UTC
CompilesWhereClauses::translateOperator() A

↳ Parent: CompilesWhereClauses
Complexity

Conditions	2
Paths	2
Size

Total Lines	7
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	4
CRAP Score	2
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	2
eloc	3
nc	2
nop	1
dl	0
loc	7
ccs	4
cts	4
cp	1
crap	2
rs	10
c	1
b	0
f	0
<?php

namespace LaravelFreelancerNL\Aranguent\Query\Concerns;

use Illuminate\Database\Query\Builder as IluminateBuilder;
use Illuminate\Database\Query\Expression;
use Illuminate\Database\Query\JoinClause;
use LaravelFreelancerNL\Aranguent\Query\Builder;

trait CompilesWhereClauses
{
    /**
     * Compile the "where" portions of the query.
     *
     * @param Builder $builder
     *
     * @return Builder
     */
    protected function compileWheres(Builder $builder)
    {
        if (is_null($builder->wheres)) {

            return $builder;
        }

        $predicates = $this->compileWheresToArray($builder);

        if (count($predicates) > 0) {
            $builder->aqb = $builder->aqb->filter($predicates);
        }

        return $builder;
    }

    /**
     * Get an array of all the where clauses for the query.
     *
     * @param  IluminateBuilder  $query
     * @return array
     */
    protected function compileWheresToArray(IluminateBuilder $query): array
    {
        return collect($query->wheres)->map(function ($where) use ($query) {
            return $this->{"where{$where['type']}"}($query, $where);
        })->all();
    }

    protected function getOperatorByWhereType($type)
    {
        if (isset($this->whereTypeOperators[$type])) {
            return $this->whereTypeOperators[$type];
        }

        return '==';
    }

    /**
     * Determine if the given value is a raw expression.
     *
     * @param  mixed  $value
     * @return bool
     */
    public function isExpression($value)
    {
        return $value instanceof Expression;
    }

    /**
     * Get the appropriate query parameter place-holder for a value.
     *
     * @param  IluminateBuilder  $query
     * @param  mixed  $value
     * @return object
     */
    public function parameter(IluminateBuilder $query, $value)
    {
        return $this->isExpression($value) ? $this->getValue($value) : $query->aqb->bind($value);
        return $this->isExpression($value) ? $this->/** @scrutinizer ignore-call */ getValue($value) : $query->aqb->bind($value);
    }

    protected function normalizeOperator($where)
    {
        if (isset($where['operator'])) {
            $where['operator'] = $this->translateOperator($where['operator']);
        }
        if (! isset($where['operator'])) {
            $where['operator'] = $this->getOperatorByWhereType($where['type']);
        }

            return $where;
    }

    /**
     * Translate sql operators to their AQL equivalent where possible.
     *
     * @param string $operator
     *
     * @return mixed|string
     */
    private function translateOperator(string $operator)
    {
        if (isset($this->operatorTranslations[strtolower($operator)])) {
            $operator = $this->operatorTranslations[$operator];
        }

        return $operator;
    }


    /**
     * Compile a basic where clause.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return array
     */
    protected function whereBasic(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $where = $this->normalizeOperator($where);

        $predicate[0] = $this->normalizeColumn($query, $where['column']);
        $predicate[0] = $this->normalizeColumn($query, $where['column']);
        $predicate[1] = $where['operator'];
        $predicate[2] = $this->parameter($query, $where['value']);
        $predicate[3] = $where['boolean'];

        return $predicate;
    }

    /**
     * Compile a "between" where clause.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return string
     */
    protected function whereBetween(IluminateBuilder $query, $where)
    {
        $predicate = [];

        [$minOperator, $maxOperator, $boolean] = $this->getBetweenOperators($where['not']);

        $min = $this->parameter($query, reset($where['values']));

        $max = $this->parameter($query, end($where['values']));

        $predicate[0][0] = $this->normalizeColumn($query, $where['column']);
        $predicate[0][1] = $minOperator;
        $predicate[0][2] = $min;
        $predicate[0][3] = $where['boolean'];

        $predicate[1][0] = $this->normalizeColumn($query, $where['column']);
        $predicate[1][1] = $maxOperator;
        $predicate[1][2] = $max;
        $predicate[1][3] = $boolean;

        return $predicate;

    }

    /**
     * Generate operators for between and 'not between'
     * @param  bool  $notBetween
     * @return string[]
     */
    protected function getBetweenOperators(bool $notBetween)
    {
        $minOperator = '>=';
        $maxOperator = '<=';
        $boolean = 'AND';

        if ($notBetween) {
            $minOperator = '<';
            $maxOperator = '>';
            $boolean = 'OR';
        }

        return [$minOperator, $maxOperator, $boolean];
    }

    /**
     * Compile a "between" where clause.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return string
     */
    protected function whereBetweenColumns(IluminateBuilder $query, $where)
    {
        $predicate = [];

        [$minOperator, $maxOperator, $boolean] = $this->getBetweenOperators($where['not']);

        $column = $this->normalizeColumn($query, $where['column']);

        $predicate[0][0] = $column;
        $predicate[0][1] = $minOperator;
        $predicate[0][2] = $this->normalizeColumn($query, reset($where['values']));
        $predicate[0][3] = $where['boolean'];

        $predicate[1][0] = $column;
        $predicate[1][1] = $maxOperator;
        $predicate[1][2] = $this->normalizeColumn($query, end($where['values']));
        $predicate[1][3] = $boolean;

        return $predicate;

    }


    /**
     * Compile a where clause comparing two columns..
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return string
     */
    protected function whereColumn(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $where = $this->normalizeOperator($where);

        $predicate[0] = $this->normalizeColumn($query, $where['first']);
        $predicate[1] = $where['operator'];
        $predicate[2] = $this->normalizeColumn($query, $where['second']);
        $predicate[3] = $where['boolean'];

        return $predicate;

    }

    /**
     * Compile a "where null" clause.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return string
     */
    protected function whereNull(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $predicate[0] = $this->normalizeColumn($query, $where['column']);
        $predicate[1] = '==';
        $predicate[2] = null;
        $predicate[3] = $where['boolean'];

        return $predicate;

    }

    /**
     * Compile a "where not null" clause.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return string
     */
    protected function whereNotNull(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $predicate[0] = $this->normalizeColumn($query, $where['column']);
        $predicate[1] = '!=';
        $predicate[2] = null;
        $predicate[3] = $where['boolean'];

        return $predicate;

    }

    /**
     * Compile a "where in" clause.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return string
     */
    protected function whereIn(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $predicate[0] = $this->normalizeColumn($query, $where['column']);
        $predicate[1] = 'IN';
        $predicate[2] = $this->parameter($query, $where['values']);
        $predicate[3] = $where['boolean'];

        return $predicate;

    }

    /**
     * Compile a "where in raw" clause.
     *
     * For safety, whereIntegerInRaw ensures this method is only used with integer values.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return string
     */
    protected function whereInRaw(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $predicate[0] = $this->normalizeColumn($query, $where['column']);
        $predicate[1] = 'IN';
        $predicate[2] = '[' . implode(', ', $where['values']) . ']';
        $predicate[3] = $where['boolean'];

        return $predicate;

    }

    /**
     * Compile a "where not in" clause.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return string
     */
    protected function whereNotIn(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $predicate[0] = $this->normalizeColumn($query, $where['column']);
        $predicate[1] = 'NOT IN';
        $predicate[2] = $this->parameter($query, $where['values']);
        $predicate[3] = $where['boolean'];

        return $predicate;

    }

    /**
     * Compile a "where not in raw" clause.
     *
     * For safety, whereIntegerInRaw ensures this method is only used with integer values.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return string
     */
    protected function whereNotInRaw(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $predicate[0] = $this->normalizeColumn($query, $where['column']);
        $predicate[1] = 'NOT IN';
        $predicate[2] = '[' . implode(', ', $where['values']) . ']';
        $predicate[3] = $where['boolean'];
        return $predicate;

    }

    /**
     * Compile a "whereJsonContains" clause.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return string
     */
    protected function whereJsonContains(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $operator = $where['not'] ? 'NOT IN' : 'IN';

        $predicate[0] = $query->aqb->bind($where['value']);
        $predicate[1] = $operator;
        $predicate[2] = $this->normalizeColumn($query, $where['column']);
        $predicate[3] = $where['boolean'];

        return $predicate;

    }

    /**
     * Compile a "whereJsonContains" clause.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return array
     */
    protected function whereJsonLength(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $where = $this->normalizeOperator($where);

        $column = $this->normalizeColumn($query, $where['column']);

        $predicate[0] = $query->aqb->length($column);
        $predicate[1] = $where['operator'];
        $predicate[2] = $this->parameter($query, $where['value']);
        $predicate[3] = $where['boolean'];

        return $predicate;
    }


    /**
     * Compile a where date clause.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return array
     */
    protected function whereDate(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $where = $this->normalizeOperator($where);

        $predicate[0] = $query->aqb->dateFormat($this->normalizeColumn($query, $where['column']), "%yyyy-%mm-%dd");
        $predicate[1] = $where['operator'];
        $predicate[2] = $this->parameter($query, $where['value']);
        $predicate[3] = $where['boolean'];

        return $predicate;
    }

    /**
     * Compile a where year clause.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return array
     */
    protected function whereYear(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $where = $this->normalizeOperator($where);

        $predicate[0] = $query->aqb->dateYear($this->normalizeColumn($query, $where['column']));
        $predicate[1] = $where['operator'];
        $predicate[2] = $this->parameter($query, $where['value']);
        $predicate[3] = $where['boolean'];

        return $predicate;
    }

    /**
     * Compile a where month clause.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return array
     */
    protected function whereMonth(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $where = $this->normalizeOperator($where);

        $predicate[0] = $query->aqb->dateMonth($this->normalizeColumn($query, $where['column']));
        $predicate[1] = $where['operator'];
        $predicate[2] = $this->parameter($query, $where['value']);
        $predicate[3] = $where['boolean'];

        return $predicate;
    }


    /**
     * Compile a where day clause.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return array
     */
    protected function whereDay(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $where = $this->normalizeOperator($where);

        $predicate[0] = $query->aqb->dateDay($this->normalizeColumn($query, $where['column']));
        $predicate[1] = $where['operator'];
        $predicate[2] = $this->parameter($query, $where['value']);
        $predicate[3] = $where['boolean'];

        return $predicate;
    }

    /**
     * Compile a where time clause.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return array
     */
    protected function whereTime(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $where = $this->normalizeOperator($where);

        $predicate[0] = $query->aqb->dateFormat($this->normalizeColumn($query, $where['column']), "%hh:%ii:%ss");
        $predicate[1] = $where['operator'];
        $predicate[2] = $this->parameter($query, $where['value']);
        $predicate[3] = $where['boolean'];

        return $predicate;
    }

    /**
     * Compile a nested where clause.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return string
     */
    protected function whereNested(IluminateBuilder $query, $where)
    {
        $predicates = [];

        $predicates = $this->compileWheresToArray($where['query']);

        $query->aqb->binds = array_merge($query->aqb->binds, $where['query']->aqb->binds);
        $query->aqb->collections = array_merge_recursive($query->aqb->collections, $where['query']->aqb->collections);

        return $predicates;

    }

    /**
     * Compile a where condition with a sub-select.
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return string
     */
    protected function whereSub(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $where = $this->normalizeOperator($where);

        $predicate[0] = $this->normalizeColumn($query, $where['column']);
        $predicate[1] = $where['operator'];
        $predicate[2] = $where['query']->aqb;
        $predicate[3] = $where['boolean'];

        return $predicate;

    }

    /**
     * Compile a where exists clause.
     *
     *  @SuppressWarnings(PHPMD.UnusedFormalParameter)
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return string
     */
    protected function whereExists(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $predicate[0] = $where['query']->aqb;
        $predicate[1] = $where['operator'];
        $predicate[2] = $where['value'];
        $predicate[3] = $where['boolean'];

        return $predicate;

    }

    /**
     * Compile a where exists clause.
     *
     *  @SuppressWarnings(PHPMD.UnusedFormalParameter)
     *
     * @param  IluminateBuilder  $query
     * @param  array  $where
     * @return string
     */
    protected function whereNotExists(IluminateBuilder $query, $where)
    {
        $predicate = [];

        $predicate[0] = $where['query']->aqb;
        $predicate[1] = $where['operator'];
        $predicate[2] = $where['value'];
        $predicate[3] = $where['boolean'];

        return $predicate;

    }
}

LaravelFreelancerNL / laravel-arangodb

Push — master ( ef1328...91a1d1 )

CompilesWhereClauses::translateOperator() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
