fix: prevent double required config key in TCA (#3451)

Resolves: #3450
sabbelasichon · Aug 9, 2023 · 38f1a9f · 38f1a9f
1 parent 331a7d4
commit 38f1a9f
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 12 deletions.
diff --git a/composer.json b/composer.json
@@ -107,5 +107,8 @@
         "branch-alias": {
             "dev-main": "1.0-dev"
         }
+    },
+    "conflict": {
+        "phpstan/phpstan": "1.10.28"
     }
 }
diff --git a/src/Rector/v12/v0/tca/MigrateRequiredFlagRector.php b/src/Rector/v12/v0/tca/MigrateRequiredFlagRector.php
@@ -95,10 +95,11 @@ protected function refactorColumn(Expr $columnName, Expr $columnTca): void
             $this->removeNode($evalArrayItem);
         }
 
-        // If required config exists already, remove it to avoid duplicate array items
+        // If required config exists already do not add one again
         $requiredItemToRemove = $this->extractArrayItemByKey($configArray, self::REQUIRED);
         if ($requiredItemToRemove instanceof ArrayItem) {
-            $this->removeNode($requiredItemToRemove);
+            $this->hasAstBeenChanged = true;
+            return;
         }
 
         $configArray->items[] = new ArrayItem(new ConstFetch(new Name('true')), new String_(self::REQUIRED));

diff --git a/tests/Rector/v10/v0/DatabaseRecordListRector/Fixture/database_record_list_renaming.php b/tests/Rector/v10/v0/DatabaseRecordListRector/Fixture/database_record_list_renaming.php
diff --git a/tests/Rector/v12/v0/tca/MigrateRequiredFlagRector/Fixture/fixture.php.inc b/tests/Rector/v12/v0/tca/MigrateRequiredFlagRector/Fixture/fixture.php.inc
@@ -15,12 +15,39 @@ return [
                 'eval' => 'required',
             ],
         ],
+        'required_column2_copy' => [
+            'config' => [
+                'type' => 'foo',
+                'eval' => 'required',
+            ],
+        ],
         'already_required_column' => [
             'config' => [
                 'eval' => 'required',
                 'required' => true,
             ],
         ],
+        'contact_person_salutation' => [
+            'exclude' => 1,
+            'label' => 'LLL:EXT:legacy_extensions/Resources/Private/Language/locallang_db.xlf:tx_legacy_exntesion_domain_model_order.contact_person_salutation',
+            'config' => [
+                'type' => 'select',
+                'items' => [
+                    ['-', 0],
+                    [
+                        'LLL:EXT:legacy_extensions/Resources/Private/Language/locallang.xlf:form.contactPersonSalutation.1.label',
+                        1,
+                    ],
+                    [
+                        'LLL:EXT:legacy_extensions/Resources/Private/Language/locallang.xlf:form.contactPersonSalutation.2.label',
+                        2,
+                    ],
+                ],
+                'size' => 1,
+                'eval' => 'required',
+                'maxitems' => 1,
+            ],
+        ],
     ],
 ];
 
@@ -43,8 +70,37 @@ return [
                 'required' => true,
             ],
         ],
+        'required_column2_copy' => [
+            'config' => [
+                'type' => 'foo',
+                'required' => true,
+            ],
+        ],
         'already_required_column' => [
-            'config' => ['required' => true],
+            'config' => [
+                'required' => true,
+            ],
+        ],
+        'contact_person_salutation' => [
+            'exclude' => 1,
+            'label' => 'LLL:EXT:legacy_extensions/Resources/Private/Language/locallang_db.xlf:tx_legacy_exntesion_domain_model_order.contact_person_salutation',
+            'config' => [
+                'type' => 'select',
+                'items' => [
+                    ['-', 0],
+                    [
+                        'LLL:EXT:legacy_extensions/Resources/Private/Language/locallang.xlf:form.contactPersonSalutation.1.label',
+                        1,
+                    ],
+                    [
+                        'LLL:EXT:legacy_extensions/Resources/Private/Language/locallang.xlf:form.contactPersonSalutation.2.label',
+                        2,
+                    ],
+                ],
+                'size' => 1,
+                'maxitems' => 1,
+                'required' => true,
+            ],
         ],
     ],
 ];