wip

Author: pascalbaljet

src/Contracts/SearchResultContract.php

@@ -0,0 +1,44 @@
+<?php declare(strict_types=1);
+
+namespace ProtoneMedia\LaravelCrossEloquentSearch\Contracts;
+
+use Illuminate\Contracts\Pagination\LengthAwarePaginator;
+use Illuminate\Database\Eloquent\Collection as EloquentCollection;
+
+interface SearchResultContract
+{
+    /**
+     * Get the collection of search results.
+     */
+    public function items(): EloquentCollection;
+
+    /**
+     * Check if the results are paginated.
+     */
+    public function isPaginated(): bool;
+
+    /**
+     * Get the paginator instance if results are paginated.
+     */
+    public function paginator(): ?LengthAwarePaginator;
+
+    /**
+     * Get the total number of results.
+     */
+    public function total(): int;
+
+    /**
+     * Check if there are any results.
+     */
+    public function isEmpty(): bool;
+
+    /**
+     * Check if there are results.
+     */
+    public function isNotEmpty(): bool;
+
+    /**
+     * Get the number of items in the current page/collection.
+     */
+    public function count(): int;
+}

src/Contracts/SearcherContract.php

@@ -0,0 +1,121 @@
+<?php declare(strict_types=1);
+
+namespace ProtoneMedia\LaravelCrossEloquentSearch\Contracts;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Support\Collection;
+
+interface SearcherContract
+{
+    /**
+     * Add a model to search through.
+     *
+     * @param Builder|class-string $query
+     * @param string|array|Collection|null $columns
+     * @param string|null $orderByColumn
+     */
+    public function add($query, $columns = null, string $orderByColumn = null): self;
+
+    /**
+     * Add a full-text searchable model.
+     *
+     * @param Builder|class-string $query
+     * @param string|array|Collection|null $columns
+     * @param array $options
+     * @param string|null $orderByColumn
+     */
+    public function addFullText($query, $columns = null, array $options = [], string $orderByColumn = null): self;
+
+    /**
+     * Add multiple models at once.
+     *
+     * @param array $queries
+     */
+    public function addMany(array $queries): self;
+
+    /**
+     * Set the order by column for the most recently added model.
+     *
+     * @param string $orderByColumn
+     */
+    public function orderBy(string $orderByColumn): self;
+
+    /**
+     * Order results in ascending order.
+     */
+    public function orderByAsc(): self;
+
+    /**
+     * Order results in descending order.
+     */
+    public function orderByDesc(): self;
+
+    /**
+     * Order results by relevance.
+     */
+    public function orderByRelevance(): self;
+
+    /**
+     * Order results by model type.
+     *
+     * @param array|string $modelClasses
+     */
+    public function orderByModel($modelClasses): self;
+
+    /**
+     * Configure wildcard behavior.
+     */
+    public function beginWithWildcard(bool $state = true): self;
+    
+    /**
+     * Configure wildcard behavior.
+     */
+    public function endWithWildcard(bool $state = true): self;
+
+    /**
+     * Enable case-insensitive searching.
+     */
+    public function ignoreCase(bool $state = true): self;
+
+    /**
+     * Enable sounds like searching.
+     */
+    public function soundsLike(bool $state = true): self;
+
+    /**
+     * Configure term parsing.
+     */
+    public function parseTerm(bool $state = true): self;
+
+    /**
+     * Configure pagination.
+     */
+    public function paginate(int $perPage = 15, string $pageName = 'page', int $page = null): self;
+
+    /**
+     * Configure simple pagination.
+     */
+    public function simplePaginate(int $perPage = 15, string $pageName = 'page', int $page = null): self;
+
+    /**
+     * Include model type in results.
+     */
+    public function includeModelType(string $key = 'type'): self;
+
+    /**
+     * Perform the search.
+     *
+     * @return \Illuminate\Database\Eloquent\Collection|\Illuminate\Contracts\Pagination\LengthAwarePaginator
+     */
+    public function search(string $terms = null);
+
+    /**
+     * Count the search results.
+     */
+    public function count(string $terms = null): int;
+
+    /**
+     * Parse search terms.
+     */
+    public static function parseTerms(string $terms, callable $callback = null): Collection;
+}

src/DatabaseGrammarFactory.php

@@ -3,6 +3,7 @@
 namespace ProtoneMedia\LaravelCrossEloquentSearch;
 
 use Illuminate\Database\Connection;
+use ProtoneMedia\LaravelCrossEloquentSearch\Exceptions\InvalidGrammarException;
 use ProtoneMedia\LaravelCrossEloquentSearch\Grammars\MySqlSearchGrammar;
 use ProtoneMedia\LaravelCrossEloquentSearch\Grammars\SQLiteSearchGrammar;
 use ProtoneMedia\LaravelCrossEloquentSearch\Grammars\SearchGrammarInterface;
@@ -21,7 +22,7 @@ class DatabaseGrammarFactory
      *
      * @param \Illuminate\Database\Connection $connection
      * @return \ProtoneMedia\LaravelCrossEloquentSearch\Grammars\SearchGrammarInterface
-     * @throws \InvalidArgumentException
+     * @throws InvalidGrammarException
      */
     public static function make(Connection $connection): SearchGrammarInterface
     {
@@ -34,7 +35,7 @@ public static function make(Connection $connection): SearchGrammarInterface
             case 'sqlite':
                 return new SQLiteSearchGrammar($connection);
             default:
-                throw new \InvalidArgumentException("Database driver '{$driver}' is not supported for cross-eloquent search.");
+                throw InvalidGrammarException::driverNotSupported($driver);
         }
     }
 }

src/Exceptions/CrossEloquentSearchException.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace ProtoneMedia\LaravelCrossEloquentSearch\Exceptions;
+
+use Exception;
+
+abstract class CrossEloquentSearchException extends Exception
+{
+    //
+}

src/Exceptions/InvalidGrammarException.php

@@ -0,0 +1,11 @@
+<?php declare(strict_types=1);
+
+namespace ProtoneMedia\LaravelCrossEloquentSearch\Exceptions;
+
+class InvalidGrammarException extends CrossEloquentSearchException
+{
+    public static function driverNotSupported(string $driver): self
+    {
+        return new self("Database driver '{$driver}' is not supported for cross-eloquent search.");
+    }
+}

src/Exceptions/NoModelsAddedException.php

@@ -0,0 +1,11 @@
+<?php declare(strict_types=1);
+
+namespace ProtoneMedia\LaravelCrossEloquentSearch\Exceptions;
+
+class NoModelsAddedException extends CrossEloquentSearchException
+{
+    public static function make(): self
+    {
+        return new self('No models have been added to search through.');
+    }
+}

src/Exceptions/OrderByRelevanceException.php

@@ -0,0 +1,11 @@
+<?php declare(strict_types=1);
+
+namespace ProtoneMedia\LaravelCrossEloquentSearch\Exceptions;
+
+class OrderByRelevanceException extends CrossEloquentSearchException
+{
+    public static function relationColumnsNotSupported(): self
+    {
+        return new self('Cannot order by relevance when searching through relationship columns.');
+    }
+}