LaravelFreelancerNL / laravel-arangodb

src/Query/Concerns/CompilesUnions.php

<?php

declare(strict_types=1);

namespace LaravelFreelancerNL\Aranguent\Query\Concerns;

use Illuminate\Database\Query\Builder as IlluminateBuilder;
use LaravelFreelancerNL\Aranguent\Query\Builder;

trait CompilesUnions
{
    /**
     * Compile the "union" queries attached to the main query.
     *
     * @param Builder $query
     * @param string $firstQuery
     * @return string
     */
    protected function compileUnions(IlluminateBuilder $query, $firstQuery = '')
    {
        if (!is_array($query->unions)) {
            return '';
        }

        $unionResultsId = 'union' . $query->getQueryId() . 'Results';
        $unionDocId = 'union' . $query->getQueryId() . 'Result';

        $query->registerTableAlias($unionResultsId, $unionDocId);

        $firstQuery = $this->wrapSubquery($firstQuery);

It seems like wrapSubquery() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $unions = '';

        foreach ($query->unions as $union) {
            $prefix = ($unions !== '') ? $unions : $firstQuery;
            $unions = $this->compileUnion($union, $prefix);
        }

        $aql = 'LET ' . $unionResultsId . ' = ' . $unions
            . ' FOR ' . $unionDocId . ' IN ' . $unionResultsId;

        if (!empty($query->unionOrders)) {
            $aql .= ' ' . $this->compileOrders($query, $query->unionOrders, $unionResultsId);

It seems like compileOrders() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        if ($query->unionOffset) {

The expression $query->unionOffset of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

            $aql .= ' ' . $this->compileOffset($query, $query->unionOffset);

It seems like compileOffset() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        if ($query->unionLimit) {

The expression $query->unionLimit of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

            $aql .= ' ' . $this->compileLimit($query, $query->unionLimit);

The method compileLimit() does not exist on LaravelFreelancerNL\Aranguent\Query\Concerns\CompilesUnions. Did you maybe mean compileUnion()?

        }

        if ($query->aggregate !== null) {
            $originalFrom = $query->from;
            $query->from = $unionResultsId;

            $aql .= ' ' . $this->compileAggregate($query, $query->aggregate);

It seems like compileAggregate() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $query->from = $originalFrom;

            return $aql . ' RETURN { `aggregate`: aggregateResult }';
        }

        return $aql . ' RETURN ' . $unionDocId;
    }

    /**
     * Compile a single union statement.
     *
     * @param array<mixed> $union
     * @param string $aql
     * @return string
     */
    protected function compileUnion(array $union, string $aql = '')
    {
        $unionType = $union['all'] ? 'UNION' : 'UNION_DISTINCT';

        return $unionType . '(' . $aql . ', ' . $this->wrapSubquery($union['query']->toSql()) . ')';
    }
}