LaravelFreelancerNL\Aranguent\Query\Concerns\BuildsSearches

Complexity

Total Complexity

6

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	searchView()	0	28	4
A	orderByBestMatching()	0	8	1
A	orderByFrequency()	0	8	1

<?php

declare(strict_types=1);

namespace LaravelFreelancerNL\Aranguent\Query\Concerns;

use Illuminate\Database\Query\Builder as IlluminateQueryBuilder;
use Illuminate\Database\Query\Expression;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\App;

trait BuildsSearches
{
    /**
     * Search an ArangoSearch view.
     */
    public function searchView(
        array|Expression|string $fields,
        string $searchText,
        string $analyzer = null
    ): IlluminateQueryBuilder {
        if(!is_array($fields)) {

The condition is_array($fields) is always true.

            $fields = Arr::wrap($fields);
        }
        $fields = $this->grammar->convertJsonFields($fields);
        $fields = $this->convertIdToKey($fields);

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

        $searchText = $this->bindValue($searchText, 'search');

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

        $locale = App::getLocale();
        $analyzerLocales = ['de','en','es','fi','fr','it','nl','no','pt','ru','sv','zh'];
        if ($analyzer === null && in_array($locale, $analyzerLocales)) {
            $analyzer = 'text_' . $locale;
        } else {
            $analyzer = 'text_en';
        }

        $this->search = [

The property search does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            'fields' => $fields,
            'searchText' => $searchText,
            'analyzer' => $analyzer
        ];

        return $this;

The expression return $this returns the type LaravelFreelancerNL\Aranguent\Query\Concerns\BuildsSearches which is incompatible with the type-hinted return Illuminate\Database\Query\Builder.

    }


    /**
     * Add an "order by best matching" clause to the query.
     * To be used with the searchView function
     *
     * @param string $direction
     *
     * @return IlluminateQueryBuilder
     */
    public function orderByBestMatching($direction = 'DESC'): IlluminateQueryBuilder
    {
        $alias = $this->getTableAlias($this->from);

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

        $column = new Expression('BM25(' . $alias . ')');

        $this->orderBy($column, $direction);

The method orderBy() does not exist on LaravelFreelancerNL\Aranguent\Query\Concerns\BuildsSearches. Did you maybe mean orderByBestMatching()?

        return $this;

The expression return $this returns the type LaravelFreelancerNL\Aranguent\Query\Concerns\BuildsSearches which is incompatible with the type-hinted return Illuminate\Database\Query\Builder.

    }

    /**
     * Add an "order by best matching" clause to the query.
     * To be used with the searchView function
     *
     * @param string $direction
     *
     * @return IlluminateQueryBuilder
     */
    public function orderByFrequency($direction = 'DESC'): IlluminateQueryBuilder
    {
        $alias = $this->getTableAlias($this->from);
        $column = new Expression('TFIDF(' . $alias . ')');

        $this->orderBy($column, $direction);

        return $this;

The expression return $this returns the type LaravelFreelancerNL\Aranguent\Query\Concerns\BuildsSearches which is incompatible with the type-hinted return Illuminate\Database\Query\Builder.

    }
}