Added support for mask and examples in Format definitions

Author: adamwojs

src/FieldType/FormattedTextLine/Format.php

@@ -8,5 +8,20 @@
 
 interface Format
 {
+    /**
+     * Validate value against format.
+     */
     public function validate(FieldDefinition $fieldDefinition, string $text): bool;
+
+    /**
+     * Returns input mask for format.
+     */
+    public function getMask(FieldDefinition $fieldDefinition): ?string;
+
+    /**
+     * Returns examples of correct value.
+     *
+     * @return string[]
+     */
+    public function getExamples(FieldDefinition $fieldDefinition): array;
 }

src/FieldType/FormattedTextLine/Format/NullFormat.php

@@ -13,4 +13,14 @@ public function validate(FieldDefinition $fieldDefinition, string $text): bool
     {
         return true;
     }
+
+    public function getMask(FieldDefinition $fieldDefinition): ?string
+    {
+        return null;
+    }
+
+    public function getExamples(FieldDefinition $fieldDefinition): array
+    {
+        return [];
+    }
 }

src/FieldType/FormattedTextLine/Format/PatternFormat.php

@@ -12,13 +12,31 @@ final class PatternFormat implements Format
     /** @var string */
     private $pattern;
 
-    public function __construct(string $pattern)
+    /** @var string|null */
+    private $mask;
+
+    /** @var string[] */
+    private $examples;
+
+    public function __construct(string $pattern, ?string $mask = null, array $examples = [])
     {
         $this->pattern = $pattern;
+        $this->mask = $mask;
+        $this->examples = $examples;
     }
 
     public function validate(FieldDefinition $fieldDefinition, string $text): bool
     {
         return preg_match($this->pattern, $text) === 1;
     }
+
+    public function getMask(FieldDefinition $fieldDefinition): ?string
+    {
+        return $this->mask;
+    }
+
+    public function getExamples(FieldDefinition $fieldDefinition): array
+    {
+        return $this->examples;
+    }
 }

src/FieldType/MaskedTextLine/Format.php

@@ -56,4 +56,14 @@ public function createPatternFromMask(string $mask): string
 
         return '/^' . implode('', $pattern) . '$/';
     }
+
+    public function getMask(FieldDefinition $fieldDefinition): ?string
+    {
+        return $fieldDefinition->fieldSettings['mask'] ?? null;
+    }
+
+    public function getExamples(FieldDefinition $fieldDefinition): array
+    {
+        return [];
+    }
 }

src/Form/DataTransformer/TextLineFieldTypeTransformer.php renamed to src/Form/DataTransformer/FormattedTextLineFieldTypeTransformer.php

@@ -7,7 +7,7 @@
 use AdamWojs\IbexaFormattedTextLineBundle\FieldType\FormattedTextLine\Value;
 use Symfony\Component\Form\DataTransformerInterface;
 
-final class TextLineFieldTypeTransformer implements DataTransformerInterface
+final class FormattedTextLineFieldTypeTransformer implements DataTransformerInterface
 {
     public function transform($value): ?array
     {

src/Form/Mapper/FormattedTextLine/FieldValueFormMapper.php

@@ -4,20 +4,35 @@
 
 namespace AdamWojs\IbexaFormattedTextLineBundle\Form\Mapper\FormattedTextLine;
 
-use AdamWojs\IbexaFormattedTextLineBundle\Form\Type\TextLineFieldType;
+use AdamWojs\IbexaFormattedTextLineBundle\FieldType\FormattedTextLine\Format;
+use AdamWojs\IbexaFormattedTextLineBundle\Form\Type\FormattedTextLineFieldType;
 use EzSystems\EzPlatformContentForms\Data\Content\FieldData;
 use EzSystems\EzPlatformContentForms\FieldType\FieldValueFormMapperInterface;
 use Symfony\Component\Form\FormInterface;
 
-final class FieldValueFormMapper implements FieldValueFormMapperInterface
+class FieldValueFormMapper implements FieldValueFormMapperInterface
 {
+    /** @var \AdamWojs\IbexaFormattedTextLineBundle\FieldType\FormattedTextLine\Format */
+    private $format;
+
+    public function __construct(Format $format)
+    {
+        $this->format = $format;
+    }
+
     public function mapFieldValueForm(FormInterface $fieldForm, FieldData $data): void
     {
         $definition = $data->fieldDefinition;
 
-        $fieldForm->add('value', TextLineFieldType::class, [
-            'required' => $definition->isRequired,
-            'label' => $definition->getName(),
-        ]);
+        $fieldForm->add(
+            'value',
+            FormattedTextLineFieldType::class,
+            [
+                'required' => $definition->isRequired,
+                'label' => $definition->getName(),
+                'mask' => $this->format->getMask($definition),
+                'examples' => $this->format->getExamples($definition),
+            ]
+        );
     }
 }

src/Form/Mapper/MaskedTextLine/FieldValueFormMapper.php

@@ -4,21 +4,8 @@
 
 namespace AdamWojs\IbexaFormattedTextLineBundle\Form\Mapper\MaskedTextLine;
 
-use AdamWojs\IbexaFormattedTextLineBundle\Form\Type\MaskedTextLineFieldType;
-use EzSystems\EzPlatformContentForms\Data\Content\FieldData;
-use EzSystems\EzPlatformContentForms\FieldType\FieldValueFormMapperInterface;
-use Symfony\Component\Form\FormInterface;
+use AdamWojs\IbexaFormattedTextLineBundle\Form\Mapper\FormattedTextLine\FieldValueFormMapper as BaseFieldValueFormMapper;
 
-final class FieldValueFormMapper implements FieldValueFormMapperInterface
+final class FieldValueFormMapper extends BaseFieldValueFormMapper
 {
-    public function mapFieldValueForm(FormInterface $fieldForm, FieldData $data): void
-    {
-        $definition = $data->fieldDefinition;
-
-        $fieldForm->add('value', MaskedTextLineFieldType::class, [
-            'required' => $definition->isRequired,
-            'label' => $definition->getName(),
-            'mask' => $definition->fieldSettings['mask'],
-        ]);
-    }
 }

src/Form/Type/FormattedTextLineFieldType.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AdamWojs\IbexaFormattedTextLineBundle\Form\Type;
+
+use AdamWojs\IbexaFormattedTextLineBundle\Form\DataTransformer\FormattedTextLineFieldTypeTransformer;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+final class FormattedTextLineFieldType extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $help = null;
+        if (!empty($options['examples'])) {
+            $help = 'e.g. ' . implode(', ', $options['examples']);
+        }
+
+        $builder->add('text', MaskedTextType::class, [
+            'label' => false,
+            'mask' => $options['mask'],
+            'help' => $help,
+        ]);
+
+        $builder->addModelTransformer(new FormattedTextLineFieldTypeTransformer());
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setDefaults([
+            'mask' => null,
+            'examples' => [],
+        ]);
+
+        $resolver->setAllowedTypes('mask', ['string', 'null']);
+        $resolver->setAllowedTypes('examples', ['array']);
+    }
+}

src/Form/Type/MaskedTextLineFieldType.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AdamWojs\IbexaFormattedTextLineBundle\Form\Type;
+
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\Form\FormInterface;
+use Symfony\Component\Form\FormView;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+final class MaskedTextType extends AbstractType
+{
+    public function buildView(FormView $view, FormInterface $form, array $options): void
+    {
+        $view->vars += [
+            'mask' => $options['mask'],
+        ];
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setDefaults([
+            'mask' => null,
+        ]);
+
+        $resolver->setAllowedTypes('mask', ['string', 'null']);
+    }
+
+    public function getParent(): string
+    {
+        return TextType::class;
+    }
+}