refactor: enhance BaseConverter and related classes with key and group parameters

Author: cklei-carly

src/Fields/Converters/BaseConverter.php

@@ -11,17 +11,38 @@ abstract class BaseConverter
 {
     use Macroable;
 
-    protected FieldTypeConfig $fieldTypeConfig;
+    /**
+     * @var FieldTypeConfig
+     */
+    protected $fieldTypeConfig;
+
+    /**
+     * @var string|null
+     */
+    protected $fieldKey;
+
+    /**
+     * @var string|null
+     */
+    protected $fieldGroupKey;
 
     /**
      * @var array<class-string<BaseConverter>, array<Closure>>
      */
     protected static $configurations = [];
 
-    public function __construct(FieldTypeConfig $fieldTypeConfig)
+    /**
+     * @param \SolutionForest\FilamentFieldGroup\FieldTypes\Configs\Contracts\FieldTypeConfig $fieldTypeConfig
+     * @param ?string $group
+     * @param ?string $key
+     */
+    public function __construct(FieldTypeConfig $fieldTypeConfig, $group, $key)
     {
         $this->fieldTypeConfig = $fieldTypeConfig;
 
+        $this->fieldKey = $key;
+        $this->fieldGroupKey = $group;
+
         $this->configure();
     }
 
@@ -42,7 +63,35 @@ protected function applyLocaleConversion(mixed $sourceValue, ?string $locale, ?s
 
     protected function isFieldTypeTranslatable(): bool
     {
-        return $this->fieldTypeConfig->isTranslatable();
+        return $this->getFieldTypeConfig()->isTranslatable();
+    }
+
+    public function getFieldTypeConfig(): FieldTypeConfig
+    {
+        return $this->fieldTypeConfig;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getKey()
+    {
+        return $this->fieldKey;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getGroup()
+    {
+        return $this->fieldGroupKey;
+    }
+
+    public function getFieldIdentifier(): string
+    {
+        return collect([$this->getGroup(), $this->getKey()])
+            ->filter()
+            ->implode('.');
     }
 
     public static function configureUsing(Closure $modifyUsing)

src/Fields/Converters/RepeaterConverter.php

@@ -46,7 +46,12 @@ public function toDisplayValue(mixed $sourceValue, ?string $locale, ?string $fal
                     continue;
                 }
 
-                $innerFieldConverter = $this->tryGetConverterForInnerField($innerPropertyType);
+                $innerFieldConverter = $this->tryGetConverterForInnerField(
+                    $innerPropertyType,
+                    implode('.', [$this->getFieldIdentifier(), $i]),
+                    $key
+                );
+
                 if (is_null($innerFieldConverter)) {
                     continue;
                 }
@@ -106,13 +111,14 @@ private function tryGetDisplayValueForInnerField($convert, $sourceValue, $locale
         }
     }
 
-    private function tryGetConverterForInnerField($fieldTypeConfig): ?BaseConverter
+    private function tryGetConverterForInnerField($fieldTypeConfig, $group, $key): ?BaseConverter
     {
         try {
 
             $transformer = app(PropertyValueTransformerInterface::class);
+            
 
-            return $transformer->getConverter($fieldTypeConfig);
+            return $transformer->getConverter($fieldTypeConfig, $key, $group);
 
         } catch (\Throwable $th) {
 

src/Fields/PropertyValueTransformer.php

@@ -14,7 +14,9 @@ class PropertyValueTransformer implements PropertyValueTransformerInterface
 {
     public function transform(PropertyDataDto $propertyDataDto, ?string $locale, ?string $fallbackLocale)
     {
-        $converter = $this->getConverter($propertyDataDto?->propertyType?->config);
+        $propType = $propertyDataDto->propertyType;
+
+        $converter = $this->getConverter($propType?->config, $propType?->key, $propType?->group);
 
         return $converter->toDisplayValue($propertyDataDto->getSourceValue(), $locale, $fallbackLocale);
     }
@@ -34,7 +36,7 @@ public function attemptTransform(PropertyDataDto $propertyDataDto, ?string $loca
         }
     }
 
-    public function getConverter($fieldType)
+    public function getConverter($fieldType, $key, $group)
     {
         if ($fieldType === null) {
             throw new \InvalidArgumentException('No field type specified.');
@@ -57,6 +59,8 @@ public function getConverter($fieldType)
 
         return app($converter, [
             'fieldTypeConfig' => $fieldType,
+            'key' => $key,
+            'group' => $group,
         ]);
     }
 }

src/Fields/PropertyValueTransformerInterface.php

@@ -16,9 +16,12 @@ public function attemptTransform(PropertyDataDto $propertyDataDto, ?string $loca
      * Get the converter for the specified field type.
      *
      * @param  ?FieldTypeConfig  $fieldType  The type of the field for which the converter is needed.
+     * @param ?string $key The key of the field.
+     * @param ?string $group The group of the field.
+     * 
      * @return BaseConverter The converter for the specified field type.
      *
      * @throws \InvalidArgumentException If no field type is specified, or if no converter is found for the specified field type.
      */
-    public function getConverter($fieldType);
+    public function getConverter($fieldType, $key, $group);
 }