IBX-4675: Improved autogenerate field definition name

ibexa · Jul 9, 2024 · 0363891 · 0363891
1 parent 59bad30
commit 0363891
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 11 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -385,6 +385,11 @@ parameters:
 			count: 1
 			path: src/bundle/Controller/ContentViewController.php
 
+		-
+			message: "#^Parameter \\#1 \\$fieldTypeIdentifier of method Ibexa\\\\Bundle\\\\AdminUi\\\\Controller\\\\FieldDefinitionController\\:\\:getFieldTypeLabel\\(\\) expects string, string\\|null given\\.$#"
+			count: 1
+			path: src/bundle/Controller/FieldDefinitionController.php
+
 		-
 			message: "#^Parameter \\#2 \\$fieldDefinition of method Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\ContentTypeService\\:\\:updateFieldDefinition\\(\\) expects Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\ContentType\\\\FieldDefinition, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\ContentType\\\\FieldDefinition\\|null given\\.$#"
 			count: 1

diff --git a/src/bundle/Controller/FieldDefinitionController.php b/src/bundle/Controller/FieldDefinitionController.php
@@ -19,22 +19,28 @@
 use Ibexa\Rest\Message;
 use Ibexa\Rest\Server\Controller as RestController;
 use Ibexa\Rest\Server\Values;
+use JMS\TranslationBundle\Annotation\Ignore;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
 
 final class FieldDefinitionController extends RestController
 {
-    /** @var \Ibexa\Contracts\Core\Repository\ContentTypeService */
-    private $contentTypeService;
+    private ContentTypeService $contentTypeService;
 
-    /** @var \Symfony\Component\Routing\Generator\UrlGeneratorInterface */
-    private $urlGenerator;
+    private UrlGeneratorInterface $urlGenerator;
 
-    public function __construct(ContentTypeService $contentTypeService, UrlGeneratorInterface $urlGenerator)
-    {
+    private TranslatorInterface $translator;
+
+    public function __construct(
+        ContentTypeService $contentTypeService,
+        UrlGeneratorInterface $urlGenerator,
+        TranslatorInterface $translator
+    ) {
         $this->contentTypeService = $contentTypeService;
         $this->urlGenerator = $urlGenerator;
+        $this->translator = $translator;
     }
 
     public function addFieldDefinitionAction(
@@ -59,7 +65,9 @@ public function addFieldDefinitionAction(
 
         $fieldDefinitionCreateStruct->fieldGroup = $input->fieldGroupIdentifier;
         $fieldDefinitionCreateStruct->names = [
-            $language->languageCode => 'New field type',
+            $language->languageCode => strtr('New %name%', [
+                '%name%' => $this->getFieldTypeLabel($input->fieldTypeIdentifier),
+            ]),
         ];
 
         $fieldDefinitionCreateStruct->position = $input->position ?? $this->getNextFieldPosition($contentTypeDraft);
@@ -167,4 +175,19 @@ private function getNextFieldPosition(ContentType $contentType): int
 
         return 0;
     }
+
+    /**
+     * Generate a human-readable name for field type identifier.
+     */
+    private function getFieldTypeLabel(string $fieldTypeIdentifier): string
+    {
+        $name = $this->translator->trans(
+            /** @Ignore */
+            $fieldTypeIdentifier . '.name',
+            [],
+            'ibexa_fieldtypes'
+        );
+
+        return mb_strtolower($name);
+    }
 }
diff --git a/src/bundle/Resources/public/js/scripts/admin.contenttype.edit.js b/src/bundle/Resources/public/js/scripts/admin.contenttype.edit.js
@@ -459,7 +459,9 @@
             const targetContainerGroup = targetContainer.closest('.ibexa-collapse--field-definitions-group');
             const targetContainerList = targetContainerGroup.closest('.ibexa-content-type-edit__field-definitions-group-list');
             const fieldTemplate = targetContainerList.dataset.template;
-            const fieldRendered = fieldTemplate.replace('{{ type }}', currentDraggedItem.dataset.itemIdentifier);
+            const fieldRendered = fieldTemplate
+                .replace('{{ name }}', currentDraggedItem.dataset.itemName.toLowerCase())
+                .replace('{{ type }}', currentDraggedItem.dataset.itemIdentifier);
             let draggedItemPosition = [...dragContainerItems].findIndex((item, index, array) => {
                 return item.classList.contains('ibexa-field-definitions-placeholder') && index < array.length - 1;
             });

diff --git a/src/bundle/Resources/translations/ibexa_content_type.en.xliff b/src/bundle/Resources/translations/ibexa_content_type.en.xliff
@@ -322,8 +322,8 @@
         <note>key: content_type.view.edit.content_field_definitions</note>
       </trans-unit>
       <trans-unit id="74aead78c735bbbce032dc9b00f9ca7a3632f166" resname="content_type.view.edit.default_header">
-        <source>New field type</source>
-        <target state="new">New field type</target>
+        <source>New {{ name }} ({{ type }})</source>
+        <target state="new">New {{ name }} ({{ type }})</target>
         <note>key: content_type.view.edit.default_header</note>
       </trans-unit>
       <trans-unit id="a32a5e3d2d67da43b4c5f0f5574c90520868b36a" resname="content_type.view.edit.global_properties">

diff --git a/src/bundle/Resources/views/themes/admin/content_type/available_field_types.html.twig b/src/bundle/Resources/views/themes/admin/content_type/available_field_types.html.twig
@@ -18,6 +18,7 @@
         {% for item in field_type_toolbar %}
             <li
                 class="ibexa-available-field-type {{ is_draggable is defined and is_draggable == false ? 'ibexa-available-field-type--immovable' }}"
+                data-item-name="{{ item.name }}"
                 data-item-identifier="{{ item.identifier }}"
             >
                 <div

diff --git a/src/bundle/Resources/views/themes/admin/content_type/field_definitions.html.twig b/src/bundle/Resources/views/themes/admin/content_type/field_definitions.html.twig
@@ -16,7 +16,7 @@
             'is_draggable': true,
             'class': 'ibexa-collapse--field-definition ibexa-collapse--field-definition-highlight ibexa-collapse--field-definition-loading',
             'body_id': 'loading-collapse',
-            'header_label': 'content_type.view.edit.default_header'|trans|desc('New field type') ~ ' ({{ type }})',
+            'header_label': 'content_type.view.edit.default_header'|trans|desc('New {{ name }} ({{ type }})'),
             'data_attr': {
                 'data-field-definition-identifier': 'loading-collapse',
             },