CustomsFieldsMigrators contract

Author: ManukMinasyan

src/Contracts/CustomsFieldsMigrators.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Relaticle\CustomFields\Contracts;
+
+use Relaticle\CustomFields\Enums\CustomFieldType;
+use Relaticle\CustomFields\Models\CustomField;
+
+interface CustomsFieldsMigrators
+{
+    public function find(string $model, string $code): ?CustomsFieldsMigrators;
+    public function new(string $model, CustomFieldType $type, string $name, string $code, bool $active = true, bool $userDefined = false): CustomsFieldsMigrators;
+    public function options(array $options): CustomsFieldsMigrators;
+    public function lookupType(string $model): CustomsFieldsMigrators;
+    public function create(): void;
+    public function update(array $data): void;
+    public function delete(): void;
+    public function forceDelete(): void;
+    public function restore(): void;
+}

src/CustomFieldsServiceProvider.php

@@ -14,6 +14,8 @@
 use Livewire\Features\SupportTesting\Testable;
 use Livewire\Livewire;
 use Relaticle\CustomFields\Commands\FilamentCustomFieldCommand;
+use Relaticle\CustomFields\Contracts\CustomsFieldsMigrators;
+use Relaticle\CustomFields\Migrations\CustomFieldsMigrator;
 use Relaticle\CustomFields\Models\CustomField;
 use Relaticle\CustomFields\Testing\TestsFilamentCustomField;
 use Spatie\LaravelPackageTools\Commands\InstallCommand;
@@ -28,6 +30,8 @@ class CustomFieldsServiceProvider extends PackageServiceProvider
 
     public function bootingPackage()
     {
+        $this->app->singleton(CustomsFieldsMigrators::class, CustomFieldsMigrator::class);
+
         if (config('custom-fields.tenant_aware', false) && Filament::hasTenancy()) {
             $tenantModel = Filament::getTenantModel();
             $tenantModelInstance = app($tenantModel);

src/Filament/Forms/Components/CustomFieldsComponent/SelectComponent.php

@@ -38,6 +38,7 @@ protected function configureLookup(Select $select, $lookupType): Select
         $recordTitleAttribute = FilamentResourceService::getRecordTitleAttribute($lookupType);
         $globalSearchableAttributes = FilamentResourceService::getGlobalSearchableAttributes($lookupType);
 
+        // TODO: Check tenant support for below queries and other lookups
         return $select
             ->getSearchResultsUsing(fn(string $search): array => $entityInstance->query()
                 ->whereAny($globalSearchableAttributes, 'like', "%{$search}%")

src/Migrations/CustomFieldsMigration.php

@@ -3,15 +3,16 @@
 namespace Relaticle\CustomFields\Migrations;
 
 use Illuminate\Database\Migrations\Migration;
+use Relaticle\CustomFields\Contracts\CustomsFieldsMigrators;
 
 abstract class CustomFieldsMigration extends Migration
 {
-    protected CustomFieldsMigrator $migrator;
+    protected CustomsFieldsMigrators $migrator;
 
     abstract public function up();
 
     public function __construct()
     {
-        $this->migrator = app(CustomFieldsMigrator::class);
+        $this->migrator = app(CustomsFieldsMigrators::class);
     }
 }

src/Migrations/CustomFieldsMigrator.php

@@ -3,14 +3,15 @@
 namespace Relaticle\CustomFields\Migrations;
 
 use Illuminate\Support\Facades\DB;
+use Relaticle\CustomFields\Contracts\CustomsFieldsMigrators;
 use Relaticle\CustomFields\Data\CustomFieldData;
 use Relaticle\CustomFields\Enums\CustomFieldType;
 use Relaticle\CustomFields\Exceptions\CustomFieldAlreadyExistsException;
 use Relaticle\CustomFields\Exceptions\CustomFieldDoesNotExistException;
 use Relaticle\CustomFields\Exceptions\FieldTypeNotOptionableException;
 use Relaticle\CustomFields\Models\CustomField;
 
-class CustomFieldsMigrator
+class CustomFieldsMigrator implements CustomsFieldsMigrators
 {
     private CustomFieldData $customFieldData;
 
@@ -102,11 +103,10 @@ public function create(): void
 
     /**
      * @param array $data
-     * @return CustomFieldsMigrator
+     * @return void
      * @throws CustomFieldDoesNotExistException
-     * @throws \Exception
      */
-    public function update(array $data): CustomFieldsMigrator
+    public function update(array $data): void
     {
         if (!$this->customField->exists) {
             throw CustomFieldDoesNotExistException::whenUpdating($this->customFieldData->code);
@@ -129,8 +129,6 @@ public function update(array $data): CustomFieldsMigrator
             DB::rollBack();
             throw $exception;
         }
-
-        return $this;
     }