convert variables to Snake Case. Fixes issue #13

Author: maxiloc

README.md

@@ -74,11 +74,11 @@ class Contact extends \Illuminate\Database\Eloquent\Model
 
     public function getAlgoliaRecord()
     {
-        $extra_data = [
+        $extraData = [
             'custom_name' => 'Custom Name'
         ];
 
-        return array_merge($this->toArray(), $extra_data);
+        return array_merge($this->toArray(), $extraData);
     }
 }
 ```
@@ -92,7 +92,7 @@ class Contact extends \Illuminate\Database\Eloquent\Model
 {
     use AlgoliaEloquentTrait;
 
-    public $algolia_settings = [
+    public $algoliaSettings = [
     	'attributesToIndex => ['id', 'name'],
     	'customRanking => ['desc(popularity)'], 'asc(name)]'
     ]
@@ -143,15 +143,15 @@ class Contact extends \Illuminate\Database\Eloquent\Model
 {
 	use AlgoliaEloquentTrait;
 
-	public $auto_index = false;
-	public $auto_delete = false;
+	public $autoIndex = false;
+	public $autoDelete = false;
 }
 ```
 
 You can temporary disable auto-indexing. This is often used for performance reason.
 
 ```php
-Contact::$auto_index = false;
+Contact::$autoIndex = false;
 Contact.clearIndices();
 
 for ($i = 0; $i < 10000; $i++)
@@ -182,7 +182,7 @@ class Contact extends \Illuminate\Database\Eloquent\Model
 {
     use AlgoliaEloquentTrait;
 
-    public $per_environment = true; # index name will be "Contacts_{\App::environnement()}"
+    public $perEnvironment = true; # index name will be "Contacts_{\App::environnement()}"
 }
 ```
 
@@ -195,7 +195,7 @@ class Contact extends \Illuminate\Database\Eloquent\Model
 {
     use AlgoliaEloquentTrait;
 
-	public $object_id_key = 'new_key';
+	public $objectIdKey = 'new_key';
 }
 ```
 
@@ -271,7 +271,7 @@ class Contact extends \Illuminate\Database\Eloquent\Model
 {
 	 use AlgoliaEloquentTrait;
 
-	 public $algolia_settings = [
+	 public $algoliaSettings = [
 		'attributesToIndex'    => ['id', 'name'],
     	'customRanking'        => ['desc(popularity)', 'asc(name)'],
     	'slaves'               => ['contacts_desc']
@@ -312,9 +312,9 @@ class Contact extends \Illuminate\Database\Eloquent\Model
 
 	public $indices = ["contact_public", "contact_private"];
 
-	public function indexOnly($index_name)
+	public function indexOnly($indexName)
 	{
-		if ($index_name == "contact_public")
+		if ($indexName == "contact_public")
    			return $this->isPublic == 1;
 
    	   	return $this->isPublic == 0;

src/ModelHelper.php

@@ -26,12 +26,12 @@ private function hasAlgoliaTrait(Model $model)
 
     public function isAutoIndex(Model $model)
     {
-        return ($this->hasAlgoliaTrait($model) && (property_exists($model, 'auto_index') == false || $model::$auto_index === true));
+        return ($this->hasAlgoliaTrait($model) && (property_exists($model, 'autoIndex') == false || $model::$autoIndex === true));
     }
 
     public function isAutoDelete(Model $model)
     {
-        return ($this->hasAlgoliaTrait($model) && (property_exists($model, 'auto_delete') == false || $model::$auto_delete === true));
+        return ($this->hasAlgoliaTrait($model) && (property_exists($model, 'autoDelete') == false || $model::$autoDelete === true));
     }
 
     public function getKey(Model $model)
@@ -51,17 +51,17 @@ public function getObjectId(Model $model)
 
     public function getObjectIdKey(Model $model)
     {
-        return property_exists($model, 'object_id_key') ? $model->object_id_key : $model->getKeyName();
+        return property_exists($model, 'objectIdKey') ? $model->objectIdKey : $model->getKeyName();
     }
 
     public function getSettings(Model $model)
     {
-        return property_exists($model, 'algolia_settings') ? $model->algolia_settings : [];
+        return property_exists($model, 'algoliaSettings') ? $model->algoliaSettings : [];
     }
 
     public function getSlavesSettings(Model $model)
     {
-        return property_exists($model, 'slaves_settings') ? $model->slaves_settings : [];
+        return property_exists($model, 'slavesSettings') ? $model->slavesSettings : [];
     }
 
     /**
@@ -77,7 +77,7 @@ public function getIndices(Model $model)
             $indicesName[] = $this->getIndexName($model);
         }
 
-        $env_suffix = property_exists($model, 'per_environment') && $model->per_environment === true ? '_'.\App::environment() : '';
+        $env_suffix = property_exists($model, 'perEnvironment') && $model->perEnvironment === true ? '_'.\App::environment() : '';
 
         $indices = array_map(function ($index_name) use ($env_suffix) {
             return $this->algolia->initIndex($index_name.$env_suffix);
@@ -96,7 +96,7 @@ public function getIndicesTmp(Model $model)
             $indicesName[] = $this->getIndexName($model);
         }
 
-        $env_suffix = property_exists($model, 'per_environment') && $model->per_environment === true ? '_'.\App::environment() : '';
+        $env_suffix = property_exists($model, 'perEnvironment') && $model->perEnvironment === true ? '_'.\App::environment() : '';
 
         $indices = array_map(function ($index_name) use ($env_suffix) {
             return $this->algolia->initIndex($index_name.$env_suffix.'_tmp');

tests/Models/Model2.php

@@ -9,8 +9,8 @@ class Model2 extends Model
 {
     use AlgoliaEloquentTrait;
 
-    public static $auto_index = false;
-    public static $auto_delete = false;
+    public static $autoIndex = false;
+    public static $autoDelete = false;
 
     protected $primaryKey = 'id2';
 

tests/Models/Model3.php

@@ -6,6 +6,6 @@
 
 class Model3 extends Model
 {
-    public static $auto_index = true;
-    public static $auto_delete = true;
+    public static $autoIndex = true;
+    public static $autoDelete = true;
 }

tests/Models/Model4.php

@@ -9,11 +9,11 @@ class Model4 extends Model
 {
     use AlgoliaEloquentTrait;
 
-    public $object_id_key = 'id3';
+    public $objectIdKey = 'id3';
 
     protected $primaryKey = 'id2';
 
-    public $per_environment = false;
+    public $perEnvironment = false;
 
     public function __construct()
     {

tests/Models/Model5.php

@@ -9,5 +9,5 @@ class Model5 extends Model
 {
     use AlgoliaEloquentTrait;
 
-    public $per_environment = true;
+    public $perEnvironment = true;
 }