Additional work on grids and form arguments

Author: jissereitsma

.module.ini

@@ -3,3 +3,5 @@ EXTENSION_NAME=AdminComponents
 COMPOSER_NAME=loki/magento2-admin-components
 PHP_VERSIONS=("8.1","8.2","8.3","8.4")
 PHPSTAN_LEVEL=1
+SKIP_CSS_UTILS=1
+

Component/Form/FormViewModel.php

@@ -107,6 +107,9 @@ public function getFields(): array
         foreach ($tableColumns as $tableColumn) {
             $columnName = $tableColumn['COLUMN_NAME'];
             $fieldTypeCode = $this->getFieldTypeCodeFromColumn($tableColumn);
+            $fieldLabel = $this->getLabelByColumn($tableColumn['COLUMN_NAME']);
+            $sortOrder = 0;
+
             if (empty($fieldTypeCode)) {
                 // @todo: echo 'Unknown field type: '.$tableColumn['DATA_TYPE'];
                 continue;
@@ -117,8 +120,17 @@ public function getFields(): array
 
             if (array_key_exists($columnName, $fieldDefinitions)) {
                 $fieldDefinition = (array)$fieldDefinitions[$columnName];
+
                 if (isset($fieldDefinition['field_type'])) {
-                    $fieldTypeCode = $fieldDefinition['field_type'];
+                    $fieldTypeCode = (string)$fieldDefinition['field_type'];
+                }
+
+                if (isset($fieldDefinition['label'])) {
+                    $fieldLabel = (string)$fieldDefinition['label'];
+                }
+
+                if (isset($fieldDefinition['sortOrder'])) {
+                    $sortOrder = (int)$fieldDefinition['sortOrder'];
                 }
 
                 if (isset($fieldDefinition['html_attributes'])) {
@@ -131,13 +143,18 @@ public function getFields(): array
             $fields[] = $this->fieldFactory->create(
                 $block,
                 $fieldTypeCode,
-                $this->getLabelByColumn($tableColumn['COLUMN_NAME']),
+                $fieldLabel,
                 $tableColumn['COLUMN_NAME'],
                 false, // @todo
-                $htmlAttributes
+                $htmlAttributes,
+                $sortOrder
             );
         }
 
+        usort($fields, function (Field $field1, Field $field2) {
+            return $field1->getSortOrder() <=> $field2->getSortOrder();
+        });
+
         return $fields;
     }
 
@@ -181,7 +198,8 @@ private function getIndexUri(): string
         $currentUri = (string)$this->request->getParam('currentUri');
         if (!empty($currentUri)) {
             $currentUriParts = explode('_', $currentUri);
-            return $currentUriParts[0] . '/' . $currentUriParts[1] . '/index';
+
+            return $currentUriParts[0].'/'.$currentUriParts[1].'/index';
         }
 
         return '*/*/index';

Form/Field/Field.php

@@ -14,6 +14,7 @@ public function __construct(
         private string $code,
         private bool $required = false,
         private array $htmlAttributes = [],
+        private int $sortOrder = 0,
         private string $scope = 'item'
     ) {
     }
@@ -52,4 +53,9 @@ public function getHtmlAttributes(): array
     {
         return $this->htmlAttributes;
     }
+
+    public function getSortOrder(): int
+    {
+        return $this->sortOrder;
+    }
 }

Form/Field/FieldFactory.php

@@ -36,7 +36,8 @@ public function create(
         string $label,
         string $code,
         bool $required = false,
-        array $htmlAttributes = []
+        array $htmlAttributes = [],
+        int $sortOrder = 0
     ): Field {
         $fieldType = $this->fieldTypeProvider->getFieldTypeByCode($fieldTypeCode);
 
@@ -47,6 +48,7 @@ public function create(
             'code' => $code,
             'required' => $required,
             'htmlAttributes' => $htmlAttributes,
+            'sortOrder' => $sortOrder,
         ]);
     }
 }

Form/Field/FieldType/Textarea.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace Loki\AdminComponents\Form\Field\FieldType;
+
+use Loki\AdminComponents\Form\Field\FieldTypeInterface;
+
+class Textarea implements FieldTypeInterface
+{
+    public function getTemplate(): string
+    {
+        return 'Loki_AdminComponents::form/field_type/textarea.phtml';
+    }
+}

etc/di.xml

@@ -29,6 +29,7 @@
             <argument name="fieldTypes" xsi:type="array">
                 <item name="view" xsi:type="object">Loki\AdminComponents\Form\Field\FieldType\View</item>
                 <item name="text" xsi:type="object">Loki\AdminComponents\Form\Field\FieldType\Text</item>
+                <item name="textarea" xsi:type="object">Loki\AdminComponents\Form\Field\FieldType\Textarea</item>
                 <item name="date" xsi:type="object">Loki\AdminComponents\Form\Field\FieldType\Date</item>
                 <item name="datetime" xsi:type="object">Loki\AdminComponents\Form\Field\FieldType\Datetime</item>
                 <item name="number" xsi:type="object">Loki\AdminComponents\Form\Field\FieldType\Number</item>

view/adminhtml/templates/form/field_type/textarea.phtml

@@ -0,0 +1,31 @@
+<?php
+declare(strict_types=1);
+
+/** @version 0.2.3 */
+
+use Magento\Framework\Escaper;
+use Magento\Framework\View\Element\Template;
+use Loki\AdminComponents\Form\Field\Field;
+use Loki\AdminComponents\Form\Field\FieldType\Textarea;
+use Loki\Components\Util\Block\TemplateRenderer;
+
+/** @var Escaper $escaper */
+/** @var Template $block */
+/** @var Field $field */
+/** @var Textarea $fieldType */
+/** @var TemplateRenderer $templateRenderer */
+
+$field = $block->getField();
+$htmlAttributes = $field->getHtmlAttributes();
+$fieldType = $field->getFieldType();
+?>
+<textarea
+    class="<?= $css('admin__control-text', '@todo') ?>"
+    name="<?= $escaper->escapeHtml($field->getCode()) ?>"
+    data-name="<?= $escaper->escapeHtml($field->getCode()) ?>"
+    <?php foreach ($htmlAttributes as $htmlAttributeName => $htmlAttributeValue) : ?>
+        <?= /* @noEscape */ $htmlAttributeName ?>="<?= /* @noEscape */ $htmlAttributeValue ?>"
+    <?php endforeach; ?>
+    :value="<?= $escaper->escapeHtml($field->getScope()) ?>.<?= $escaper->escapeHtml($field->getCode()) ?>"
+    @change="setValue"
+></textarea>