PHPORM-146: Add override attribute everywhere (#3412)

* Add `#[Override]` attributes to `Query\Builder`

to keep track of the methods we're overriding on the base builder

* Add `#[Override]` attribute to `MongoBatchRepository`

* Add `#[Override]` attribute to `MongoLock`

* Add  attribute to Eloquent builder

* Add `#[Override]` attribute to `MongoQueue`

* Add `#[Override]` attribute to relationship classes

* Add `#[Override]` attribute to `Schema` namespace classes

* Add  attribute to session handler

* Add `#[Override]` attribute to Validation namespace

* Add `#[Override]` attribute to `CommandSubscriber`

* Add `#[Override] attribute to `Connection`

* Add `#[Override]` attribute to `ServiceProvider` implementations

Author: paulinevos

src/Bus/MongoBatchRepository.php

@@ -216,6 +216,7 @@ public function prune(DateTimeInterface $before): int
     }
 
     /** Prune all the unfinished entries older than the given date. */
+    #[Override]
     public function pruneUnfinished(DateTimeInterface $before): int
     {
         $result = $this->collection->deleteMany(
@@ -229,6 +230,7 @@ public function pruneUnfinished(DateTimeInterface $before): int
     }
 
     /** Prune all the cancelled entries older than the given date. */
+    #[Override]
     public function pruneCancelled(DateTimeInterface $before): int
     {
         $result = $this->collection->deleteMany(

src/Cache/MongoLock.php

@@ -41,6 +41,7 @@ public function __construct(
     /**
      * Attempt to acquire the lock.
      */
+    #[Override]
     public function acquire(): bool
     {
         // The lock can be acquired if: it doesn't exist, it has expired,

src/CommandSubscriber.php

@@ -7,6 +7,7 @@
 use MongoDB\Driver\Monitoring\CommandStartedEvent;
 use MongoDB\Driver\Monitoring\CommandSubscriber as CommandSubscriberInterface;
 use MongoDB\Driver\Monitoring\CommandSucceededEvent;
+use Override;
 
 use function get_object_vars;
 use function in_array;
@@ -21,16 +22,19 @@ public function __construct(private Connection $connection)
     {
     }
 
+    #[Override]
     public function commandStarted(CommandStartedEvent $event): void
     {
         $this->commands[$event->getOperationId()] = $event;
     }
 
+    #[Override]
     public function commandFailed(CommandFailedEvent $event): void
     {
         $this->logQuery($event);
     }
 
+    #[Override]
     public function commandSucceeded(CommandSucceededEvent $event): void
     {
         $this->logQuery($event);

src/Connection.php

@@ -16,6 +16,7 @@
 use MongoDB\Driver\ReadPreference;
 use MongoDB\Laravel\Concerns\ManagesTransactions;
 use OutOfBoundsException;
+use Override;
 use Throwable;
 
 use function filter_var;
@@ -95,6 +96,7 @@ public function __construct(array $config)
      *
      * @return Query\Builder
      */
+    #[Override]
     public function table($table, $as = null)
     {
         $query = new Query\Builder($this, $this->getQueryGrammar(), $this->getPostProcessor());
@@ -115,6 +117,7 @@ public function getCollection($name): Collection
     }
 
     /** @inheritdoc */
+    #[Override]
     public function getSchemaBuilder()
     {
         return new Schema\Builder($this);
@@ -172,6 +175,8 @@ public function getClient(): ?Client
         return $this->connection;
     }
 
+    /** @inheritdoc  */
+    #[Override]
     public function enableQueryLog()
     {
         parent::enableQueryLog();
@@ -182,6 +187,7 @@ public function enableQueryLog()
         }
     }
 
+    #[Override]
     public function disableQueryLog()
     {
         parent::disableQueryLog();
@@ -192,6 +198,7 @@ public function disableQueryLog()
         }
     }
 
+    #[Override]
     protected function withFreshQueryLog($callback)
     {
         try {
@@ -340,6 +347,7 @@ protected function getDsn(array $config): string
     }
 
     /** @inheritdoc */
+    #[Override]
     public function getDriverName()
     {
         return 'mongodb';
@@ -352,19 +360,22 @@ public function getDriverTitle()
     }
 
     /** @inheritdoc */
+    #[Override]
     protected function getDefaultPostProcessor()
     {
         return new Query\Processor();
     }
 
     /** @inheritdoc */
+    #[Override]
     protected function getDefaultQueryGrammar()
     {
         // Argument added in Laravel 12
         return new Query\Grammar($this);
     }
 
     /** @inheritdoc */
+    #[Override]
     protected function getDefaultSchemaGrammar()
     {
         // Argument added in Laravel 12

src/Eloquent/Builder.php

@@ -18,6 +18,7 @@
 use MongoDB\Laravel\Helpers\QueriesRelationships;
 use MongoDB\Laravel\Query\AggregationBuilder;
 use MongoDB\Model\BSONDocument;
+use Override;
 
 use function array_key_exists;
 use function array_map;
@@ -127,7 +128,12 @@ public function vectorSearch(
         return $this->model->hydrate($results->all());
     }
 
-    /** @inheritdoc */
+    /**
+     * @param array $options
+     *
+     * @inheritdoc
+     */
+    #[Override]
     public function update(array $values, array $options = [])
     {
         // Intercept operations on embedded models and delegate logic
@@ -270,6 +276,7 @@ public function raw($value = null)
         return $results;
     }
 
+    #[Override]
     public function firstOrCreate(array $attributes = [], array $values = [])
     {
         $instance = (clone $this)->where($attributes)->first();
@@ -285,6 +292,7 @@ public function firstOrCreate(array $attributes = [], array $values = [])
         return $this->createOrFirst($attributes, $values);
     }
 
+    #[Override]
     public function createOrFirst(array $attributes = [], array $values = [])
     {
         // The duplicate key error would abort the transaction. Using the regular firstOrCreate in that case.
@@ -308,9 +316,8 @@ public function createOrFirst(array $attributes = [], array $values = [])
      * TODO Remove if https://github.com/laravel/framework/commit/6484744326531829341e1ff886cc9b628b20d73e
      * will be reverted
      * Issue in laravel/frawework https://github.com/laravel/framework/issues/27791.
-     *
-     * @return array
      */
+    #[Override]
     protected function addUpdatedAtColumn(array $values)
     {
         if (! $this->model->usesTimestamps() || $this->model->getUpdatedAtColumn() === null) {
@@ -332,6 +339,7 @@ public function getConnection(): Connection
     }
 
     /** @inheritdoc */
+    #[Override]
     protected function ensureOrderForCursorPagination($shouldReverse = false)
     {
         if (empty($this->query->orders)) {

src/MongoDBBusServiceProvider.php

@@ -10,6 +10,7 @@
 use Illuminate\Support\ServiceProvider;
 use InvalidArgumentException;
 use MongoDB\Laravel\Bus\MongoBatchRepository;
+use Override;
 
 use function sprintf;
 
@@ -18,6 +19,7 @@ class MongoDBBusServiceProvider extends ServiceProvider implements DeferrablePro
     /**
      * Register the service provider.
      */
+    #[Override]
     public function register()
     {
         $this->app->singleton(MongoBatchRepository::class, function (Container $app) {
@@ -46,6 +48,8 @@ public function register()
         });
     }
 
+    /** @inheritdoc */
+    #[Override]
     public function provides()
     {
         return [

src/MongoDBServiceProvider.php

@@ -24,6 +24,7 @@
 use MongoDB\Laravel\Queue\MongoConnector;
 use MongoDB\Laravel\Scout\ScoutEngine;
 use MongoDB\Laravel\Session\MongoDbSessionHandler;
+use Override;
 use RuntimeException;
 
 use function assert;
@@ -47,6 +48,7 @@ public function boot()
     /**
      * Register the service provider.
      */
+    #[Override]
     public function register()
     {
         // Add database driver.