The SearchableModel class is now deprecated, use the Searchable trait instead.

Author: babenkoivan

README.md

@@ -155,12 +155,19 @@ After executing the command you'll find the file `MyModel.php` in you `app` fold
 
 namespace App;
 
-use ScoutElastic\SearchableModel;
+use ScoutElastic\Searchable;
+use Illuminate\Database\Eloquent\Model;
 
-class MyModel extends SearchableModel
+class MyModel extends Model
 {
+    use Searchable;
+
     protected $indexConfigurator = MyIndexConfigurator::class;
 
+    protected $searchRules = [
+        //
+    ];
+
     // Here you can specify a mapping for a model fields.
     protected $mapping = [
         'properties' => [
@@ -315,10 +322,13 @@ To determine default search rules for a model just add a property:
 
 namespace App;
 
-use ScoutElastic\SearchableModel;
+use ScoutElastic\Searchable;
+use Illuminate\Database\Eloquent\Model;
 
-class MyModel extends SearchableModel
+class MyModel extends Model
 {
+    use Searchable;
+    
     // You can set several rules for one model. In this case, the first not empty result will be returned.
     protected $searchRules = [
         MySearchRule::class

src/Console/SearchableModelMakeCommand.php

@@ -43,23 +43,11 @@ protected function buildClass($name)
     {
         $stub = parent::buildClass($name);
 
-
         $indexConfigurator = $this->getIndexConfigurator();
-
-        if ($indexConfigurator) {
-            $stub = str_replace('DummyIndexConfigurator', "protected \$indexConfigurator = {$indexConfigurator}::class;", $stub);
-        } else {
-            $stub = preg_replace('#DummyIndexConfigurator\s+#', '', $stub);
-        }
-
+        $stub = str_replace('DummyIndexConfigurator', $indexConfigurator ? "{$indexConfigurator}::class" : 'null', $stub);
 
         $searchRule = $this->getSearchRule();
-
-        if ($searchRule) {
-            $stub = str_replace('DummySearchRules', "protected \$searchRules = [\n        {$searchRule}::class\n    ];", $stub);
-        } else {
-            $stub = preg_replace('#DummySearchRules\s+#', '', $stub);
-        }
+        $stub = str_replace('DummySearchRule', $searchRule ? "{$searchRule}::class" : '//', $stub);
 
         return $stub;
     }

src/Console/stubs/searchable_model.stub

@@ -2,13 +2,18 @@
 
 namespace DummyNamespace;
 
-use ScoutElastic\SearchableModel;
+use ScoutElastic\Searchable;
+use Illuminate\Database\Eloquent\Model;
 
-class DummyClass extends SearchableModel
+class DummyClass extends Model
 {
-    DummyIndexConfigurator
+    use Searchable;
 
-    DummySearchRules
+    protected $indexConfigurator = DummyIndexConfigurator;
+
+    protected $searchRules = [
+        DummySearchRule
+    ];
 
     protected $mapping = [
         //

src/Searchable.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace ScoutElastic;
+
+use Laravel\Scout\Searchable as ScoutSearchable;
+use ScoutElastic\Builders\FilterBuilder;
+use ScoutElastic\Builders\SearchBuilder;
+use \Exception;
+
+trait Searchable {
+    use ScoutSearchable;
+
+    /**
+     * @return IndexConfigurator
+     * @throws Exception If an index configurator is not specified
+     */
+    public function getIndexConfigurator()
+    {
+        static $indexConfigurator;
+
+        if (!$indexConfigurator) {
+            if (!isset($this->indexConfigurator) || empty($this->indexConfigurator)) {
+                throw new Exception(sprintf('An index configurator for the %s model is not specified.', __CLASS__));
+            }
+
+            $indexConfiguratorClass = $this->indexConfigurator;
+            $indexConfigurator = new $indexConfiguratorClass;
+        }
+
+        return $indexConfigurator;
+    }
+
+    public function getMapping()
+    {
+        return isset($this->mapping) ? $this->mapping : [];
+    }
+
+    public function getSearchRules()
+    {
+        return isset($this->searchRules) && count($this->searchRules) > 0 ? $this->searchRules : [SearchRule::class];
+    }
+
+    public static function search($query, $callback = null)
+    {
+        if ($query == '*') {
+            return new FilterBuilder(new static, $callback);
+        } else {
+            return new SearchBuilder(new static, $query, $callback);
+        }
+    }
+
+    public static function searchRaw($query)
+    {
+        $model = new static();
+
+        return $model->searchableUsing()
+            ->searchRaw($model, $query);
+    }
+}

src/SearchableModel.php

@@ -2,15 +2,11 @@
 
 namespace ScoutElastic;
 
-use Laravel\Scout\Searchable;
 use Illuminate\Database\Eloquent\Model;
-use ScoutElastic\Builders\FilterBuilder;
-use ScoutElastic\Builders\SearchBuilder;
 
+/** @deprecated Use the \ScoutElastic\Searchable trait instead. */
 abstract class SearchableModel extends Model
 {
-    use Searchable;
-
     protected $indexConfigurator;
 
     protected $mapping = [];
@@ -19,45 +15,5 @@ abstract class SearchableModel extends Model
         SearchRule::class
     ];
 
-    /**
-     * @return IndexConfigurator
-     */
-    public function getIndexConfigurator()
-    {
-        static $indexConfigurator;
-
-        if (!$indexConfigurator) {
-            $indexConfiguratorClass = $this->indexConfigurator;
-            $indexConfigurator = new $indexConfiguratorClass;
-        }
-
-        return $indexConfigurator;
-    }
-
-    public function getMapping()
-    {
-        return $this->mapping;
-    }
-
-    public function getSearchRules()
-    {
-        return $this->searchRules;
-    }
-
-    public static function search($query, $callback = null)
-    {
-        if ($query == '*') {
-            return new FilterBuilder(new static, $callback);
-        } else {
-            return new SearchBuilder(new static, $query, $callback);
-        }
-    }
-
-    public static function searchRaw($query)
-    {
-        $model = new static();
-
-        return $model->searchableUsing()
-            ->searchRaw($model, $query);
-    }
+    use Searchable;
 }