YCRO-300 add backend validation for info collector forms

bundle/InfoCollection/Form/Extension/EmailFormExtension.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Netgen\Bundle\SiteBundle\InfoCollection\Form\Extension;
+
+use Ibexa\Contracts\ContentForms\Data\Content\FieldData;
+use Netgen\Bundle\InformationCollectionBundle\Ibexa\ContentForms\InformationCollectionFieldType;
+use Netgen\Bundle\InformationCollectionBundle\Ibexa\ContentForms\InformationCollectionType;
+use Netgen\Bundle\SiteBundle\InfoCollection\Validator\Constraints\CustomEmail;
+use Symfony\Component\Form\AbstractTypeExtension;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+final class EmailFormExtension extends AbstractTypeExtension
+{
+    public static function getExtendedTypes(): iterable
+    {
+        return [InformationCollectionType::class];
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setDefault('translation_domain', 'validators');
+    }
+
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        foreach ($builder->getData()->getCollectedFields() as $identifier => $fieldData) {
+            /** @var FieldData $fieldData */
+            if ($fieldData->fieldDefinition->fieldTypeIdentifier === 'ezemail') {
+                $emailOptions = $builder->get($identifier)->getOptions();
+
+                $customEmailExists = false;
+                foreach ($emailOptions['constraints'] as $constraint) {
+                    if ($constraint instanceof CustomEmail) {
+                        $customEmailExists = true;
+
+                        break;
+                    }
+                }
+
+                if (!$customEmailExists) {
+                    $emailOptions['constraints'][] = new CustomEmail();
+                }
+
+                $builder->add($identifier, InformationCollectionFieldType::class, $emailOptions);
+            }
+        }
+    }
+}

bundle/InfoCollection/Form/Extension/RequiredFieldFormExtension.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Netgen\Bundle\SiteBundle\InfoCollection\Form\Extension;
+
+use Ibexa\Contracts\ContentForms\Data\Content\FieldData;
+use Netgen\Bundle\InformationCollectionBundle\Ibexa\ContentForms\InformationCollectionFieldType;
+use Netgen\Bundle\InformationCollectionBundle\Ibexa\ContentForms\InformationCollectionType;
+use Netgen\Bundle\SiteBundle\InfoCollection\Validator\Constraints\RequiredField;
+use Symfony\Component\Form\AbstractTypeExtension;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+final class RequiredFieldFormExtension extends AbstractTypeExtension
+{
+    public static function getExtendedTypes(): iterable
+    {
+        return [InformationCollectionType::class];
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setDefaults([
+            'translation_domain' => 'validators',
+            'attr' => [
+                'class' => 'embed-form js-form-embed',
+            ],
+        ]);
+    }
+
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        foreach ($builder->getData()->getCollectedFields() as $identifier => $fieldData) {
+            /** @var FieldData $fieldData */
+            if ($fieldData->fieldDefinition->isRequired === true) {
+                $fieldOptions = $builder->get($identifier)->getOptions();
+
+                $hasRequiredFieldConstraint = false;
+
+                foreach ($fieldOptions['constraints'] as $constraint) {
+                    if ($constraint instanceof RequiredField) {
+                        $hasRequiredFieldConstraint = true;
+
+                        break;
+                    }
+                }
+
+                if (!$hasRequiredFieldConstraint) {
+                    $fieldOptions['constraints'][] = new RequiredField();
+                    $builder->add($identifier, InformationCollectionFieldType::class, $fieldOptions);
+                }
+            }
+        }
+    }
+}

bundle/InfoCollection/Validator/Constraints/CustomEmail.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Netgen\Bundle\SiteBundle\InfoCollection\Validator\Constraints;
+
+use Symfony\Component\Validator\Constraint;
+
+final class CustomEmail extends Constraint
+{
+    public string $message = 'email_is_not_valid';
+}

bundle/InfoCollection/Validator/Constraints/CustomEmailValidator.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Netgen\Bundle\SiteBundle\InfoCollection\Validator\Constraints;
+
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\ConstraintValidator;
+use Symfony\Component\Validator\Exception\UnexpectedTypeException;
+
+use function filter_var;
+
+use const FILTER_VALIDATE_EMAIL;
+
+final class CustomEmailValidator extends ConstraintValidator
+{
+    public function validate(mixed $value, Constraint $constraint): void
+    {
+        if (!$constraint instanceof CustomEmail) {
+            throw new UnexpectedTypeException($constraint, CustomEmail::class);
+        }
+
+        $emailValue = $value->value->email;
+
+        if (filter_var($emailValue, FILTER_VALIDATE_EMAIL) === false) {
+            $this->context->buildViolation($constraint->message)
+                ->atPath($value->fieldDefinition->identifier)
+                ->addViolation();
+        }
+    }
+}

bundle/InfoCollection/Validator/Constraints/RequiredField.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Netgen\Bundle\SiteBundle\InfoCollection\Validator\Constraints;
+
+use Symfony\Component\Validator\Constraint;
+
+final class RequiredField extends Constraint
+{
+    public string $message = 'this_value_should_not_be_blank';
+}

bundle/InfoCollection/Validator/Constraints/RequiredFieldValidator.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Netgen\Bundle\SiteBundle\InfoCollection\Validator\Constraints;
+
+use Ibexa\Contracts\ContentForms\Data\Content\FieldData;
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\ConstraintValidator;
+
+use function array_filter;
+use function property_exists;
+
+final class RequiredFieldValidator extends ConstraintValidator
+{
+    public function validate(mixed $value, Constraint $constraint): void
+    {
+        /** @var FieldData $value */
+        if (
+            $value->value === null
+            || array_filter(
+                $value->value->attributes(),
+                static fn ($attr) => $value->value->attribute($attr) === null || $value->value->attribute($attr) === '' || $value->value->attribute($attr) === false,
+            ) !== []
+        ) {
+            if (!property_exists($constraint, 'message')) {
+                return;
+            }
+            $this->context->buildViolation($constraint->message)
+                ->atPath($value->fieldDefinition->identifier)
+                ->addViolation();
+        }
+    }
+}

bundle/Resources/config/info_collection.yaml

@@ -23,6 +23,16 @@ services:
         tags:
             - { name: netgen_information_collection.action }
 
+    ngsite.info_collection.form.extension.required_field:
+        class: Netgen\Bundle\SiteBundle\InfoCollection\Form\Extension\RequiredFieldFormExtension
+        tags:
+          - { name: form.type_extension, extended_type: Netgen\Bundle\InformationCollectionBundle\Ibexa\ContentForms\InformationCollectionType, priority: -100 }
+
+    ngsite.info_collection.form.extension.email_form_extenison:
+        class: Netgen\Bundle\SiteBundle\InfoCollection\Form\Extension\EmailFormExtension
+        tags:
+          - { name: form.type_extension, extended_type: Netgen\Bundle\InformationCollectionBundle\Ibexa\ContentForms\InformationCollectionType, priority: -100 }
+
     ngsite.info_collection.form.extension.honeypot_extension:
         class: Netgen\Bundle\SiteBundle\InfoCollection\Form\Extension\HoneypotExtension
         tags:

bundle/Resources/translations/validators.en.yaml

@@ -0,0 +1,2 @@
+this_value_should_not_be_blank: 'This value should not be blank.'
+email_is_not_valid: 'Email is not valid.'