LaravelFreelancerNL / laravel-arangodb

src/Query/Concerns/BuildsSearches.php

<?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;
use LaravelFreelancerNL\Aranguent\Query\Grammar;

trait BuildsSearches
{
    /**
     * Search an ArangoSearch view.
     * @param array<mixed>|string $fields
     * @param string $searchText
     * @param string|null $analyzer
     * @return IlluminateQueryBuilder
     */
    public function searchView(
        $fields,
        $searchText,
        $analyzer = null,
    ): IlluminateQueryBuilder {
        assert($this->grammar instanceof Grammar);

        if (!is_array($fields)) {
            $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 && in_array($locale, $analyzerLocales)) {
            $analyzer = 'text_' . $locale;
        }
        if (!$analyzer) {
            $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.

    }

    /**
     * Search an ArangoSearch view ith a raw search expression.
     *
     * @param Expression|string $rawSearch
     * @param array<mixed> $bindings
     * @return IlluminateQueryBuilder
     */
    public function rawSearchView(
        $rawSearch,
        $bindings = [],
    ): IlluminateQueryBuilder {
        assert($this->grammar instanceof Grammar);

        if (is_string($rawSearch)) {
            $rawSearch = new Expression($rawSearch);

$rawSearch of type string is incompatible with the type Illuminate\Database\Query\TValue expected by parameter $value of Illuminate\Database\Query\Expression::__construct().

        }

        $this->search = [

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

            'expression' => $rawSearch,
        ];

        $this->bindings['search'] = $bindings;

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

        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 . ')');

'BM25(' . $alias . ')' of type string is incompatible with the type Illuminate\Database\Query\TValue expected by parameter $value of Illuminate\Database\Query\Expression::__construct().

        $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 . ')');

'TFIDF(' . $alias . ')' of type string is incompatible with the type Illuminate\Database\Query\TValue expected by parameter $value of Illuminate\Database\Query\Expression::__construct().

        $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.

    }
}