Forms destination: Use class name for config to avoid conflicts (#17667)

* Forms destination: Use class name for config to avoid conflicts * Slugify class name to avoid breaking html (+ more readable) * Update existing tests
glpi-project · Aug 19, 2024 · 0258854 · 0258854
1 parent 18af00c
commit 0258854
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 23 deletions.
diff --git a/phpunit/functional/Glpi/Form/Destination/CommonITILField/RequestTypeFieldTest.php b/phpunit/functional/Glpi/Form/Destination/CommonITILField/RequestTypeFieldTest.php
@@ -207,14 +207,16 @@ private function sendFormAndAssertTicketType(
         array $answers,
         int $expected_request_type,
     ): void {
+        $field = new RequestTypeField();
+
         // Insert config
         $destinations = $form->getDestinations();
         $this->assertCount(1, $destinations);
         $destination = current($destinations);
         $this->updateItem(
             $destination::getType(),
             $destination->getId(),
-            ['config' => ['request_type' => $config->jsonSerialize()]],
+            ['config' => [$field->getKey() => $config->jsonSerialize()]],
             ["config"],
         );
 

diff --git a/src/Glpi/Form/Destination/AbstractConfigField.php b/src/Glpi/Form/Destination/AbstractConfigField.php
@@ -39,9 +39,16 @@
 use Glpi\Form\Form;
 use LogicException;
 use Override;
+use Toolbox;
 
 abstract class AbstractConfigField implements ConfigFieldInterface
 {
+    #[Override]
+    public function getKey(): string
+    {
+        return Toolbox::slugify(static::class);
+    }
+
     #[Override]
     public function supportAutoConfiguration(): bool
     {

diff --git a/src/Glpi/Form/Destination/CommonITILField/ContentField.php b/src/Glpi/Form/Destination/CommonITILField/ContentField.php
@@ -49,12 +49,6 @@
 
 class ContentField extends AbstractConfigField
 {
-    #[Override]
-    public function getKey(): string
-    {
-        return 'content';
-    }
-
     #[Override]
     public function getLabel(): string
     {

diff --git a/src/Glpi/Form/Destination/CommonITILField/RequestTypeField.php b/src/Glpi/Form/Destination/CommonITILField/RequestTypeField.php
@@ -47,12 +47,6 @@
 
 class RequestTypeField extends AbstractConfigField
 {
-    #[Override]
-    public function getKey(): string
-    {
-        return 'request_type';
-    }
-
     #[Override]
     public function getLabel(): string
     {

diff --git a/src/Glpi/Form/Destination/CommonITILField/TitleField.php b/src/Glpi/Form/Destination/CommonITILField/TitleField.php
@@ -47,12 +47,6 @@
 
 class TitleField extends AbstractConfigField
 {
-    #[Override]
-    public function getKey(): string
-    {
-        return 'title';
-    }
-
     #[Override]
     public function getLabel(): string
     {

diff --git a/tests/src/Form/Destination/AbstractFormDestinationType.php b/tests/src/Form/Destination/AbstractFormDestinationType.php
@@ -40,7 +40,9 @@
 use DbTestCase;
 use Glpi\Form\AnswersHandler\AnswersHandler;
 use Glpi\Form\AnswersSet;
+use Glpi\Form\Destination\CommonITILField\ContentField;
 use Glpi\Form\Destination\CommonITILField\SimpleValueConfig;
+use Glpi\Form\Destination\CommonITILField\TitleField;
 use Glpi\Form\Form;
 use Glpi\Form\QuestionType\QuestionTypeShortText;
 use Glpi\Tests\FormBuilder;
@@ -65,6 +67,9 @@ final public function testCreateDestinations(): void
         $itemtype = $this->getTestedInstance()::getTargetItemtype();
         $link_itemtype = $itemtype::getItemLinkClass();
 
+        $title_field = new TitleField();
+        $content_field = new ContentField();
+
         // Create a form with a single FormDestinationTicket destination
         $form = $this->createForm(
             (new FormBuilder("Test form 1"))
@@ -73,10 +78,10 @@ final public function testCreateDestinations(): void
                     $this->getTestedInstance()::class,
                     'test',
                     [
-                        'title'        => (new SimpleValueConfig("My title"))->jsonSerialize(),
-                        'title_auto'   => 0,
-                        'content'      => (new SimpleValueConfig("My content"))->jsonSerialize(),
-                        'content_auto' => 0,
+                        $title_field->getKey()             => (new SimpleValueConfig("My title"))->jsonSerialize(),
+                        $title_field->getAutoConfigKey()   => 0,
+                        $content_field->getKey()           => (new SimpleValueConfig("My content"))->jsonSerialize(),
+                        $content_field->getAutoConfigKey() => 0,
                     ]
                 )
         );