Stop using deprecated RP_PRIMARY and replace it with PRIMARY in MongoDB read preferences.

Author: DevquasarX9

composer.json

@@ -6,11 +6,11 @@
     "require": {
         "php": "^8.1",
         "illuminate/cache": "^10.0",
-        "mongodb/laravel-mongodb": "^4.1"
+        "mongodb/laravel-mongodb": "^4.1",
+        "ext-mongodb": "*"
     },
     "require-dev": {
-        "orchestra/testbench": "^8.0",
-        "ext-mongodb": "*"
+        "orchestra/testbench": "^8.0"
     },
     "license": "MIT",
     "authors": [

src/Console/Commands/MongodbCacheDropIndex.php

@@ -4,42 +4,30 @@
 
 use Illuminate\Console\Command;
 use Illuminate\Support\Facades\DB;
-use \MongoDB\Driver\ReadPreference;
+use MongoDB\Driver\ReadPreference;
 
 /**
  * Drop the indexes created by MongodbCacheIndex
  */
 class MongodbCacheDropIndex extends Command
 {
 
-    /**
-     * The name and signature of the console command.
-     *
-     * @var string
-     */
+    /** The name and signature of the console command. */
     protected $signature = 'mongodb:cache:dropindex {index}';
 
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
+    /** The console command description. */
     protected $description = 'Drops the passed index from the mongodb `cache` collection';
 
-    /**
-     * Execute the console command.
-     *
-     * @return mixed
-     */
-    public function handle()
+    /** Execute the console command. */
+    public function handle(): void
     {
         $cacheCollectionName = config('cache')['stores']['mongodb']['table'];
 
         DB::connection('mongodb')->getMongoDB()->command([
             'dropIndexes' => $cacheCollectionName,
             'index' => $this->argument('index'),
         ], [
-            'readPreference' => new ReadPreference(ReadPreference::RP_PRIMARY)
+            'readPreference' => new ReadPreference(ReadPreference::PRIMARY)
         ]);
     }
 }

src/Console/Commands/MongodbCacheIndex.php

@@ -4,34 +4,22 @@
 
 use Illuminate\Console\Command;
 use Illuminate\Support\Facades\DB;
-use \MongoDB\Driver\ReadPreference;
+use MongoDB\Driver\ReadPreference;
 
 /**
  * Create indexes for the cache collection
  */
 class MongodbCacheIndex extends Command
 {
 
-    /**
-     * The name and signature of the console command.
-     *
-     * @var string
-     */
+    /** The name and signature of the console command. */
     protected $signature = 'mongodb:cache:index';
 
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
+    /** The console command description. */
     protected $description = 'Create indexes on the mongodb `cache` collection';
 
-    /**
-     * Execute the console command.
-     *
-     * @return mixed
-     */
-    public function handle()
+    /** Execute the console command. */
+    public function handle(): void
     {
         $cacheCollectionName = config('cache')['stores']['mongodb']['table'];
 
@@ -52,7 +40,7 @@ public function handle()
                 ]
             ]
         ], [
-            'readPreference' => new ReadPreference(ReadPreference::RP_PRIMARY)
+            'readPreference' => new ReadPreference(ReadPreference::PRIMARY)
         ]);
     }
 }

src/Console/Commands/MongodbCacheIndexTags.php

@@ -4,34 +4,22 @@
 
 use Illuminate\Console\Command;
 use Illuminate\Support\Facades\DB;
-use \MongoDB\Driver\ReadPreference;
+use MongoDB\Driver\ReadPreference;
 
 /**
  * Create indexes for the cache collection
  */
 class MongodbCacheIndexTags extends Command
 {
 
-    /**
-     * The name and signature of the console command.
-     *
-     * @var string
-     */
+    /** The name and signature of the console command. */
     protected $signature = 'mongodb:cache:index_tags';
 
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
+    /** The console command description. */
     protected $description = 'Create indexes on the tags column of mongodb `cache` collection';
 
-    /**
-     * Execute the console command.
-     *
-     * @return mixed
-     */
-    public function handle()
+    /** Execute the console command.*/
+    public function handle(): void
     {
         $cacheCollectionName = config('cache')['stores']['mongodb']['table'];
 
@@ -45,7 +33,7 @@ public function handle()
                 ],
             ]
         ], [
-            'readPreference' => new ReadPreference(ReadPreference::RP_PRIMARY)
+            'readPreference' => new ReadPreference(ReadPreference::PRIMARY)
         ]);
     }
 }

src/MongoTaggedCache.php

@@ -2,16 +2,16 @@
 
 namespace ForFit\Mongodb\Cache;
 
+use Illuminate\Cache\Events\KeyWritten;
 use Illuminate\Cache\Repository;
 use Illuminate\Contracts\Cache\Store;
-use Illuminate\Cache\Events\KeyWritten;
 
 class MongoTaggedCache extends Repository
 {
-    protected $tags;
+    protected array $tags;
 
     /**
-     * @param \Illuminate\Contracts\Cache\Store $store
+     * @param Store $store
      * @param array $tags
      */
     public function __construct(Store $store, array $tags = [])
@@ -27,12 +27,12 @@ public function __construct(Store $store, array $tags = [])
      * @param  string  $key
      * @param  mixed   $value
      * @param  \DateTimeInterface|\DateInterval|float|int  $ttl
-     * @return void
+     * @return bool|null
      */
     public function put($key, $value, $ttl = null)
     {
         if (is_array($key)) {
-            return $this->putMany($key, $value);
+            $this->putMany($key, $value);
         }
 
         $seconds = $this->getSeconds(is_null($ttl) ? 315360000 : $ttl);
@@ -45,19 +45,17 @@ public function put($key, $value, $ttl = null)
             }
 
             return $result;
-        } else {
-            return $this->forget($key);
         }
+
+        return $this->forget($key);
     }
 
     /**
      * Saves array of key value pairs to the cache
      *
-     * @param array $values
      * @param  \DateTimeInterface|\DateInterval|float|int  $ttl
-     * @return void
      */
-    public function putMany(array $values, $ttl = null)
+    public function putMany(array $values, $ttl = null): void
     {
         foreach ($values as $key => $value) {
             $this->put($key, $value, $ttl);
@@ -66,11 +64,9 @@ public function putMany(array $values, $ttl = null)
 
     /**
      * Flushes the cache for the given tags
-     *
-     * @return void
      */
-    public function flush()
+    public function flush(): void
     {
-        return $this->store->flushByTags($this->tags);
+        $this->store->flushByTags($this->tags);
     }
 }

src/Store.php

@@ -3,10 +3,10 @@
 namespace ForFit\Mongodb\Cache;
 
 use Closure;
-use Illuminate\Support\InteractsWithTime;
 use Illuminate\Cache\RetrievesMultipleKeys;
-use Illuminate\Database\ConnectionInterface;
 use Illuminate\Contracts\Cache\Store as StoreInterface;
+use Illuminate\Database\ConnectionInterface;
+use Illuminate\Support\InteractsWithTime;
 use Jenssegers\Mongodb\Query\Builder;
 use MongoDB\BSON\UTCDateTime;
 use MongoDB\Driver\Exception\BulkWriteException;
@@ -107,15 +107,15 @@ public function decrement($key, $value = 1)
     /**
      * @inheritDoc
      */
-    public function forever($key, $value)
+    public function forever($key, $value): bool
     {
         return $this->put($key, $value, 315360000);
     }
 
     /**
      * @inheritDoc
      */
-    public function forget($key)
+    public function forget($key): bool
     {
         $this->table()->where('key', '=', $this->getPrefix() . $key)->delete();
 
@@ -125,7 +125,7 @@ public function forget($key)
     /**
      * @inheritDoc
      */
-    public function flush()
+    public function flush(): bool
     {
         $this->table()->delete();
 
@@ -135,29 +135,23 @@ public function flush()
     /**
      * @inheritDoc
      */
-    public function getPrefix()
+    public function getPrefix(): string
     {
         return $this->prefix;
     }
 
     /**
      * Sets the tags to be used
-     *
-     * @param array $tags
-     * @return MongoTaggedCache
      */
-    public function tags(array $tags)
+    public function tags(array $tags): MongoTaggedCache
     {
         return new MongoTaggedCache($this, $tags);
     }
 
     /**
      * Deletes all records with the given tag
-     *
-     * @param array $tags
-     * @return void
      */
-    public function flushByTags(array $tags)
+    public function flushByTags(array $tags): void
     {
         foreach ($tags as $tag) {
             $this->table()->where('tags', $tag)->delete();
@@ -166,11 +160,8 @@ public function flushByTags(array $tags)
 
     /**
      * Retrieve an item's expiration time from the cache by key.
-     *
-     * @param string $key
-     * @return null|float|int
      */
-    public function getExpiration($key)
+    public function getExpiration($key): ?float
     {
         $cacheData = $this->table()->where('key', $this->getKeyWithPrefix($key))->first();
 
@@ -199,7 +190,7 @@ protected function table()
      * @param string $key
      * @return string
      */
-    protected function getKeyWithPrefix(string $key)
+    protected function getKeyWithPrefix(string $key): string
     {
         return $this->getPrefix() . $key;
     }
@@ -210,7 +201,7 @@ protected function getKeyWithPrefix(string $key)
      * @param string $key
      * @param int $value
      * @param Closure $callback
-     * @return int|bool
+     * @return false|mixed
      */
     protected function incrementOrDecrement($key, $value, Closure $callback)
     {