Merge pull request #324 from lara-zeus/user-model

feat: custom user model
lara-zeus · Sep 1, 2024 · 2309d6c · 2309d6c
2 parents 8e40c29 + 6821284
commit 2309d6c
Show file tree

Hide file tree

Showing 9 changed files with 194 additions and 167 deletions.
diff --git a/composer.lock b/composer.lock
diff --git a/config/zeus-bolt.php b/config/zeus-bolt.php
@@ -36,6 +36,7 @@
         'FormsStatus' => \LaraZeus\Bolt\Models\FormsStatus::class,
         'Response' => \LaraZeus\Bolt\Models\Response::class,
         'Section' => \LaraZeus\Bolt\Models\Section::class,
+        'User' => config('auth.providers.users.model'),
     ],
 
     'collectors' => [

diff --git a/docs/getting-started/configuration.md b/docs/getting-started/configuration.md
@@ -30,6 +30,7 @@ BoltPlugin::make()
         'FormsStatus' => \App\Models\Bolt\FormsStatus::class,
         'Response' => \App\Models\Bolt\Response::class,
         'Section' => \App\Models\Bolt\Section::class,
+        'User' => \App\Models\Staff::class,
     ])
 
     // make the actions floating in create and edit forms
@@ -104,3 +105,18 @@ to publish the configuration:
 ```bash
 php artisan vendor:publish --tag=zeus-bolt-config
 ```
+
+### Custom User Model:
+
+By default Bolt will user this model to get the user info:
+
+`config('auth.providers.users.model')`
+
+if you need to change this to use another model, add the following in your config file: `zeus-bolt.php`:
+
+```php
+'models' => [
+    //...
+    'User' => AnotherUserModel::class,
+],
+```
diff --git a/src/Configuration.php b/src/Configuration.php
@@ -65,12 +65,12 @@ public function getBoltModels(): array
         return $this->boltModels;
     }
 
-    public static function getModel(string $model): string
+    public static function getModel(string $model): ?string
     {
         return array_merge(
             config('zeus-bolt.models'),
             (new static)::get()->getBoltModels()
-        )[$model];
+        )[$model] ?? null;
     }
 
     public function navigationGroupLabel(Closure | string $label): static

diff --git a/src/Filament/Exports/ResponseExporter.php b/src/Filament/Exports/ResponseExporter.php
@@ -6,6 +6,7 @@
 use Filament\Actions\Exports\Exporter;
 use Filament\Actions\Exports\Models\Export;
 use Illuminate\Database\Eloquent\Model;
+use LaraZeus\Bolt\BoltPlugin;
 use LaraZeus\Bolt\Models\Field;
 use LaraZeus\Bolt\Models\Response;
 
@@ -18,7 +19,9 @@ class ResponseExporter extends Exporter
     public static function getColumns(): array
     {
         $record = \Livewire\Livewire::current()->getRecord();
-        $getUserModel = config('auth.providers.users.model')::getBoltUserFullNameAttribute();
+        //todo refactor with v4
+        $userModel = BoltPlugin::getModel('User') ?? config('auth.providers.users.model');
+        $getUserModel = $userModel::getBoltUserFullNameAttribute();
         $mainColumns = [
             ExportColumn::make('user.' . $getUserModel)
                 ->label(__('Name'))

diff --git a/src/Filament/Resources/FormResource/Pages/ManageResponses.php b/src/Filament/Resources/FormResource/Pages/ManageResponses.php
@@ -32,7 +32,9 @@ class ManageResponses extends ManageRelatedRecords
 
     public function table(Table $table): Table
     {
-        $getUserModel = config('auth.providers.users.model')::getBoltUserFullNameAttribute();
+        //todo refactor with v4
+        $userModel = BoltPlugin::getModel('User') ?? config('auth.providers.users.model');
+        $getUserModel = $userModel::getBoltUserFullNameAttribute();
 
         $mainColumns = [
             ImageColumn::make('user.avatar')

diff --git a/src/Models/Collection.php b/src/Models/Collection.php
@@ -54,6 +54,6 @@ protected static function newFactory(): Factory
 
     public function user(): BelongsTo
     {
-        return $this->belongsTo(config('auth.providers.users.model'));
+        return $this->belongsTo(config('zeus-bolt.models.User') ?? config('auth.providers.users.model'));
     }
 }
diff --git a/src/Models/Form.php b/src/Models/Form.php
@@ -114,7 +114,7 @@ protected static function newFactory(): Factory
 
     public function user(): BelongsTo
     {
-        return $this->belongsTo(config('auth.providers.users.model'));
+        return $this->belongsTo(config('zeus-bolt.models.User') ?? config('auth.providers.users.model'));
     }
 
     /** @phpstan-return BelongsTo<Form, Category> */

diff --git a/src/Models/Response.php b/src/Models/Response.php
@@ -79,7 +79,7 @@ public function fieldsResponses(): HasMany
 
     public function user(): BelongsTo
     {
-        return $this->belongsTo(config('auth.providers.users.model'));
+        return $this->belongsTo(config('zeus-bolt.models.User') ?? config('auth.providers.users.model'));
     }
 
     /** @return BelongsTo<Form, Response> */