WIP

Author: pascalbaljet

composer.json

@@ -17,7 +17,7 @@
     ],
     "require": {
         "php": "^8.0|^8.1",
-        "illuminate/support": "^8.67"
+        "illuminate/support": "^8.79"
     },
     "require-dev": {
         "mockery/mockery": "^1.3.3",

src/ModelToSearchThrough.php

@@ -29,18 +29,32 @@ class ModelToSearchThrough
      */
     protected int $key;
 
+    /**
+     * Full-text search.
+     */
+    protected bool $fullText;
+
+    /**
+     * Full-text search options
+     */
+    protected array $fullTextOptions = [];
+
     /**
      * @param \Illuminate\Database\Eloquent\Builder $builder
      * @param \Illuminate\Support\Collection $columns
      * @param string $orderByColumn
      * @param integer $key
+     * @param bool $fullText
+     * @param array $fullTextOptions
      */
-    public function __construct(Builder $builder, Collection $columns, string $orderByColumn, int $key)
+    public function __construct(Builder $builder, Collection $columns, string $orderByColumn, int $key, bool $fullText = false, array $fullTextOptions = [])
     {
-        $this->builder       = $builder;
-        $this->columns       = $columns;
-        $this->orderByColumn = $orderByColumn;
-        $this->key           = $key;
+        $this->builder         = $builder;
+        $this->columns         = $columns;
+        $this->orderByColumn   = $orderByColumn;
+        $this->key             = $key;
+        $this->fullText        = $fullText;
+        $this->fullTextOptions = $fullTextOptions;
     }
 
     /**
@@ -142,4 +156,24 @@ public function getQualifiedOrderByColumnName(): string
     {
         return $this->qualifyColumn($this->orderByColumn);
     }
+
+    /**
+     * Full-text search.
+     *
+     * @return boolean
+     */
+    public function searchFullText(): bool
+    {
+        return $this->fullText;
+    }
+
+    /**
+     * Full-text search options.
+     *
+     * @return array
+     */
+    public function fullTextOptions(): array
+    {
+        return $this->fullTextOptions;
+    }
 }

src/Searcher.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Collection as EloquentCollection;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Query\Builder as BaseBuilder;
 use Illuminate\Database\Query\Builder as QueryBuilder;
 use Illuminate\Database\Query\Grammars\MySqlGrammar;
@@ -12,7 +13,6 @@
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Str;
-use Illuminate\Database\Eloquent\Model;
 
 class Searcher
 {
@@ -56,6 +56,11 @@ class Searcher
      */
     protected bool $ignoreCase = false;
 
+    /**
+     * Raw input.
+     */
+    protected ?string $rawTerms = null;
+
     /**
      * Collection of search terms.
      */
@@ -185,6 +190,7 @@ public function includeModelType(string $key = 'type'): self
      * @param \Illuminate\Database\Eloquent\Builder|string $query
      * @param string|array|\Illuminate\Support\Collection $columns
      * @param string $orderByColumn
+     * @param bool $fullText
      * @return self
      */
     public function add($query, $columns = null, string $orderByColumn = null): self
@@ -195,7 +201,25 @@ public function add($query, $columns = null, string $orderByColumn = null): self
             $builder,
             Collection::wrap($columns),
             $orderByColumn ?: $builder->getModel()->getUpdatedAtColumn(),
-            $this->modelsToSearchThrough->count()
+            $this->modelsToSearchThrough->count(),
+        );
+
+        $this->modelsToSearchThrough->push($modelToSearchThrough);
+
+        return $this;
+    }
+
+    public function addFullText($query, $columns = null, array $options = [], string $orderByColumn = null): self
+    {
+        $builder = is_string($query) ? $query::query() : $query;
+
+        $modelToSearchThrough = new ModelToSearchThrough(
+            $builder,
+            Collection::wrap($columns),
+            $orderByColumn ?: $builder->getModel()->getUpdatedAtColumn(),
+            $this->modelsToSearchThrough->count(),
+            true,
+            $options
         );
 
         $this->modelsToSearchThrough->push($modelToSearchThrough);
@@ -363,6 +387,8 @@ public function parseTerms(string $terms, callable $callback = null): Collection
      */
     protected function initializeTerms(string $terms): self
     {
+        $this->rawTerms = $terms;
+
         $terms = $this->parseTerm ? $this->parseTerms($terms) : $terms;
 
         $this->termsWithoutWildcards = Collection::wrap($terms)->filter()->map(function ($term) {
@@ -398,10 +424,19 @@ public function addSearchQueryToBuilder(Builder $builder, ModelToSearchThrough $
         }
 
         $builder->where(function (Builder $query) use ($modelToSearchThrough) {
+            if ($modelToSearchThrough->searchFullText()) {
+                return $this->addWhereTermsToQuery(
+                    $query,
+                    $modelToSearchThrough->getColumns()->map(fn ($column) => $modelToSearchThrough->qualifyColumn($column))->all(),
+                    true,
+                    $modelToSearchThrough->fullTextOptions()
+                );
+            }
+
             $modelToSearchThrough->getColumns()->each(function ($column) use ($query, $modelToSearchThrough) {
                 Str::contains($column, '.')
-                    ? $this->addNestedRelationToQuery($query, $column)
-                    : $this->addWhereTermsToQuery($query, $modelToSearchThrough->qualifyColumn($column));
+                    ? $this->addNestedRelationToQuery($query, $column, $modelToSearchThrough->searchFullText())
+                    : $this->addWhereTermsToQuery($query, $modelToSearchThrough->qualifyColumn($column), $modelToSearchThrough->searchFullText());
             });
         });
     }
@@ -432,11 +467,17 @@ private function addNestedRelationToQuery(Builder $query, string $nestedRelation
      * Adds an 'orWhere' clause to search for each term in the given column.
      *
      * @param \Illuminate\Database\Eloquent\Builder $builder
-     * @param string $column
+     * @param array|string $columns
+     * @param bool $fullText
+     * @param array $fullTextOptions
      * @return void
      */
-    private function addWhereTermsToQuery(Builder $query, string $column)
+    private function addWhereTermsToQuery(Builder $query, $column, bool $fullText = false, array $fullTextOptions = [])
     {
+        if ($fullText) {
+            return $query->orWhereFullText($column, $this->rawTerms, $fullTextOptions);
+        }
+
         $column = $this->ignoreCase ? (new MySqlGrammar)->wrap($column) : $column;
 
         $this->terms->each(function ($term) use ($query, $column) {

tests/Blog.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace ProtoneMedia\LaravelCrossEloquentSearch\Tests;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Blog extends Model
+{
+}

tests/Page.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace ProtoneMedia\LaravelCrossEloquentSearch\Tests;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Page extends Model
+{
+}

tests/create_tables.php

@@ -36,6 +36,32 @@ public function up()
             $table->date('published_at')->nullable();
             $table->timestamps();
         });
+
+        Schema::create('blogs', function (Blueprint $table) {
+            $table->bigIncrements('id');
+            $table->string('title');
+            $table->string('subtitle');
+            $table->string('body');
+
+            $table->fullText('title');
+            $table->fullText(['title', 'subtitle']);
+            $table->fullText(['title', 'subtitle', 'body']);
+
+            $table->timestamps();
+        });
+
+        Schema::create('pages', function (Blueprint $table) {
+            $table->bigIncrements('id');
+            $table->string('title');
+            $table->string('subtitle');
+            $table->string('body');
+
+            $table->fullText('title');
+            $table->fullText(['title', 'subtitle']);
+            $table->fullText(['title', 'subtitle', 'body']);
+
+            $table->timestamps();
+        });
     }
     /**
      * Reverse the migrations.