Refactor + docs

Author: pascalbaljet

src/ModelToSearchThrough.php

@@ -0,0 +1,122 @@
+<?php declare(strict_types=1);
+
+namespace ProtoneMedia\LaravelCrossEloquentSearch;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Str;
+
+class ModelToSearchThrough
+{
+    /**
+     * Builder to search through.
+     */
+    private Builder $builder;
+
+    /**
+     * The columns to search through.
+     */
+    private Collection $columns;
+
+    /**
+     * Order column.
+     */
+    private string $orderByColumn;
+
+    /**
+     * Unique key of this instance.
+     */
+    private int $key;
+
+    /**
+     * @param \Illuminate\Database\Eloquent\Builder $builder
+     * @param \Illuminate\Support\Collection $columns
+     * @param string $orderByColumn
+     * @param integer $key
+     */
+    public function __construct(Builder $builder, Collection $columns, string $orderByColumn, int $key)
+    {
+        $this->builder       = $builder;
+        $this->columns       = $columns;
+        $this->orderByColumn = $orderByColumn;
+        $this->key           = $key;
+    }
+
+    /**
+     * Get a cloned instance of the builder.
+     *
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function getFreshBuilder(): Builder
+    {
+        return clone $this->builder;
+    }
+
+    /**
+     * Get a collection with all qualified columns
+     * to search through.
+     *
+     * @return \Illuminate\Support\Collection
+     */
+    public function getQualifiedColumns(): Collection
+    {
+        return $this->columns->map(fn ($column) => $this->qualifyColumn($column));
+    }
+
+    /**
+     * Get the model instance being queried.
+     *
+     * @return \Illuminate\Database\Eloquent\Model
+     */
+    private function getModel(): Model
+    {
+        return $this->builder->getModel();
+    }
+
+    /**
+     * Generates a key for the model with a suffix.
+     *
+     * @param string $suffix
+     * @return string
+     */
+    public function getModelKey($suffix = 'key'): string
+    {
+        return implode('_', [
+            $this->key,
+            Str::snake(class_basename($this->getModel())),
+            $suffix,
+        ]);
+    }
+
+    /**
+     * Qualify a column by the model instance.
+     *
+     * @param string $column
+     * @return string
+     */
+    private function qualifyColumn(string $column): string
+    {
+        return $this->getModel()->qualifyColumn($column);
+    }
+
+    /**
+     * Get the qualified key name.
+     *
+     * @return string
+     */
+    public function getQualifiedKeyName(): string
+    {
+        return $this->qualifyColumn($this->getModel()->getKeyName());
+    }
+
+    /**
+     * Get the qualified order name.
+     *
+     * @return string
+     */
+    public function getQualifiedOrderByColumnName(): string
+    {
+        return $this->qualifyColumn($this->orderByColumn);
+    }
+}

src/PendingQuery.php

@@ -6,6 +6,9 @@
 
 class Search extends Facade
 {
+    /**
+     * {@inheritdoc}
+     */
     protected static function getFacadeAccessor()
     {
         return 'laravel-cross-eloquent-search';

src/Search.php

@@ -9,7 +9,7 @@ class SearchFactory
     use ForwardsCalls;
 
     /**
-    * Handle dynamic method calls into the a new Searcher.
+    * Handle dynamic method calls into a new Searcher instance.
     *
     * @param  string  $method
     * @param  array  $parameters