Fix #26. Fix small issues + fix documentation + add browse and browseFrom + Change perEnvironment to static

Author: maxiloc

README.md

@@ -188,13 +188,13 @@ class Contact extends Model
 {
     use AlgoliaEloquentTrait;
 
-    public $perEnvironment = true; // Index name will be 'Contacts_{\App::environnement()}';
+    public static $perEnvironment = true; // Index name will be 'contacts_{\App::environnement()}';
 }
 ```
 
 #### Custom `objectID`
 
-By default, the `objectID` is based on your record's keyName (`id` by default). You can change this behavior specifying the `object_id_key` option (be sure to use a uniq field).
+By default, the `objectID` is based on your record's keyName (`id` by default). You can change this behavior specifying the `objectIdKey` option (be sure to use a uniq field).
 
 ```php
 use Illuminate\Database\Eloquent\Model;
@@ -203,7 +203,7 @@ class Contact extends Model
 {
     use AlgoliaEloquentTrait;
 
-	public $objectIdKey = 'new_key';
+	public static $objectIdKey = 'new_key';
 }
 ```
 
@@ -229,7 +229,7 @@ class Contact extends Model
 
 #### Manual Indexing
 
-You can trigger indexing using the `pushToindex()` instance method.
+You can trigger indexing using the `pushToindex` instance method.
 
 ```php
 $contact = Contact::firstOrCreate(['name' => 'Jean']);
@@ -238,7 +238,7 @@ $contact->pushToindex();
 
 #### Manual Removal
 
-And trigger index removing using the `removeFromIndex()` instance method.
+And trigger index removing using the `removeFromIndex` instance method.
 
 ```php
 $contact = Contact::firstOrCreate(['name' => 'Jean']);
@@ -260,7 +260,7 @@ Contact::reindex(false);
 
 #### Clearing an Index
 
-To clear an index, use the `clear_index!` class method:
+To clear an index, use the `clearIndices` class method:
 
 ```ruby
 Contact::clearIndices();
@@ -316,7 +316,7 @@ Book.search('foo bar', ['index' => 'contacts_desc']);
 
 ## Target Multiple Indexes
 
-You can index a record in several indexes using the <code>add_index</code> method:
+You can index a record in several indexes using the <code>indexOnly</code> method:
 
 ```php
 use Illuminate\Database\Eloquent\Model;

src/AlgoliaEloquentTrait.php

@@ -60,6 +60,57 @@ public function _clearIndices()
         }
     }
 
+    /**
+     * @param $query
+     * @param array $parameters
+     * @param $cursor
+     *
+     * @return mixed
+     */
+    public function _browseFrom($query, $parameters = [], $cursor = null)
+    {
+        /** @var \AlgoliaSearch\Laravel\ModelHelper $modelHelper */
+        $modelHelper = App::make('\AlgoliaSearch\Laravel\ModelHelper');
+
+        $index = null;
+
+        if (isset($parameters['index'])) {
+            $index = $modelHelper->getIndex($parameters['index']);
+            unset($parameters['index']);
+        } else {
+            $index = $modelHelper->getIndices($this)[0];
+        }
+
+        $result = $index->browseFrom($query, $parameters, $cursor);
+
+        return $result;
+    }
+
+    /**
+     * @param $query
+     * @param array $parameters
+     *
+     * @return mixed
+     */
+    public function _browse($query, $parameters = [])
+    {
+        /** @var \AlgoliaSearch\Laravel\ModelHelper $modelHelper */
+        $modelHelper = App::make('\AlgoliaSearch\Laravel\ModelHelper');
+
+        $index = null;
+
+        if (isset($parameters['index'])) {
+            $index = $modelHelper->getIndex($parameters['index']);
+            unset($parameters['index']);
+        } else {
+            $index = $modelHelper->getIndices($this)[0];
+        }
+
+        $result = $index->browse($query, $parameters);
+
+        return $result;
+    }
+
     /**
      * @param $query
      * @param array $parameters
@@ -80,7 +131,7 @@ public function _search($query, $parameters = [])
             $index = $modelHelper->getIndices($this)[0];
         }
 
-        $result = $index->search($query, ['hitsPerPage' => 0]);
+        $result = $index->search($query, $parameters);
 
         return $result;
     }

src/ModelHelper.php

@@ -51,7 +51,7 @@ public function getObjectId(Model $model)
 
     public function getObjectIdKey(Model $model)
     {
-        return property_exists($model, 'objectIdKey') ? $model->objectIdKey : $model->getKeyName();
+        return property_exists($model, 'objectIdKey') ? $model::$objectIdKey : $model->getKeyName();
     }
 
     public function getSettings(Model $model)
@@ -77,7 +77,7 @@ public function getIndices(Model $model)
             $indicesName[] = $this->getIndexName($model);
         }
 
-        $env_suffix = property_exists($model, 'perEnvironment') && $model->perEnvironment === 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, 'perEnvironment') && $model->perEnvironment === 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/Model4.php

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

tests/Models/Model5.php

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