Allow custom autoIndex and autoDelete. Fixes #57

Author: maxiloc

README.md

@@ -170,6 +170,40 @@ for ($i = 0; $i < 10000; $i++) {
 Contact::reindex(); // Will use batch operations.
 ```
 
+You can also make a dynamic condition for those two parameters creating an ``autoIndex``` and/or ```autoDelete method```
+on your model
+
+```
+use Illuminate\Database\Eloquent\Model;
+
+class Contact extends Model
+{
+	use AlgoliaEloquentTrait;
+
+	public function autoIndex()
+	{
+	    if (\App::environment() === 'test') {
+	        return false;
+	    }
+
+	    return true;
+	}
+
+	public static autoDelete()
+	{
+        if (\App::environment() === 'test') {
+            return false;
+        }
+
+        return true;
+	}
+}
+```
+
+Be careful those two methods are defined in AlgoliaEloquentTrait.
+When putting those methods in a parent class they will be "erased" by AlgoliaEloquentTrait if used in a child class
+(because of php inheritance)
+
 ## Custom Index Name
 
 By default, the index name will be the pluralized class name, e.g. "Contacts". You can customize the index name by using the `$indices` option:

src/AlgoliaEloquentTrait.php

@@ -265,4 +265,14 @@ public function removeFromIndex()
             $index->deleteObject($modelHelper->getObjectId($this));
         }
     }
+
+    public function autoIndex()
+    {
+        return (property_exists($this, 'autoIndex') == false || $this::$autoIndex === true);
+    }
+
+    public function autoDelete()
+    {
+        return (property_exists($this, 'autoDelete') == false || $this::$autoDelete === true);
+    }
 }

src/ModelHelper.php

@@ -47,12 +47,12 @@ private function hasAlgoliaTrait(Model $class, $autoload = false)
 
     public function isAutoIndex(Model $model)
     {
-        return ($this->hasAlgoliaTrait($model) && (property_exists($model, 'autoIndex') == false || $model::$autoIndex === true));
+        return ($this->hasAlgoliaTrait($model) && $model->autoIndex());
     }
 
     public function isAutoDelete(Model $model)
     {
-        return ($this->hasAlgoliaTrait($model) && (property_exists($model, 'autoDelete') == false || $model::$autoDelete === true));
+        return ($this->hasAlgoliaTrait($model) && $model->autoDelete());
     }
 
     public function getKey(Model $model)

tests/ModelHelperTest.php

@@ -8,6 +8,8 @@
 use AlgoliaSearch\Tests\Models\Model4;
 use AlgoliaSearch\Tests\Models\Model5;
 use AlgoliaSearch\Tests\Models\Model7;
+use AlgoliaSearch\Tests\Models\Model8;
+use AlgoliaSearch\Tests\Models\Model9;
 use Orchestra\Testbench\TestCase;
 
 class ModelHelperTest extends TestCase
@@ -34,6 +36,12 @@ public function testAutoIndexAndAutoDelete()
         $this->assertEquals(false, $this->modelHelper->isAutoDelete(new Model2()));
         $this->assertEquals(false, $this->modelHelper->isAutoDelete(new Model3()));
         $this->assertEquals(true, $this->modelHelper->isAutoDelete(new Model7()));
+
+        $this->assertEquals(true, $this->modelHelper->isAutoIndex(new Model8()));
+        $this->assertEquals(false, $this->modelHelper->isAutoDelete(new Model8()));
+
+        $this->assertEquals(false, $this->modelHelper->isAutoIndex(new Model9()));
+        $this->assertEquals(true, $this->modelHelper->isAutoDelete(new Model9()));
     }
 
     public function testGetKey()

tests/Models/Model8.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace AlgoliaSearch\Tests\Models;
+
+use AlgoliaSearch\Tests\Traits\Trait1;
+use Illuminate\Database\Eloquent\Model;
+
+class Model8 extends Model
+{
+    use Trait1;
+
+    public function autoIndex()
+    {
+        return true;
+    }
+
+    public function autoDelete()
+    {
+        return false;
+    }
+}

tests/Models/Model9.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace AlgoliaSearch\Tests\Models;
+
+use AlgoliaSearch\Tests\Traits\Trait1;
+use Illuminate\Database\Eloquent\Model;
+
+class Model9 extends Model
+{
+    use Trait1;
+
+    public function autoIndex()
+    {
+        return false;
+    }
+
+    public function autoDelete()
+    {
+        return true;
+    }
+}