IBX-8753: Added ContentTypeIsCompany specification and improved ModifyFieldDefinitions logic

Author: tbialcz

src/bundle/Resources/config/services.yaml

@@ -169,3 +169,25 @@ services:
             - {name: kernel.event_subscriber}
 
     Ibexa\AdminUi\Permission\Mapper\UsersWithPermissionInfoMapper: ~
+
+    Ibexa\AdminUi\Specification\ContentType\ContentTypeIsCompany:
+        arguments:
+            $companyContentTypeIdentifier: 'company'
+
+    Ibexa\AdminUi\Form\Type\Extension\ModifyFieldDefinitionsCollectionTypeExtension.corporate_fields:
+        class: Ibexa\AdminUi\Form\Type\Extension\ModifyFieldDefinitionsCollectionTypeExtension
+        arguments:
+            $fieldTypeIdentifier: ''
+            $fieldIdentifiers:
+                - 'customer_group'
+                - 'sales_rep'
+                - 'contact'
+                - 'default_address'
+                - 'billing_address'
+                - 'address_book'
+                - 'members'
+            $modifiedOptions:
+                disable_remove: true
+            $contentTypeSpecification: '@Ibexa\AdminUi\Specification\ContentType\ContentTypeIsCompany'
+        tags:
+            - { name: form.type_extension }

src/lib/Form/Type/Extension/EventSubscriber/ModifyFieldDefinitionFieldsSubscriber.php

@@ -9,6 +9,7 @@
 namespace Ibexa\AdminUi\Form\Type\Extension\EventSubscriber;
 
 use Ibexa\AdminUi\Form\Type\FieldDefinition\FieldDefinitionType;
+use Ibexa\Contracts\Core\Specification\SpecificationInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\Form\FormEvent;
 use Symfony\Component\Form\FormEvents;
@@ -20,16 +21,28 @@ final class ModifyFieldDefinitionFieldsSubscriber implements EventSubscriberInte
 {
     private string $fieldTypeIdentifier;
 
+    /** @var string[] */
+    private array $fieldIdentifiers;
+
     /** @var array<string, mixed> */
     private array $modifiedOptions;
 
+    private ?SpecificationInterface $contentTypeSpecification;
+
     /**
+     * @param string[]|string $fieldIdentifiers
      * @param array<string, mixed> $modifiedOptions
      */
-    public function __construct(string $fieldTypeIdentifier, array $modifiedOptions)
-    {
+    public function __construct(
+        string $fieldTypeIdentifier,
+        array $modifiedOptions,
+        $fieldIdentifiers = [],
+        ?SpecificationInterface $contentTypeSpecification = null
+    ) {
         $this->fieldTypeIdentifier = $fieldTypeIdentifier;
         $this->modifiedOptions = $modifiedOptions;
+        $this->fieldIdentifiers = is_array($fieldIdentifiers) ? $fieldIdentifiers : [$fieldIdentifiers];
+        $this->contentTypeSpecification = $contentTypeSpecification;
     }
 
     public static function getSubscribedEvents(): array
@@ -45,29 +58,40 @@ public function onPreSetData(FormEvent $event): void
         $data = $event->getData();
         $form = $event->getForm();
 
-        if (null === $data) {
+        if (empty($data)) {
             return;
         }
 
-        foreach ($data as $fieldTypeIdentifier => $fieldTypeData) {
-            if ($this->fieldTypeIdentifier !== $fieldTypeData->fieldDefinition->fieldTypeIdentifier) {
+        $firstField = reset($data);
+        $contentTypeDraft = $firstField->contentTypeData->contentTypeDraft ?? null;
+
+        if (
+            $this->contentTypeSpecification !== null &&
+            !$this->contentTypeSpecification->isSatisfiedBy($contentTypeDraft)
+        ) {
+            return;
+        }
+        foreach ($data as $fieldIdentifier => $fieldTypeData) {
+            $matchesType = $this->fieldTypeIdentifier === $fieldTypeData->fieldDefinition->fieldTypeIdentifier;
+            $matchesId = in_array($fieldIdentifier, $this->fieldIdentifiers, true);
+
+            if (!($matchesType || $matchesId)) {
                 continue;
             }
 
-            if (!$form->has($fieldTypeIdentifier)) {
-                return;
+            if (!$form->has($fieldIdentifier)) {
+                continue;
             }
 
-            $baseFieldForm = $form->get($fieldTypeIdentifier);
+            $baseFieldForm = $form->get($fieldIdentifier);
             $baseFieldFormName = $baseFieldForm->getName();
 
-            $form->remove($baseFieldFormName);
-
             $options = array_merge(
                 $baseFieldForm->getConfig()->getOptions(),
                 $this->modifiedOptions
             );
 
+            $form->remove($baseFieldFormName);
             $form->add($baseFieldFormName, FieldDefinitionType::class, $options);
         }
     }

src/lib/Form/Type/Extension/ModifyFieldDefinitionsCollectionTypeExtension.php

@@ -10,6 +10,7 @@
 
 use Ibexa\AdminUi\Form\Type\ContentType\FieldDefinitionsCollectionType;
 use Ibexa\AdminUi\Form\Type\Extension\EventSubscriber\ModifyFieldDefinitionFieldsSubscriber;
+use Ibexa\Contracts\Core\Specification\SpecificationInterface;
 use Symfony\Component\Form\AbstractTypeExtension;
 use Symfony\Component\Form\FormBuilderInterface;
 
@@ -22,22 +23,38 @@ final class ModifyFieldDefinitionsCollectionTypeExtension extends AbstractTypeEx
 {
     private string $fieldTypeIdentifier;
 
+    /** @var string[] */
+    private array $fieldIdentifiers;
+
     /** @var array<string, mixed> */
     private array $modifiedOptions;
 
+    private ?SpecificationInterface $contentTypeSpecification;
+
     /**
-     * @param string $fieldTypeIdentifier
+     * @param string|string[] $fieldIdentifiers
      * @param array<string, mixed> $modifiedOptions
      */
-    public function __construct(string $fieldTypeIdentifier, array $modifiedOptions)
-    {
+    public function __construct(
+        string $fieldTypeIdentifier,
+        array $modifiedOptions,
+        $fieldIdentifiers = [],
+        ?SpecificationInterface $contentTypeSpecification = null
+    ) {
         $this->fieldTypeIdentifier = $fieldTypeIdentifier;
+        $this->fieldIdentifiers = is_array($fieldIdentifiers) ? $fieldIdentifiers : [$fieldIdentifiers];
         $this->modifiedOptions = $modifiedOptions;
+        $this->contentTypeSpecification = $contentTypeSpecification;
     }
 
     public function buildForm(FormBuilderInterface $builder, array $options): void
     {
-        $subscriber = new ModifyFieldDefinitionFieldsSubscriber($this->fieldTypeIdentifier, $this->modifiedOptions);
+        $subscriber = new ModifyFieldDefinitionFieldsSubscriber(
+            $this->fieldTypeIdentifier,
+            $this->modifiedOptions,
+            $this->fieldIdentifiers,
+            $this->contentTypeSpecification
+        );
 
         foreach ($builder->all() as $fieldTypeGroup) {
             $fieldTypeGroup->addEventSubscriber($subscriber);

src/lib/Specification/ContentType/ContentTypeIsCompany.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\AdminUi\Specification\ContentType;
+
+use Ibexa\AdminUi\Exception\InvalidArgumentException;
+use Ibexa\Contracts\Core\Repository\Values\ContentType\ContentType;
+use Ibexa\Contracts\Core\Specification\AbstractSpecification;
+
+final class ContentTypeIsCompany extends AbstractSpecification
+{
+    private string $companyContentTypeIdentifier;
+
+    public function __construct(string $companyContentTypeIdentifier)
+    {
+        $this->companyContentTypeIdentifier = $companyContentTypeIdentifier;
+    }
+
+    public function isSatisfiedBy($contentType): bool
+    {
+        if (!$contentType instanceof ContentType) {
+            throw new InvalidArgumentException(
+                '$contentType',
+                sprintf('Must be an instance of %s', ContentType::class)
+            );
+        }
+
+        return $contentType->identifier === $this->companyContentTypeIdentifier;
+    }
+}