Use getScoutKey instead of getKey to define ID's.

This will allow us to explicitly redefine which field we want to use as an ID without having to change the base method getKey.

Author: ferpetrelli

src/Indexers/BulkIndexer.php

@@ -43,7 +43,7 @@ public function update(Collection $models)
             }
 
             $actionPayload = (new RawPayload())
-                ->set('index._id', $model->getKey());
+                ->set('index._id', $model->getScoutKey());
 
             $bulkPayload
                 ->add('body', $actionPayload->get())
@@ -64,7 +64,7 @@ public function delete(Collection $models)
 
         $models->each(function ($model) use ($bulkPayload) {
             $actionPayload = (new RawPayload())
-                ->set('delete._id', $model->getKey());
+                ->set('delete._id', $model->getScoutKey());
 
             $bulkPayload->add('body', $actionPayload->get());
         });

src/Payloads/DocumentPayload.php

@@ -16,7 +16,7 @@ class DocumentPayload extends TypePayload
      */
     public function __construct(Model $model)
     {
-        if ($model->getKey() === null) {
+        if ($model->getScoutKey() === null) {
             throw new Exception(sprintf(
                 'The key value must be set to construct a payload for the %s instance.',
                 get_class($model)
@@ -25,7 +25,7 @@ public function __construct(Model $model)
 
         parent::__construct($model);
 
-        $this->payload['id'] = $model->getKey();
+        $this->payload['id'] = $model->getScoutKey();
         $this->protectedKeys[] = 'id';
     }
 }

tests/Dependencies/Model.php

@@ -19,6 +19,7 @@ public function mockModel(array $params = [])
             $params['methods'] ?? [],
             [
                 'getKey',
+                'getScoutKey',
                 'trashed',
                 'searchableAs',
                 'toSearchableArray',
@@ -35,6 +36,10 @@ public function mockModel(array $params = [])
             ->method('getKey')
             ->willReturn($params['key'] ?? 1);
 
+        $mock
+            ->method('getScoutKey')
+            ->willReturn($params['key'] ?? 1);
+
         $mock
             ->method('trashed')
             ->willReturn($params['trashed'] ?? false);