LaravelFreelancerNL\Aranguent\Query\Concerns\HasAliases

Complexity

Total Complexity

37

Size/Duplication

Total Lines	176
Duplicated Lines	0 %

Test Coverage

Coverage

72.21%

Importance

Changes	3
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	convertColumnId()	0	7	3
A	getTableAlias()	0	7	2
A	getColumnAlias()	0	7	2
A	replaceTableForAlias()	0	11	2
A	normalizeColumnReferences()	0	13	5
A	registerColumnAlias()	0	12	3
A	generateTableAlias()	0	3	1
A	registerTableAlias()	0	11	4
A	isTableAlias()	0	3	1
A	extractAlias()	0	11	3
B	normalizeColumn()	0	30	9
A	prefixAlias()	0	9	2

<?php

namespace LaravelFreelancerNL\Aranguent\Query\Concerns;

use Illuminate\Support\Str;
use LaravelFreelancerNL\Aranguent\Query\Builder;
use LaravelFreelancerNL\FluentAQL\Expressions\FunctionExpression;
use LaravelFreelancerNL\FluentAQL\QueryBuilder;

trait HasAliases
{
    protected $tableAliases = [];

    protected $columnAliases = [];

    /**
     * @param  string  $table
     * @param  string|null  $alias
     * @return string
     */
    public function registerTableAlias(string $table, string $alias = null): string
    {
        if ($alias == null && stripos($table, ' as ') !== false) {

It seems like you are loosely comparing $alias of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

            [$table, $alias] = explode(' as ', $table);
        }
        if ($alias == null) {

It seems like you are loosely comparing $alias of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

            $alias = $this->generateTableAlias($table);
        }
        $this->tableAliases[$table] = $alias;

        return $alias;
    }

    protected function isTableAlias(string $alias)
    {
        return in_array($alias, $this->tableAliases);
    }

    protected function getTableAlias(string $table): string|null
    {
        if (isset($this->tableAliases[$table])) {
            return $this->tableAliases[$table];
        }

        return null;
    }

    /**
     * Extract table and alias from sql alias notation (entity AS `alias`)
     *
     * @param  string  $entity
     * @return array|false|string[]
     */
    protected function extractAlias(string $entity)
    {
        $results = preg_split("/\sas\s/i", $entity);
        if (isset($results[1])) {
            $results[1] = trim($results[1], '`');
        }
        if (! isset($results[1])) {
            $results[1] = $results[0];
        }

        return $results;
    }

    protected function generateTableAlias(string $table, string $postfix = 'Doc'): string
    {
        return Str::camel(Str::singular($table)) . $postfix;
    }

    protected function replaceTableForAlias($reference): string
    {
        $referenceParts = explode('.', $reference);
        $first = array_shift($referenceParts);
        $alias = $this->getTableAlias($first);
        if ($alias == null) {

It seems like you are loosely comparing $alias of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

            $alias = $first;
        }
        array_unshift($referenceParts, $alias);

        return implode('.', $referenceParts);
    }

    protected function prefixAlias(string $target, string $value): string
    {
        $alias = $this->getTableAlias($target);

        if (Str::startsWith($value, $alias . '.')) {
            return $value;
        }

        return $alias . '.' . $value;
    }

    /**
     * @param  string  $column
     * @param  string|null  $alias
     * @return bool
     */
    public function registerColumnAlias(string $column, string $alias = null): bool
    {
        if (preg_match("/\sas\s/i", $column)) {
            [$column, $alias] = $this->extractAlias($column);
        }

        if (isset($alias)) {
            $this->columnAliases[$column] = $alias;
            return true;
        }

        return false;
    }

    protected function getColumnAlias(string $column): string|null
    {
        if (isset($this->columnAliases[$column])) {
            return $this->columnAliases[$column];
        }

        return null;
    }

    protected function normalizeColumn(Builder $builder, mixed $column, string $table = null): mixed
    {
        if ($column instanceof QueryBuilder || $column instanceof FunctionExpression) {
            return $column;
        }

        $column = $this->convertColumnId($column);

        if ((is_string($column) || is_numeric($column)) && key_exists($column, $builder->variables)) {
            return $column;
        }

        if (is_array($builder->groups) && in_array($column, $builder->groups)) {
            return $column;
        }

        if ($table == null) {

It seems like you are loosely comparing $table of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

            $table = $builder->from;
        }

        // Replace SQL JSON arrow for AQL dot
        $column = str_replace('->', '.', $column);

        $references = explode('.', $column);

        //We check for an existing alias to determine of the first reference is a table.
        // In which case we replace it with the alias.
        $references = $this->normalizeColumnReferences($references, $table);

        return implode('.', $references);
    }

    /**
     * @param array<mixed> $references
     * @return array<mixed>
     */
    protected function normalizeColumnReferences(array $references, string $table = null): array
    {
        $tableAlias = $this->getTableAlias($references[0]);
        if (isset($tableAlias)) {
            $references[0] = $tableAlias;
        }

        if ($tableAlias === null && $table != null && ! $this->isTableAlias($references[0])) {

It seems like you are loosely comparing $table of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison !== instead.

            $tableAlias = $this->generateTableAlias($table);
            array_unshift($references, $tableAlias);
        }

        return $references;
    }

    /**
     * @param array<mixed>|string $column
     * @return array<mixed>|string
     */
    protected function convertColumnId(array|string $column): array|string
    {
        if (is_string($column) || is_array($column)) {

The condition is_array($column) is always true.

            $column = $this->convertIdToKey($column);

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

        }

        return $column;
    }
}