IBX-4629: Implement Meta field groups

src/bundle/DependencyInjection/Configuration/Parser/AdminUiForms.php

@@ -29,6 +29,7 @@ class AdminUiForms extends AbstractParser
 {
     public const FORM_TEMPLATES_PARAM = 'admin_ui_forms.content_edit_form_templates';
     public const FIELD_TYPES_PARAM = 'admin_ui_forms.content_edit.fieldtypes';
+    public const META_FIELD_GROUPS_LIST_PARAM = 'admin_ui_forms.content_edit.meta_field_groups_list';
     public const CONTENT_TYPE_FIELD_TYPES_PARAM = 'admin_ui_forms.content_type_edit.field_types';
     public const CONTENT_TYPE_DEFAULT_META_FIELD_TYPE_GROUP_PARAM =
         'admin_ui_forms.content_type_edit.default_meta_field_type_group';
@@ -87,6 +88,12 @@ public function addSemanticConfig(NodeBuilder $nodeBuilder)
                                     ->end()
                                 ->end()
                             ->end()
+                            ->arrayNode('meta_field_groups_list')
+                                ->performNoDeepMerging()
+                                ->scalarPrototype()->end()
+                                ->info('List of field groups that would be placed under a meta section in a content form')
+                                ->defaultValue(['metadata'])
+                            ->end()
                         ->end()
                     ->end()
                     ->arrayNode('content_type_edit')
@@ -156,6 +163,12 @@ public function mapConfig(
             unset($scopeSettings['admin_ui_forms']['content_edit']['fieldtypes']);
         }
 
+        if (!empty($scopeSettings['admin_ui_forms']['content_edit']['meta_field_groups_list'])) {
+            $scopeSettings['admin_ui_forms.content_edit.meta_field_groups_list'] =
+                $scopeSettings['admin_ui_forms']['content_edit']['meta_field_groups_list'];
+            unset($scopeSettings['admin_ui_forms']['content_edit']['meta_field_groups_list']);
+        }
+
         if (!empty($scopeSettings['admin_ui_forms']['content_type_edit']['field_types'])) {
             $scopeSettings['admin_ui_forms.content_type_edit.field_types'] =
                 $scopeSettings['admin_ui_forms']['content_type_edit']['field_types'];
@@ -178,6 +191,11 @@ public function mapConfig(
             $currentScope,
             $scopeSettings['admin_ui_forms.content_edit.fieldtypes'] ?? []
         );
+        $contextualizer->setContextualParameter(
+            self::META_FIELD_GROUPS_LIST_PARAM,
+            $currentScope,
+            $scopeSettings['admin_ui_forms.content_edit.meta_field_groups_list'] ?? []
+        );
         $contextualizer->setContextualParameter(
             self::CONTENT_TYPE_FIELD_TYPES_PARAM,
             $currentScope,
@@ -197,6 +215,7 @@ public function postMap(array $config, ContextualizerInterface $contextualizer)
     {
         $contextualizer->mapConfigArray('admin_ui_forms.content_edit_form_templates', $config);
         $contextualizer->mapConfigArray('admin_ui_forms.content_edit.fieldtypes', $config);
+        $contextualizer->mapConfigArray('admin_ui_forms.content_edit.meta_field_groups_list', $config);
         $contextualizer->mapConfigArray('admin_ui_forms.content_type_edit.field_types', $config);
         $contextualizer->mapSetting('admin_ui_forms.content_type_edit.default_meta_field_type_group', $config);
     }

src/bundle/Resources/config/admin_ui_forms.yaml

@@ -2,6 +2,8 @@ system:
     admin_group:
         admin_ui_forms:
             content_edit:
+                meta_field_groups_list:
+                    - metadata
                 form_templates:
                     - { template: '@ibexadesign/content/form_fields.html.twig', priority: 0 }
 

src/bundle/Resources/views/themes/admin/content/components/meta_fields.html.twig

@@ -5,7 +5,7 @@
 {% block sections %}
     {% for identifier in meta_fields %}
         {% embed '@ibexadesign/ui/component/anchor_navigation/section.html.twig' with {'form': form, 'identifier': identifier} %}
-            {% set data_id = 'ibexa-edit-content-sections-meta-' ~ identifier %}
+            {% set data_id = '#ibexa-edit-content-sections-meta-' ~ identifier %}
             {% block content %}
                 {% from '@ibexadesign/content/edit_macros.html.twig' import render_form_field %}
 

src/lib/Behat/BrowserContext/ContentUpdateContext.php

@@ -51,11 +51,10 @@ public function verifyFieldIsNotEditable(string $fieldName): void
     }
 
     /**
-     * @When the :fieldName field in :fieldGroup field group cannot be edited due to limitation
+     * @When the :fieldName field cannot be edited due to limitation
      */
-    public function theFieldCannotBeEditedDueToLimitation(string $fieldName, string $fieldGroup): void
+    public function fieldCannotBeEditedDueToLimitation(string $fieldName): void
     {
-        $this->contentUpdateItemPage->switchToFieldGroup($fieldGroup);
         $this->contentUpdateItemPage->verifyFieldCannotBeEditedDueToLimitation($fieldName);
     }
 
@@ -114,6 +113,15 @@ public function iSwitchToContentTab(string $tabName)
         $this->contentUpdateItemPage->switchToFieldGroup($tabName);
     }
 
+    /**
+     * @When I switch to :tabName field tab
+     */
+    public function iSwitchToContentGroup(string $tabName)
+    {
+        $this->contentUpdateItemPage->verifyIsLoaded();
+        $this->contentUpdateItemPage->switchToFieldTab($tabName);
+    }
+
     /**
      * @When I wait for Content Item to be autosaved
      */

src/lib/Behat/Page/ContentUpdateItemPage.php

@@ -100,6 +100,7 @@ protected function specifyLocators(): array
             new VisibleCSSLocator('noneditableFieldClass', 'ibexa-field-edit--eznoneditable'),
             new VisibleCSSLocator('fieldOfType', '.ibexa-field-edit--%s'),
             new VisibleCSSLocator('navigationTabs', '.ibexa-anchor-navigation-menu__sections-item-btn'),
+            new VisibleCSSLocator('navigationGroups', '.ibexa-anchor-navigation-menu__section-groups-item'),
             new VisibleCSSLocator('autosaveIsOnInfo', '.ibexa-autosave__status-on'),
             new VisibleCSSLocator('autosaveSavedInfo', '.ibexa-autosave__status-saved'),
             new VisibleCSSLocator('autosaveIsOffInfo', '.ibexa-autosave__status-off'),
@@ -189,9 +190,20 @@ public function switchToFieldGroup(string $tabName): void
             ->waitUntilCondition(new ElementHasTextCondition($this->getHTMLPage(), new VisibleCSSLocator('activeSection', '.ibexa-anchor-navigation-menu__sections-item-btn--active'), $tabName));
     }
 
+    public function switchToFieldTab(string $tabName): void
+    {
+        $this->getHTMLPage()->setTimeout(3)
+            ->findAll($this->getLocator('navigationGroups'))
+            ->getByCriterion(new ElementTextCriterion($tabName))
+            ->click();
+        $this->getHTMLPage()
+            ->setTimeout(10)
+            ->waitUntilCondition(new ElementHasTextCondition($this->getHTMLPage(), new VisibleCSSLocator('activeSection', '.ibexa-anchor-navigation-menu__section-groups-item--active'), $tabName));
+    }
+
     public function verifyFieldCannotBeEditedDueToLimitation(string $fieldName)
     {
-        $activeSections = $this->getHTMLPage()->findAll(new VisibleCSSLocator('activeSection', '.ibexa-anchor-navigation-menu__sections-item-btn--active'));
+        $activeSections = $this->getHTMLPage()->findAll(new VisibleCSSLocator('activeSection', '.ibexa-anchor-navigation-menu__section-groups-item--active'));
         $fieldLocator = new VisibleCSSLocator('', sprintf($this
             ->getLocator('fieldGroupNthField')->getSelector(), $activeSections->single()->getAttribute('data-target-id'), $this->getFieldPosition($fieldName)));
         $this->getHTMLPage()->find($fieldLocator)->assert()->hasClass('ibexa-field-edit--disabled');

src/lib/Component/Content/ContentEditMetaFieldsComponent.php

@@ -9,7 +9,10 @@
 namespace Ibexa\AdminUi\Component\Content;
 
 use Ibexa\Contracts\AdminUi\Component\Renderable;
+use Ibexa\Contracts\Core\Repository\Values\ContentType\ContentType;
+use Ibexa\Contracts\Core\Repository\Values\ContentType\FieldDefinitionCollection;
 use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
+use Ibexa\Core\Repository\Values\ContentType\FieldDefinition;
 use Twig\Environment;
 
 class ContentEditMetaFieldsComponent implements Renderable
@@ -39,17 +42,21 @@ public function render(array $parameters = []): string
         $contentType = $parameters['content_type'];
 
         $metaFieldTypeIdentifiers = $this->getMetaFieldTypeIdentifiers();
+        $metaFieldDefinitionCollection = $this->getMetaFieldDefinitionCollection($contentType);
 
-        if (empty($metaFieldTypeIdentifiers)) {
+        if (empty($metaFieldTypeIdentifiers) && $metaFieldDefinitionCollection->isEmpty()) {
             return self::NO_CONTENT;
         }
 
-        $parameters['meta_fields'] = [];
+        $metaFields = $this->mapMetaFieldDefinitionCollectionToIdentifiers($metaFieldDefinitionCollection);
+
         foreach ($metaFieldTypeIdentifiers as $identifier) {
             $fields = $contentType->getFieldDefinitionsOfType($identifier);
-            $parameters['meta_fields'] = array_merge($parameters['meta_fields'], array_column($fields->toArray(), 'identifier'));
+            $metaFields = array_merge($metaFields, array_column($fields->toArray(), 'identifier'));
         }
 
+        $parameters['meta_fields'] = array_unique($metaFields);
+
         return $this->twig->render(
             '@ibexadesign/content/components/meta_fields.html.twig',
             $parameters
@@ -70,4 +77,24 @@ private function getMetaFieldTypeIdentifiers(): array
             )
         );
     }
+
+    private function getMetaFieldDefinitionCollection(ContentType $contentType): FieldDefinitionCollection
+    {
+        $metaFieldGroups = $this->configResolver->getParameter(
+            'admin_ui_forms.content_edit.meta_field_groups_list'
+        );
+
+        return $contentType->fieldDefinitions->filter(
+            static fn (FieldDefinition $field): bool => in_array($field->fieldGroup, $metaFieldGroups, true),
+        );
+    }
+
+    /**
+     * @return array<string>
+     */
+    private function mapMetaFieldDefinitionCollectionToIdentifiers(
+        FieldDefinitionCollection $metaFieldDefinitionCollection
+    ): array {
+        return array_column($metaFieldDefinitionCollection->toArray(), 'identifier');
+    }
 }

src/lib/EventListener/SetViewParametersListener.php

@@ -27,6 +27,7 @@
 use Ibexa\Core\MVC\Symfony\View\View;
 use Ibexa\Core\MVC\Symfony\View\ViewEvents;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Form\FormInterface;
 
 /**
  * @todo It should use ViewEvents::FILTER_VIEW_PARAMETERS event instead.
@@ -276,7 +277,21 @@ private function getIgnoredContentFields(array $fieldsData): array
             $ignoredFieldIdentifiers[] = $fieldIdentifier;
         }
 
-        return $ignoredFieldIdentifiers;
+        $metaFieldGroups = $this->configResolver->getParameter(
+            'admin_ui_forms.content_edit.meta_field_groups_list'
+        );
+        $metaFieldIdentifiers = array_keys(
+            array_filter(
+                $fieldsData,
+                static fn (FormInterface $field): bool => in_array(
+                    $field->getData()->fieldDefinition->fieldGroup,
+                    $metaFieldGroups,
+                    true
+                )
+            )
+        );
+
+        return array_merge($ignoredFieldIdentifiers, $metaFieldIdentifiers);
     }
 }
 

src/lib/Form/Provider/GroupedNonMetaFormFieldsProvider.php

@@ -10,6 +10,7 @@
 
 use Ibexa\Contracts\ContentForms\Content\Form\Provider\GroupedContentFormFieldsProviderInterface;
 use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
+use Symfony\Component\Form\FormInterface;
 
 final class GroupedNonMetaFormFieldsProvider implements GroupedContentFormFieldsProviderInterface
 {
@@ -28,16 +29,34 @@ public function __construct(
     public function getGroupedFields(array $fieldsDataForm): array
     {
         $identifiers = $this->getMetaFields();
+        $metaFieldGroups = $this->getMetaFieldGroups();
+
+        $metaFieldIdentifiers = array_keys(
+            array_filter(
+                $fieldsDataForm,
+                static fn (FormInterface $field): bool => in_array(
+                    $field->getData()->fieldDefinition->fieldGroup,
+                    $metaFieldGroups,
+                    true
+                )
+            )
+        );
 
         $groupedFields = $this->innerGroupedContentFormFieldsProvider->getGroupedFields($fieldsDataForm);
         foreach ($groupedFields as $group => $fields) {
             $groupedFields[$group] = array_filter(
                 $fields,
-                static function (string $fieldIdentifier) use ($fieldsDataForm, $identifiers): bool {
+                static function (string $fieldIdentifier) use (
+                    $fieldsDataForm,
+                    $identifiers,
+                    $metaFieldIdentifiers
+                ): bool {
                     $fieldData = $fieldsDataForm[$fieldIdentifier]->getNormData();
                     $fieldTypeIdentifier = $fieldData->fieldDefinition->fieldTypeIdentifier;
+                    $fieldIdentifier = $fieldData->fieldDefinition->identifier;
 
-                    return !in_array($fieldTypeIdentifier, $identifiers, true);
+                    return !in_array($fieldTypeIdentifier, $identifiers, true)
+                        && !in_array($fieldIdentifier, $metaFieldIdentifiers, true);
                 }
             );
         }
@@ -59,4 +78,12 @@ private function getMetaFields(): array
             )
         );
     }
+
+    /**
+     * @return array<string>
+     */
+    private function getMetaFieldGroups(): array
+    {
+        return $this->configResolver->getParameter('admin_ui_forms.content_edit.meta_field_groups_list');
+    }
 }

src/lib/Menu/ContentEditAnchorMenuBuilder.php

@@ -126,8 +126,24 @@ private function getMetaFieldItems(ContentType $contentType): array
             static fn (array $config): bool => true === $config['meta']
         ));
 
+        $metaFieldGroups = $this->configResolver->getParameter(
+            'admin_ui_forms.content_edit.meta_field_groups_list'
+        );
+        $metaFieldDefinitionCollection = $contentType->fieldDefinitions->filter(
+            static fn (FieldDefinition $field): bool => in_array($field->fieldGroup, $metaFieldGroups, true),
+        );
+
         $items = [];
         $order = 0;
+        foreach ($metaFieldDefinitionCollection as $fieldDefinition) {
+            $order += self::ITEM_ORDER_SPAN;
+            $items[$fieldDefinition->identifier] = $this->createSecondLevelItem(
+                $fieldDefinition->identifier,
+                $fieldDefinition,
+                $order
+            );
+        }
+
         foreach ($metaFieldTypeIdentifiers as $metaFieldTypeIdentifier) {
             if (false === $contentType->hasFieldDefinitionOfType($metaFieldTypeIdentifier)) {
                 continue;
@@ -137,7 +153,11 @@ private function getMetaFieldItems(ContentType $contentType): array
             foreach ($fieldDefinitions as $fieldDefinition) {
                 $fieldDefIdentifier = $fieldDefinition->identifier;
                 $order += self::ITEM_ORDER_SPAN;
-                $items[$fieldDefIdentifier] = $this->createSecondLevelItem($fieldDefIdentifier, $fieldDefinition, $order);
+                $items[$fieldDefIdentifier] ??= $this->createSecondLevelItem(
+                    $fieldDefIdentifier,
+                    $fieldDefinition,
+                    $order
+                );
             }
         }
 

tests/bundle/DependencyInjection/Configuration/Parser/AdminUiFormsTest.php

@@ -58,7 +58,7 @@ public function testContentEditFormTemplatesAreMapped()
         ];
 
         $this->contextualizer
-            ->expects($this->atLeast(2))
+            ->expects(self::atLeast(2))
             ->method('setContextualParameter')
             ->withConsecutive(
                 [
@@ -99,7 +99,7 @@ public function testContentEditFieldTypesAreMapped(): void
         ];
 
         $this->contextualizer
-            ->expects($this->atLeast(2))
+            ->expects(self::atLeast(2))
             ->method('setContextualParameter')
             ->withConsecutive(
                 [
@@ -116,6 +116,47 @@ public function testContentEditFieldTypesAreMapped(): void
 
         $this->parser->mapConfig($scopeSettings, $currentScope, $this->contextualizer);
     }
+
+    /**
+     * Test 'meta_field_groups_list' fieldtype settings are mapped.
+     */
+    public function testContentEditMetaFieldgroupListIsMapped(): void
+    {
+        $scopeSettings = [
+            'admin_ui_forms' => [
+                'content_edit' => [
+                    'meta_field_groups_list' => [
+                        'metadata',
+                        'seo',
+                    ],
+                ],
+            ],
+        ];
+        $currentScope = 'admin_group';
+
+        $this->contextualizer
+            ->expects(self::atLeast(2))
+            ->method('setContextualParameter')
+            ->withConsecutive(
+                [
+                    AdminUiForms::FORM_TEMPLATES_PARAM,
+                    $currentScope,
+                    [],
+                ],
+                [
+                    AdminUiForms::FIELD_TYPES_PARAM,
+                    $currentScope,
+                    [],
+                ],
+                [
+                    AdminUiForms::META_FIELD_GROUPS_LIST_PARAM,
+                    $currentScope,
+                    ['metadata', 'seo'],
+                ],
+            );
+
+        $this->parser->mapConfig($scopeSettings, $currentScope, $this->contextualizer);
+    }
 }
 
 class_alias(AdminUiFormsTest::class, 'EzSystems\EzPlatformAdminUiBundle\Tests\DependencyInjection\Configuration\Parser\AdminUiFormsTest');