Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IBX-4629: Implement Meta field groups #680

Merged
merged 9 commits into from
Feb 3, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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'])
barw4 marked this conversation as resolved.
Show resolved Hide resolved
->end()
->end()
->end()
->arrayNode('content_type_edit')
Expand Down Expand Up @@ -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'];
Expand All @@ -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,
Expand All @@ -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);
}
Expand Down
2 changes: 2 additions & 0 deletions src/bundle/Resources/config/admin_ui_forms.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
barw4 marked this conversation as resolved.
Show resolved Hide resolved
{% block content %}
{% from '@ibexadesign/content/edit_macros.html.twig' import render_form_field %}

Expand Down
30 changes: 27 additions & 3 deletions src/lib/Component/Content/ContentEditMetaFieldsComponent.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -70,4 +77,21 @@ 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 => true === in_array($field->fieldGroup, $metaFieldGroups),
barw4 marked this conversation as resolved.
Show resolved Hide resolved
);
}

private function mapMetaFieldDefinitionCollectionToIdentifiers(
barw4 marked this conversation as resolved.
Show resolved Hide resolved
FieldDefinitionCollection $metaFieldDefinitionCollection
): array {
return array_column($metaFieldDefinitionCollection->toArray(), 'identifier');
}
}
14 changes: 13 additions & 1 deletion src/lib/EventListener/SetViewParametersListener.php
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -276,7 +277,18 @@ 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 => true
=== in_array($field->getData()->fieldDefinition->fieldGroup, $metaFieldGroups)
webhdx marked this conversation as resolved.
Show resolved Hide resolved
barw4 marked this conversation as resolved.
Show resolved Hide resolved
)
);

return array_merge($ignoredFieldIdentifiers, $metaFieldIdentifiers);
}
}

Expand Down
28 changes: 26 additions & 2 deletions src/lib/Form/Provider/GroupedNonMetaFormFieldsProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand All @@ -28,16 +29,31 @@ 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 => true
webhdx marked this conversation as resolved.
Show resolved Hide resolved
=== in_array($field->getData()->fieldDefinition->fieldGroup, $metaFieldGroups)
barw4 marked this conversation as resolved.
Show resolved Hide resolved
)
);

$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);
barw4 marked this conversation as resolved.
Show resolved Hide resolved
}
);
}
Expand All @@ -59,4 +75,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');
}
}
20 changes: 19 additions & 1 deletion src/lib/Menu/ContentEditAnchorMenuBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 => true === in_array($field->fieldGroup, $metaFieldGroups),
barw4 marked this conversation as resolved.
Show resolved Hide resolved
);

$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;
Expand All @@ -137,7 +153,9 @@ 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);
if (!isset($items[$fieldDefIdentifier])) {
$items[$fieldDefIdentifier] = $this->createSecondLevelItem($fieldDefIdentifier, $fieldDefinition, $order);
}
barw4 marked this conversation as resolved.
Show resolved Hide resolved
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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($this->atLeast(2))
barw4 marked this conversation as resolved.
Show resolved Hide resolved
->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');
47 changes: 36 additions & 11 deletions tests/lib/EventListener/SetViewParametersListenerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,17 @@ public function setUp(): void
$this->configResolver = $this->createMock(ConfigResolverInterface::class);
$this->configResolver
->method('getParameter')
->with('admin_ui_forms.content_edit.fieldtypes')
->willReturn(
->withConsecutive(
['admin_ui_forms.content_edit.fieldtypes'],
['admin_ui_forms.content_edit.meta_field_groups_list']
)
->willReturnOnConsecutiveCalls(
[
'ibexa_taxonomy_entry_assignment' => [
'meta' => true,
],
]
],
['metadata']
);

$this->groupedContentFormFieldsProvider = $this->createMock(GroupedContentFormFieldsProviderInterface::class);
Expand Down Expand Up @@ -227,15 +231,35 @@ public function testSetUserUpdateViewTemplateParameters(): void
public function testSetContentFieldsParameters(): void
{
$fields = [
'name' => 'ezstring',
'short_name' => 'ezstring',
'description' => 'ezrichtext',
'tags' => 'ibexa_taxonomy_entry_assignment',
'name' => [
'type' => 'ezstring',
'group' => 'content',
],
'short_name' => [
'type' => 'ezstring',
'group' => 'content',
],
'description' => [
'type' => 'ezrichtext',
'group' => 'content',
],
'tags' => [
'type' => 'ibexa_taxonomy_entry_assignment',
'group' => 'content',
],
'metadata_field' => [
'type' => 'ezstring',
'group' => 'metadata',
],
];

$fieldsDataChildren = [];
foreach ($fields as $identifier => $type) {
$fieldsDataChildren[$identifier] = $this->createFieldMock($identifier, $type);
foreach ($fields as $identifier => $data) {
$fieldsDataChildren[$identifier] = $this->createFieldMock(
$identifier,
$data['type'],
$data['group']
);
}

$fieldsDataForm = $this->createMock(FormInterface::class);
Expand All @@ -255,7 +279,7 @@ public function testSetContentFieldsParameters(): void
$groupedFields = [
'Content' => ['name', 'short_name', 'description'],
];
$ignoredContentFields = ['tags'];
$ignoredContentFields = ['tags', 'metadata_field'];

$this->groupedContentFormFieldsProvider
->method('getGroupedFields')
Expand Down Expand Up @@ -347,7 +371,7 @@ private function generateUser(int $ownerId): APIUser
/**
* @return \Ibexa\Contracts\Core\Repository\Values\Content\Field|\PHPUnit\Framework\MockObject\MockObject
*/
private function createFieldMock(string $identifier, string $type): MockObject
private function createFieldMock(string $identifier, string $type, string $fieldGroup = 'content'): MockObject
{
$data = new FieldData([
'field' => new Field([
Expand All @@ -356,6 +380,7 @@ private function createFieldMock(string $identifier, string $type): MockObject
]),
'fieldDefinition' => new FieldDefinition([
'fieldTypeIdentifier' => $type,
'fieldGroup' => $fieldGroup,
]),
]);

Expand Down