scrnhq / laravel-bakery

src/Traits/SearchesQueries.php

<?php

namespace Bakery\Traits;

use Bakery\Support\Arguments;
use Bakery\Eloquent\ModelSchema;
use Bakery\Support\TypeRegistry;
use Illuminate\Support\Facades\DB;
use Illuminate\Database\Connection;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Query\Grammars;
use Illuminate\Database\Eloquent\Builder;

/**
 * @property ModelSchema $modelSchema
 * @property TypeRegistry $registry
 */
trait SearchesQueries
{
    /**
     * Apply search on the query.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param Arguments $args
     * @return Builder
     */
    protected function applySearch(Builder $query, Arguments $args)
    {
        // If the query is empty, we don't need to perform any search.
        if (empty($args['query'])) {
            return $query;
        }

        /** @var Connection $connection */
        $connection = DB::connection();

        $this->tsFields = [];

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

        $needle = $args['query'];
        $fields = $args['fields'];

        $relations = $this->modelSchema->getRelationFields();
        $qualifiedNeedle = preg_quote($needle);

        foreach ($fields as $key => $value) {
            $field = $this->modelSchema->getFieldByKey($key);
            $accessor = $field->getAccessor();
            if ($relations->keys()->contains($key)) {
                $this->applyRelationalSearch($query, $this->model, $accessor, $needle, $value->toArray());

The property model does not exist on Bakery\Traits\SearchesQueries. Did you mean modelSchema?

It seems like $needle can also be of type null; however, parameter $needle of Bakery\Traits\SearchesQueries::applyRelationalSearch() does only seem to accept string, maybe add an additional type check?

            } else {
                $this->tsFields[] = $this->model->getTable().'.'.$accessor;
            }
        }

        if (empty($needle) || empty($this->tsFields)) {
            return $query;
        }

        $grammar = $connection->getQueryGrammar();

        if ($grammar instanceof Grammars\PostgresGrammar) {
            $dictionary = config('bakery.postgresDictionary');
            $fields = implode(', ', $this->tsFields);
            $query->whereRaw("to_tsvector('${dictionary}', concat_ws(' ', ".$fields.")) @@ to_tsquery('${dictionary}', ?)",
                ["'{$qualifiedNeedle}':*"]);
        }

        return $query;
    }

    /**
     * Apply a relational search.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param \Illuminate\Database\Eloquent\Model $model
     * @param string $relation
     * @param string $needle
     * @param array $fields
     */
    protected function applyRelationalSearch(
        Builder $query,
        Model $model,
        string $relation,
        string $needle,
        array $fields
    ) {
        /** @var \Illuminate\Database\Eloquent\Relations\Relation $relation */
        $relation = $model->$relation();
        $related = $relation->getRelated();
        $this->joinRelation($query, $relation, 'left');

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

        foreach ($fields as $key => $value) {
            $schema = $this->registry->getSchemaForModel($related);

            $relations = $schema->getRelationFields();
            if ($relations->keys()->contains($key)) {
                $this->applyRelationalSearch($query, $related, $key, $needle, $value);
            } else {
                $this->tsFields[] = $related->getTable().'.'.$key;

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

            }
        }
    }
}