add support for defining the database connection table

Author: rubenvanassche

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `laravel-settings` will be documented in this file
 
+## 2.1.6 - 2021-06-03
+
+- add support for defining the database connection table
+
 ## 2.1.5 - 2021-05-21
 
 - fix some casting problems

README.md

@@ -119,6 +119,7 @@ return [
         'database' => [
             'type' => Spatie\LaravelSettings\SettingsRepositories\DatabaseSettingsRepository::class,
             'model' => null,
+            'table' => null,
             'connection' => null,
         ],
         'redis' => [
@@ -931,6 +932,7 @@ There are two types of repositories included in the package, the `redis` and `da
 The database repository has two optional configuration options:
 
 - `model` the Eloquent model used to load/save properties to the database
+- `table` the table used in the database
 - `connection` the connection to use when interacting with the database
 
 #### Redis repository

config/settings.php

@@ -29,6 +29,7 @@
         'database' => [
             'type' => Spatie\LaravelSettings\SettingsRepositories\DatabaseSettingsRepository::class,
             'model' => null,
+            'table' => null,
             'connection' => null,
         ],
         'redis' => [

src/SettingsRepositories/DatabaseSettingsRepository.php

@@ -2,33 +2,28 @@
 
 namespace Spatie\LaravelSettings\SettingsRepositories;
 
-use DB;
+use Illuminate\Database\Eloquent\Builder;
 use Spatie\LaravelSettings\Models\SettingsProperty;
 
 class DatabaseSettingsRepository implements SettingsRepository
 {
-    /** @var string|\Illuminate\Database\Eloquent\Model */
+    /** @var class-string<\Illuminate\Database\Eloquent\Model> */
     protected string $propertyModel;
 
     protected ?string $connection;
 
+    protected ?string $table;
+
     public function __construct(array $config)
     {
         $this->propertyModel = $config['model'] ?? SettingsProperty::class;
-
         $this->connection = $config['connection'] ?? null;
+        $this->table = $config['table'] ?? null;
     }
 
     public function getPropertiesInGroup(string $group): array
     {
-        /**
-         * @var \Spatie\LaravelSettings\Models\SettingsProperty $temp
-         * @psalm-suppress UndefinedClass
-         */
-        $temp = new $this->propertyModel();
-
-        return DB::connection($this->connection ?? $temp->getConnectionName())
-            ->table($temp->getTable())
+        return $this->getBuilder()
             ->where('group', $group)
             ->get(['name', 'payload'])
             ->mapWithKeys(function ($object) {
@@ -39,15 +34,15 @@ public function getPropertiesInGroup(string $group): array
 
     public function checkIfPropertyExists(string $group, string $name): bool
     {
-        return $this->propertyModel::on($this->connection)
+        return $this->getBuilder()
             ->where('group', $group)
             ->where('name', $name)
             ->exists();
     }
 
     public function getPropertyPayload(string $group, string $name)
     {
-        $setting = $this->propertyModel::on($this->connection)
+        $setting = $this->getBuilder()
             ->where('group', $group)
             ->where('name', $name)
             ->first('payload')
@@ -58,7 +53,7 @@ public function getPropertyPayload(string $group, string $name)
 
     public function createProperty(string $group, string $name, $payload): void
     {
-        $this->propertyModel::on($this->connection)->create([
+        $this->getBuilder()->create([
             'group' => $group,
             'name' => $name,
             'payload' => json_encode($payload),
@@ -68,7 +63,7 @@ public function createProperty(string $group, string $name, $payload): void
 
     public function updatePropertyPayload(string $group, string $name, $value): void
     {
-        $this->propertyModel::on($this->connection)
+        $this->getBuilder()
             ->where('group', $group)
             ->where('name', $name)
             ->update([
@@ -78,34 +73,49 @@ public function updatePropertyPayload(string $group, string $name, $value): void
 
     public function deleteProperty(string $group, string $name): void
     {
-        $this->propertyModel::on($this->connection)
+        $this->getBuilder()
             ->where('group', $group)
             ->where('name', $name)
             ->delete();
     }
 
     public function lockProperties(string $group, array $properties): void
     {
-        $this->propertyModel::on($this->connection)
+        $this->getBuilder()
             ->where('group', $group)
             ->whereIn('name', $properties)
             ->update(['locked' => true]);
     }
 
     public function unlockProperties(string $group, array $properties): void
     {
-        $this->propertyModel::on($this->connection)
+        $this->getBuilder()
             ->where('group', $group)
             ->whereIn('name', $properties)
             ->update(['locked' => false]);
     }
 
     public function getLockedProperties(string $group): array
     {
-        return $this->propertyModel::on($this->connection)
+        return $this->getBuilder()
             ->where('group', $group)
             ->where('locked', true)
             ->pluck('name')
             ->toArray();
     }
+
+    public function getBuilder(): Builder
+    {
+        $model = new $this->propertyModel;
+
+        if($this->connection){
+            $model->setConnection($this->connection);
+        }
+
+        if($this->table){
+            $model->setTable($this->table);
+        }
+
+        return $model->newQuery();
+    }
 }

tests/SettingsRepositories/DatabaseSettingsRepositoryTest.php

@@ -3,6 +3,7 @@
 namespace Spatie\LaravelSettings\Tests\SettingsRepositories;
 
 use Closure;
+use DB;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 use Spatie\LaravelSettings\Models\SettingsProperty;
@@ -258,6 +259,30 @@ public function it_can_have_different_configuration_options(Closure $repositoryF
         ], $otherRepository->getPropertiesInGroup('test'));
     }
 
+    /** @test */
+    public function it_can_have_a_different_table_name()
+    {
+        Schema::create('spatie_settings', function (Blueprint $table): void {
+            $table->id();
+
+            $table->string('group')->index();
+            $table->string('name');
+            $table->boolean('locked');
+            $table->json('payload');
+
+            $table->timestamps();
+        });
+
+        $repository = new DatabaseSettingsRepository([
+            'table' => 'spatie_settings'
+        ]);
+
+        $repository->createProperty('test', 'a', 'Alpha');
+
+        $this->assertEquals(1, DB::table('spatie_settings')->count());
+        $this->assertEquals(0, DB::table('settings')->count());
+    }
+
     public function configurationsProvider(): array
     {
         return [