Merge pull request LokiExtensions#10 from integer-net/4/custom-fields-2

LokiExtensions#4 [fix] Custom fields configured via layout xml file are not appearing in the form

Author: jissereitsma

Form/FieldResolver.php

@@ -19,92 +19,149 @@ public function __construct(
     public function resolve(FormRepository $formRepository, array $fieldDefinitions): array
     {
         $resourceModel = $formRepository->getResourceModel();
-        if (!$resourceModel) {
+
+        if ($resourceModel === null) {
             return [];
         }
 
-        $fields = [];
-        $tableColumns = $resourceModel->getConnection()->describeTable($resourceModel->getMainTable());
+        $tableColumns = $this->getTableColumns($resourceModel);
+        $fieldColumns = $this->mergeTableAndExtraColumns(
+            $tableColumns,
+            $fieldDefinitions
+        );
 
-        foreach ($tableColumns as $tableColumn) {
-            $columnName = $tableColumn['COLUMN_NAME'];
-            $fieldType = $this->getFieldTypeCodeFromColumn($formRepository, $tableColumn);
-            if ($columnName === $resourceModel->getIdFieldName()) {
-                $fieldType = 'view';
-            }
+        $fields = $this->buildFields(
+            $formRepository,
+            $tableColumns,
+            $fieldColumns,
+            $fieldDefinitions
+        );
 
-            $fieldLabel = $this->getLabelByColumn($tableColumn['COLUMN_NAME']);
-            $code = $tableColumn['COLUMN_NAME'];
+        $this->sortFieldsBySortOrder($fields);
 
-            if (empty($fieldType)) {
-                $fieldType = 'input';
-            }
+        return $fields;
+    }
 
-            $block = $this->layout->createBlock(Template::class);
-            $fieldData = [
-                'field_type' => $fieldType,
-                'code' => $code,
-                'label' => $fieldLabel,
-                'required' => false,
-                'sort_order' => 0,
-                'field_attributes' => [],
-                'label_attributes' => [],
-            ];
-
-            if (array_key_exists($columnName, $fieldDefinitions)) {
-                $fieldDefinition = (array)$fieldDefinitions[$columnName];
-                $fieldData = array_merge($fieldData, $fieldDefinition);
-            }
+    private function getTableColumns(object $resourceModel): array
+    {
+        return $resourceModel
+            ->getConnection()
+            ->describeTable($resourceModel->getMainTable());
+    }
 
-            $fields[$code] = $this->fieldFactory->create(
-                $block,
-                $fieldData,
+    private function mergeTableAndExtraColumns(
+        array $tableColumns,
+        array $fieldDefinitions
+    ): array {
+        $tableColumnNames = array_keys($tableColumns);
+
+        $extraFieldDefinitions = array_filter(
+            $fieldDefinitions,
+            static fn (array $definition, string $fieldCode): bool =>
+            !in_array($fieldCode, $tableColumnNames, true),
+            ARRAY_FILTER_USE_BOTH
+        );
+
+        return array_merge($tableColumns, $extraFieldDefinitions);
+    }
+
+    private function buildFields(
+        FormRepository $formRepository,
+        array $tableColumns,
+        array $fieldColumns,
+        array $fieldDefinitions
+    ): array {
+        $fields = [];
+
+        foreach ($fieldColumns as $fieldCode => $definition) {
+            $columnData = $this->buildBaseColumnData(
+                $formRepository,
+                $tableColumns,
+                $fieldCode
             );
-        }
 
-        uasort($fields, function (Field $field1, Field $field2) {
-            return $field1->getSortOrder() <=> $field2->getSortOrder();
-        });
+            if (array_key_exists($fieldCode, $fieldDefinitions)) {
+                $columnData = array_merge(
+                    $columnData,
+                    $fieldDefinitions[$fieldCode]
+                );
+            }
+
+            $fields[$fieldCode] = $this->createField($columnData);
+        }
 
         return $fields;
     }
 
-    private function getFieldTypeCodeFromColumn(FormRepository $formRepository, array $tableColumn): false|string
-    {
-        if ($tableColumn['COLUMN_NAME'] === $formRepository->getPrimaryKey()) {
-            return 'view';
-        }
+    private function buildBaseColumnData(
+        FormRepository $formRepository,
+        array $tableColumns,
+        string $fieldCode
+    ): array {
+        $columnData = ['code' => $fieldCode];
 
-        if (in_array($tableColumn['DATA_TYPE'], ['datetime'])) {
-            return 'datetime';
+        if (!array_key_exists($fieldCode, $tableColumns)) {
+            return $columnData;
         }
 
-        if (in_array($tableColumn['DATA_TYPE'], ['date'])) {
-            return 'date';
-        }
+        $tableColumn = $tableColumns[$fieldCode];
+        $fieldType = $this->resolveFieldType(
+            $formRepository,
+            $tableColumn
+        );
+
+        return array_merge($columnData, [
+            'field_type' => $fieldType ?: 'input',
+            'label' => $this->getLabelByColumn($tableColumn['COLUMN_NAME']),
+            'required' => false,
+            'sort_order' => 0,
+            'field_attributes' => [],
+            'label_attributes' => [],
+        ]);
+    }
 
-        if (in_array($tableColumn['DATA_TYPE'], ['tinyint'])) {
-            return 'switch';
-        }
+    private function createField(array $columnData): Field
+    {
+        return $this->fieldFactory->create(
+            $this->layout->createBlock(Template::class),
+            $columnData,
+        );
+    }
 
-        if (in_array($tableColumn['DATA_TYPE'], ['int'])) {
-            return 'number';
-        }
+    private function sortFieldsBySortOrder(array &$fields): void
+    {
+        uasort(
+            $fields,
+            static fn (Field $a, Field $b): int =>
+                $a->getSortOrder() <=> $b->getSortOrder()
+        );
+    }
 
-        if (in_array($tableColumn['DATA_TYPE'], ['varchar', 'text', 'smalltext', 'mediumtext'])) {
-            return 'input';
+    private function resolveFieldType(
+        FormRepository $formRepository,
+        array $tableColumn
+    ): false|string {
+        if ($tableColumn['COLUMN_NAME'] === $formRepository->getPrimaryKey()) {
+            return 'view';
         }
 
-        return false;
+        return match ($tableColumn['DATA_TYPE']) {
+            'datetime' => 'datetime',
+            'date' => 'date',
+            'tinyint' => 'switch',
+            'int' => 'number',
+            'varchar', 'text', 'smalltext', 'mediumtext' => 'input',
+            default => false,
+        };
     }
 
     private function getLabelByColumn(string $columnName): string
     {
-        $label = (string)__($columnName);
-        if ($label !== $columnName) {
-            return $label;
+        $translated = (string) __($columnName);
+        if ($translated !== $columnName) {
+            return $translated;
         }
 
-        return ucfirst(str_replace('_', ' ', $label));
+        return ucfirst(str_replace('_', ' ', $columnName));
     }
 }