Document method overrides

Author: GromNaN

src/Scout/MongoDBScoutServiceProvider.php

@@ -24,11 +24,10 @@ public function register(): void
                 $connectionName = $app->get('config')->get('scout.mongodb.connection', 'mongodb');
                 $connection = $app->get('db')->connection($connectionName);
                 $softDelete = (bool) $app->get('config')->get('scout.soft_delete', false);
-                $prefix = (string) $app->get('config')->get('scout.prefix');
 
                 assert($connection instanceof Connection, new InvalidArgumentException(sprintf('The connection "%s" is not a MongoDB connection.', $connectionName)));
 
-                return new ScoutEngine($connection->getMongoDB(), $softDelete, $prefix);
+                return new ScoutEngine($connection->getMongoDB(), $softDelete);
             });
 
             return $engineManager;

src/Scout/ScoutEngine.php

@@ -21,6 +21,7 @@
 use MongoDB\Driver\CursorInterface;
 use MongoDB\Exception\RuntimeException as MongoDBRuntimeException;
 use MongoDB\Laravel\Connection;
+use Override;
 use Traversable;
 use TypeError;
 
@@ -66,17 +67,19 @@ final class ScoutEngine extends Engine
     public function __construct(
         private Database $database,
         private bool $softDelete,
-        private string $prefix,
     ) {
     }
 
     /**
      * Update the given model in the index.
      *
+     * @see Engine::update()
+     *
      * @param EloquentCollection $models
      *
      * @throws MongoDBRuntimeException
      */
+    #[Override]
     public function update($models)
     {
         if ($models->isEmpty()) {
@@ -121,8 +124,11 @@ public function update($models)
     /**
      * Remove the given model from the index.
      *
+     * @see Engine::delete()
+     *
      * @param EloquentCollection $models
      */
+    #[Override]
     public function delete($models): void
     {
         assert($models instanceof Collection, new TypeError(sprintf('Argument #1 ($models) must be of type %s, %s given', Collection::class, get_debug_type($models))));
@@ -139,8 +145,11 @@ public function delete($models): void
     /**
      * Perform the given search on the engine.
      *
+     * @see Engine::search()
+     *
      * @return mixed
      */
+    #[Override]
     public function search(Builder $builder)
     {
         return $this->performSearch($builder);
@@ -149,11 +158,14 @@ public function search(Builder $builder)
     /**
      * Perform the given search on the engine.
      *
+     * @see Engine::paginate()
+     *
      * @param int $perPage
      * @param int $page
      *
      * @return mixed
      */
+    #[Override]
     public function paginate(Builder $builder, $perPage, $page)
     {
         assert(is_int($perPage), new TypeError(sprintf('Argument #2 ($perPage) must be of type int, %s given', get_debug_type($perPage))));
@@ -265,8 +277,11 @@ protected function performSearch(Builder $builder, ?int $offset = null): array
     /**
      * Pluck and return the primary keys of the given results.
      *
+     * @see Engine::mapIds()
+     *
      * @param list<array|object> $results
      */
+    #[Override]
     public function mapIds($results): Collection
     {
         assert(is_array($results), new TypeError(sprintf('Argument #1 ($results) must be of type array, %s given', get_debug_type($results))));
@@ -277,9 +292,12 @@ public function mapIds($results): Collection
     /**
      * Map the given results to instances of the given model.
      *
+     * @see Engine::map()
+     *
      * @param array $results
      * @param Model $model
      */
+    #[Override]
     public function map(Builder $builder, $results, $model): Collection
     {
         assert(is_array($results), new TypeError(sprintf('Argument #2 ($results) must be of type array, %s given', get_debug_type($results))));
@@ -316,8 +334,11 @@ public function map(Builder $builder, $results, $model): Collection
      * Get the total count from a raw result returned by the engine.
      * This is an estimate if the count is larger than 1000.
      *
+     * @see Engine::getTotalCount()
+     *
      * @param mixed $results
      */
+    #[Override]
     public function getTotalCount($results): int
     {
         if (! $results) {
@@ -330,8 +351,11 @@ public function getTotalCount($results): int
     /**
      * Flush all records from the engine.
      *
+     * @see Engine::flush()
+     *
      * @param Model $model
      */
+    #[Override]
     public function flush($model): void
     {
         assert($model instanceof Model, new TypeError(sprintf('Argument #1 ($model) must be of type %s, %s given', Model::class, get_debug_type($model))));
@@ -344,12 +368,15 @@ public function flush($model): void
     /**
      * Map the given results to instances of the given model via a lazy collection.
      *
+     * @see Engine::lazyMap()
+     *
      * @param Builder      $builder
      * @param array|Cursor $results
      * @param Model        $model
      *
      * @return LazyCollection
      */
+    #[Override]
     public function lazyMap(Builder $builder, $results, $model): LazyCollection
     {
         assert($results instanceof Cursor || is_array($results), new TypeError(sprintf('Argument #2 ($results) must be of type %s|array, %s given', Cursor::class, get_debug_type($results))));
@@ -388,9 +415,12 @@ public function lazyMap(Builder $builder, $results, $model): LazyCollection
      * Accepted options:
      *  - wait: bool, default true. Wait for the index to be created.
      *
+     * @see Engine::createIndex()
+     *
      * @param string            $name    Collection name
      * @param array{wait?:bool} $options
      */
+    #[Override]
     public function createIndex($name, array $options = []): void
     {
         assert(is_string($name), new TypeError(sprintf('Argument #1 ($name) must be of type string, %s given', get_debug_type($name))));
@@ -418,7 +448,10 @@ public function createIndex($name, array $options = []): void
 
     /**
      * Delete a "search index", i.e. a MongoDB collection.
+     *
+     * @see Engine::deleteIndex()
      */
+    #[Override]
     public function deleteIndex($name): void
     {
         assert(is_string($name), new TypeError(sprintf('Argument #1 ($name) must be of type string, %s given', get_debug_type($name))));

tests/Scout/Models/ScoutUser.php

@@ -22,13 +22,8 @@ class ScoutUser extends Model
     protected $table            = 'scout_users';
     protected static $unguarded = true;
 
-    public function searchableAs(): string
-    {
-        return 'mongodb_scout_users';
-    }
-
     /**
-     * Check if we need to run the schema.
+     * Create the SQL table for the model.
      */
     public static function executeSchema(): void
     {

tests/Scout/Models/SearchableInSameNamespace.php

@@ -20,6 +20,8 @@ class SearchableInSameNamespace extends Model
     /**
      * Using the same collection as the model collection as Scout index
      * is prohibited to prevent erasing the data.
+     *
+     * @see Searchable::searchableAs()
      */
     public function indexableAs(): string
     {

tests/Scout/Models/SearchableModel.php

@@ -14,11 +14,13 @@ class SearchableModel extends Model
     protected $connection = 'sqlite';
     protected $fillable = ['id', 'name', 'date'];
 
+    /** @see Searchable::searchableAs() */
     public function searchableAs(): string
     {
         return 'collection_searchable';
     }
 
+    /** @see Searchable::indexableAs() */
     public function indexableAs(): string
     {
         return 'collection_indexable';
@@ -27,6 +29,8 @@ public function indexableAs(): string
     /**
      * Overriding the `getScoutKey` method to ensure the custom key is used for indexing
      * and searching the model.
+     *
+     * @see Searchable::getScoutKey()
      */
     public function getScoutKey(): string
     {
@@ -36,6 +40,8 @@ public function getScoutKey(): string
     /**
      * This method must be overridden when the `getScoutKey` method is also overridden,
      * to support model serialization for async indexation jobs.
+     *
+     * @see Searchable::getScoutKeyName()
      */
     public function getScoutKeyName(): string
     {

tests/Scout/ScoutEngineTest.php

@@ -52,7 +52,7 @@ public function testSearch(Closure $builder, array $expectedPipeline): void
             })
             ->andReturn($cursor);
 
-        $engine = new ScoutEngine($database, softDelete: false, prefix: '');
+        $engine = new ScoutEngine($database, softDelete: false);
         $result = $engine->search($builder());
         $this->assertEquals($data, $result);
     }
@@ -393,7 +393,7 @@ public function testPaginate()
             ->with()
             ->andReturn([['_id' => 'key_1', '__count' => 17], ['_id' => 'key_2', '__count' => 17]]);
 
-        $engine = new ScoutEngine($database, softDelete: false, prefix: '');
+        $engine = new ScoutEngine($database, softDelete: false);
         $builder = new Builder(new SearchableModel(), 'mustang');
         $builder->orderBy('name', 'desc');
         $engine->paginate($builder, $perPage, $page);
@@ -402,7 +402,7 @@ public function testPaginate()
     #[DataProvider('provideResultsForMapIds')]
     public function testMapIds(array $results): void
     {
-        $engine = new ScoutEngine(m::mock(Database::class), softDelete: false, prefix: '');
+        $engine = new ScoutEngine(m::mock(Database::class), softDelete: false);
 
         $ids = $engine->mapIds($results);
 
@@ -468,7 +468,7 @@ public function testUpdate(): void
                 ],
             ]);
 
-        $engine = new ScoutEngine($database, softDelete: false, prefix: '');
+        $engine = new ScoutEngine($database, softDelete: false);
         $engine->update(EloquentCollection::make([
             new SearchableModel([
                 'id' => 1,
@@ -503,7 +503,7 @@ public function testUpdateWithSoftDelete(): void
         $model = new SearchableModel(['id' => 1]);
         $model->delete();
 
-        $engine = new ScoutEngine($database, softDelete: false, prefix: '');
+        $engine = new ScoutEngine($database, softDelete: false);
         $engine->update(EloquentCollection::make([$model]));
     }
 
@@ -518,7 +518,7 @@ public function testDelete(): void
             ->once()
             ->with(['_id' => ['$in' => ['key_1', 'key_2']]]);
 
-        $engine = new ScoutEngine($database, softDelete: false, prefix: '');
+        $engine = new ScoutEngine($database, softDelete: false);
         $engine->delete(EloquentCollection::make([
             new SearchableModel(['id' => 1]),
             new SearchableModel(['id' => 2]),
@@ -542,7 +542,7 @@ public function testDeleteWithRemoveableScoutCollection(): void
             ->once()
             ->with(['_id' => ['$in' => ['key_5']]]);
 
-        $engine = new ScoutEngine($database, softDelete: false, prefix: 'ignored_prefix_');
+        $engine = new ScoutEngine($database, softDelete: false);
         $engine->delete($job->models);
     }
 }

tests/Scout/ScoutIntegrationTest.php

@@ -39,7 +39,7 @@ protected function getEnvironmentSetUp($app): void
         parent::getEnvironmentSetUp($app);
 
         $app['config']->set('scout.driver', 'mongodb');
-        $app['config']->set('scout.prefix', 'scout_');
+        $app['config']->set('scout.prefix', 'prefix_');
     }
 
     public function testItCannotIndexInTheSameNamespace()
@@ -59,7 +59,7 @@ public function testItCanCreateTheCollection()
     {
         $this->skipIfSearchIndexManagementIsNotSupported();
 
-        $collection = DB::connection('mongodb')->getCollection('mongodb_scout_users');
+        $collection = DB::connection('mongodb')->getCollection('prefix_scout_users');
         $collection->drop();
 
         // Init the SQL database with some objects that will be indexed