Add dynamic field type Hidden (#362)

Author: martinlagler

Dynamic/Types/HiddenType.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of Sulu.
+ *
+ * (c) Sulu GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Sulu\Bundle\FormBundle\Dynamic\Types;
+
+use Sulu\Bundle\FormBundle\Dynamic\FormFieldTypeConfiguration;
+use Sulu\Bundle\FormBundle\Dynamic\FormFieldTypeInterface;
+use Sulu\Bundle\FormBundle\Entity\FormField;
+use Symfony\Component\Form\Extension\Core\Type\HiddenType as TypeHiddenType;
+use Symfony\Component\Form\FormBuilderInterface;
+
+/**
+ * The Hidden form field type.
+ */
+class HiddenType implements FormFieldTypeInterface
+{
+    use SimpleTypeTrait;
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getConfiguration(): FormFieldTypeConfiguration
+    {
+        return new FormFieldTypeConfiguration(
+            'sulu_form.type.hidden',
+            __DIR__ . '/../../Resources/config/form-fields/field_hidden.xml'
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function build(FormBuilderInterface $builder, FormField $field, string $locale, array $options): void
+    {
+        $type = TypeHiddenType::class;
+        $builder->add($field->getKey(), $type, $options);
+    }
+}

Entity/Dynamic.php

@@ -38,6 +38,7 @@ class Dynamic implements AuditableInterface
         'headline',
         'freeText',
         'recaptcha',
+        'hidden',
     ];
 
     /**

Resources/config/form-fields/field_hidden.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" ?>
+<properties xmlns="http://schemas.sulu.io/template/template"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+            xsi:schemaLocation="http://schemas.sulu.io/template/template http://schemas.sulu.io/template/properties-1.0.xsd">
+    <property name="title" type="text_editor" mandatory="true">
+        <meta>
+            <title>sulu_form.title</title>
+        </meta>
+    </property>
+
+    <property name="shortTitle" type="text_line" colspan="6">
+        <meta>
+            <title>sulu_form.short_title</title>
+            <info_text>sulu_form.short_title_description</info_text>
+        </meta>
+    </property>
+
+    <property name="defaultValue" type="text_line" colspan="6">
+        <meta>
+            <title>sulu_form.default</title>
+        </meta>
+    </property>
+</properties>

Resources/config/types.xml

@@ -111,5 +111,9 @@
         <service id="sulu_form.dynamic.type_attachment" class="Sulu\Bundle\FormBundle\Dynamic\Types\AttachmentType">
             <tag name="sulu_form.dynamic.type" alias="attachment"/>
         </service>
+
+        <service id="sulu_form.dynamic.type_hidden" class="Sulu\Bundle\FormBundle\Dynamic\Types\HiddenType">
+            <tag name="sulu_form.dynamic.type" alias="hidden"/>
+        </service>
     </services>
 </container>

Resources/translations/admin.de.json

@@ -67,6 +67,7 @@
   "sulu_form.type.radiobuttons": "Radio Buttons",
   "sulu_form.type.recaptcha": "Captcha",
   "sulu_form.type.mailchimp": "Mailchimp",
+  "sulu_form.type.hidden": "Hidden",
   "sulu_form.type.sendinblue": "Sendinblue",
   "sulu_form.width.full": "Voll",
   "sulu_form.width.half": "Halb",

Resources/translations/admin.en.json

@@ -67,6 +67,7 @@
   "sulu_form.type.radiobuttons": "Radio Buttons",
   "sulu_form.type.recaptcha": "Captcha",
   "sulu_form.type.mailchimp": "Mailchimp",
+  "sulu_form.type.hidden": "Hidden",
   "sulu_form.type.sendinblue": "Sendinblue",
   "sulu_form.width.full": "Full",
   "sulu_form.width.half": "Half",

Tests/Functional/Metadata/DynamicFormMetadataLoaderTest.php

@@ -48,7 +48,7 @@ public function testGetMetadataEnglish(): void
 
         $fields = $formFields->getItems()['fields'];
         $this->assertInstanceOf(FieldMetadata::class, $fields);
-        $this->assertCount(27, $fields->getTypes());
+        $this->assertCount(28, $fields->getTypes());
         $this->assertEquals('fields', $fields->getName());
         $this->assertEquals('block', $fields->getType());
         $this->assertEquals('attachment', $fields->getDefaultType());
@@ -67,6 +67,7 @@ public function testGetMetadataEnglish(): void
             'freeText',
             'function',
             'headline',
+            'hidden',
             'lastName',
             'textarea',
             'phone',
@@ -106,7 +107,7 @@ public function testGetMetadataGerman(): void
 
         $fields = $formFields->getItems()['fields'];
         $this->assertInstanceOf(FieldMetadata::class, $fields);
-        $this->assertCount(27, $fields->getTypes());
+        $this->assertCount(28, $fields->getTypes());
         $this->assertEquals('fields', $fields->getName());
         $this->assertEquals('block', $fields->getType());
         $this->assertEquals('attachment', $fields->getDefaultType());
@@ -126,6 +127,7 @@ public function testGetMetadataGerman(): void
             'company',
             'freeText',
             'function',
+            'hidden',
             'country',
             'spacer',
             'textarea',
@@ -184,7 +186,7 @@ public function testGetMetadataAttachmentEnglish(): void
 
         $fields = $formFields->getItems()['fields'];
         $this->assertInstanceOf(FieldMetadata::class, $fields);
-        $this->assertCount(27, $fields->getTypes());
+        $this->assertCount(28, $fields->getTypes());
 
         $attachment = $fields->getTypes()['attachment'];
         $this->assertInstanceOf(FormMetadata::class, $attachment);
@@ -253,7 +255,7 @@ public function testGetMetadataAttachmentGerman(): void
 
         $fields = $formFields->getItems()['fields'];
         $this->assertInstanceOf(FieldMetadata::class, $fields);
-        $this->assertCount(27, $fields->getTypes());
+        $this->assertCount(28, $fields->getTypes());
 
         $attachment = $fields->getTypes()['attachment'];
         $this->assertInstanceOf(FormMetadata::class, $attachment);