Add custom validation message to international phone number form validation

app/bundles/FormBundle/Config/config.php

@@ -178,6 +178,9 @@
                     'mautic.helper.core_parameters',
                 ],
             ],
+            'mautic.form.validation.subscriber' => [
+                'class'     => \Mautic\FormBundle\EventListener\FormValidationSubscriber::class,
+            ],
             'mautic.form.pagebundle.subscriber' => [
                 'class'     => PageSubscriber::class,
                 'arguments' => [
@@ -253,6 +256,9 @@
             'mautic.form.type.field' => [
                 'class'       => FieldType::class,
                 'alias'       => 'formfield',
+                'arguments'   => [
+                    'translator',
+                ],
                 'methodCalls' => [
                     'setFieldModel' => ['mautic.form.model.field'],
                     'setFormModel'  => ['mautic.form.model.form'],
@@ -288,6 +294,12 @@
                     'translator',
                 ],
             ],
+            'mautic.form.type.field_propertytel' => [
+                'class'     => \Mautic\FormBundle\Form\Type\FormFieldTelType::class,
+                'arguments' => [
+                    'translator',
+                ],
+            ],
             'mautic.form.type.field_propertyfile' => [
                 'class'     => FormFieldFileType::class,
                 'arguments' => [

app/bundles/FormBundle/Controller/FieldController.php

@@ -13,6 +13,8 @@
 
 use Mautic\CoreBundle\Controller\FormController as CommonFormController;
 use Mautic\FormBundle\Entity\Field;
+use Mautic\FormBundle\Event\FormBuilderEvent;
+use Mautic\FormBundle\FormEvents;
 use Symfony\Component\HttpFoundation\JsonResponse;
 
 /**
@@ -397,6 +399,10 @@ private function getFieldForm($formId, array $formField)
         );
         $form->get('formId')->setData($formId);
 
+        $event      = new FormBuilderEvent($this->get('translator'));
+        $this->dispatcher->dispatch(FormEvents::FORM_ON_BUILD, $event);
+        $event->addValidatorsToBuilder($form);
+
         return $form;
     }
 }

app/bundles/FormBundle/Entity/Field.php

@@ -86,6 +86,11 @@ class Field
      */
     private $properties = [];
 
+    /**
+     * @var array
+     */
+    private $validation = [];
+
     /**
      * @var Form
      */
@@ -211,6 +216,10 @@ public static function loadMetadata(ORM\ClassMetadata $metadata)
             ->nullable()
             ->build();
 
+        $builder->createField('validation', 'json_array')
+            ->nullable()
+            ->build();
+
         $builder->createManyToOne('form', 'Form')
             ->inversedBy('fields')
             ->addJoinColumn('form_id', 'id', false, false, 'CASCADE')
@@ -254,6 +263,7 @@ public static function loadApiMetadata(ApiMetadataDriver $metadata)
                     'helpMessage',
                     'order',
                     'properties',
+                    'validation',
                     'labelAttributes',
                     'inputAttributes',
                     'containerAttributes',
@@ -479,6 +489,31 @@ public function getProperties()
         return $this->properties;
     }
 
+    /**
+     * Set validation.
+     *
+     * @param array $validation
+     *
+     * @return Field
+     */
+    public function setValidation($validation)
+    {
+        $this->isChanged('validation', $validation);
+        $this->validation = $validation;
+
+        return $this;
+    }
+
+    /**
+     * Get validation.
+     *
+     * @return array
+     */
+    public function getValidation()
+    {
+        return $this->validation;
+    }
+
     /**
      * Set validationMessage.
      *

app/bundles/FormBundle/Event/FormBuilderEvent.php

@@ -13,6 +13,7 @@
 
 use Mautic\CoreBundle\Event\ComponentValidationTrait;
 use Symfony\Component\EventDispatcher\Event;
+use Symfony\Component\Form\Form;
 
 /**
  * Class FormBuilderEvent.
@@ -211,6 +212,28 @@ public function addValidator($key, array $validator)
         $this->validators[$key] = $validator;
     }
 
+    /**
+     * @param Form $form
+     */
+    public function addValidatorsToBuilder(Form $form)
+    {
+        if (!empty($this->validators)) {
+            $validationData = (isset($form->getData()['validation'])) ? $form->getData()['validation'] : [];
+            foreach ($this->validators as $validator) {
+                if (isset($validator['formType']) && isset($validator['fieldType']) && $validator['fieldType'] == $form->getData()['type']) {
+                    $form->add(
+                        'validation',
+                        $validator['formType'],
+                        [
+                            'label' => false,
+                            'data'  => $validationData,
+                        ]
+                    );
+                }
+            }
+        }
+    }
+
     /**
      * Returns validators organized by ['form' => [], 'fieldType' => [], ...
      *

app/bundles/FormBundle/EventListener/FormValidationSubscriber.php

@@ -0,0 +1,70 @@
+<?php
+
+/*
+ * @copyright   2014 Mautic Contributors. All rights reserved
+ * @author      Mautic
+ *
+ * @link        http://mautic.org
+ *
+ * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
+ */
+
+namespace Mautic\FormBundle\EventListener;
+
+use libphonenumber\NumberParseException;
+use libphonenumber\PhoneNumberUtil;
+use Mautic\CoreBundle\EventListener\CommonSubscriber;
+use Mautic\FormBundle\Event as Events;
+use Mautic\FormBundle\FormEvents;
+
+class FormValidationSubscriber extends CommonSubscriber
+{
+    /**
+     * {@inheritdoc}
+     */
+    public static function getSubscribedEvents()
+    {
+        return [
+            FormEvents::FORM_ON_BUILD                => ['onFormBuilder', 0],
+            FormEvents::ON_FORM_VALIDATE             => ['onFormValidate', 0],
+        ];
+    }
+
+    /**
+     * Add a simple email form.
+     *
+     * @param Events\FormBuilderEvent $event
+     */
+    public function onFormBuilder(Events\FormBuilderEvent $event)
+    {
+        $event->addValidator(
+            'phone.validation',
+            [
+                'eventName' => FormEvents::ON_FORM_VALIDATE,
+                'fieldType' => 'tel',
+                'formType'  => \Mautic\FormBundle\Form\Type\FormFieldTelType::class,
+            ]
+        );
+    }
+
+    /**
+     * @param Events\ValidationEvent $event
+     */
+    public function onFormValidate(Events\ValidationEvent $event)
+    {
+        $field = $event->getField();
+        if ($field->getType() === 'tel' && !empty($field->getValidation()['international'])) {
+            $value     = $event->getValue();
+            $phoneUtil = PhoneNumberUtil::getInstance();
+            try {
+                $phoneUtil->parse($value, PhoneNumberUtil::UNKNOWN_REGION);
+            } catch (NumberParseException $e) {
+                if (!empty($field->getValidation()['international_validationmsg'])) {
+                    $event->failedValidation($field->getValidation()['international_validationmsg']);
+                } else {
+                    $event->failedValidation($this->translator->trans('mautic.form.submission.phone.invalid'));
+                }
+            }
+        }
+    }
+}

app/bundles/FormBundle/Form/Type/FieldType.php

@@ -16,6 +16,7 @@
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolverInterface;
+use Symfony\Component\Translation\TranslatorInterface;
 use Symfony\Component\Validator\Constraints as Assert;
 
 /**
@@ -25,6 +26,21 @@ class FieldType extends AbstractType
 {
     use FormFieldTrait;
 
+    /**
+     * @var TranslatorInterface
+     */
+    private $translator;
+
+    /**
+     * FieldType constructor.
+     *
+     * @param TranslatorInterface $translator
+     */
+    public function __construct(TranslatorInterface $translator)
+    {
+        $this->translator = $translator;
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -223,7 +239,11 @@ public function buildForm(FormBuilderInterface $builder, array $options)
                 [
                     'label'      => 'mautic.form.field.form.validationmsg',
                     'label_attr' => ['class' => 'control-label'],
-                    'attr'       => ['class' => 'form-control'],
+                    'attr'       => [
+                        'class'        => 'form-control',
+                        'tooltip'      => $this->translator->trans('mautic.core.form.default').': '.$this->translator->trans('mautic.form.field.generic.required', [], 'validators'),
+                        'data-show-on' => '{"formfield_isRequired_1": "checked"}',
+                    ],
                     'required'   => false,
                 ]
             );
@@ -479,6 +499,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
                 case 'number':
                 case 'text':
                 case 'url':
+                case 'tel':
                     $builder->add(
                         'properties',
                         'formfield_placeholder',
@@ -521,27 +542,6 @@ public function buildForm(FormBuilderInterface $builder, array $options)
                         ]
                     );
                     break;
-                case 'tel':
-                    if (empty($propertiesData['international'])) {
-                        $propertiesData['international'] = false;
-                    }
-                    $builder->add(
-                        'properties',
-                        FormFieldTelType::class,
-                        [
-                            'label' => false,
-                            'data'  => $propertiesData,
-                        ]
-                    );
-                    $builder->add(
-                        'properties',
-                        'formfield_placeholder',
-                        [
-                            'label' => false,
-                            'data'  => $propertiesData,
-                        ]
-                    );
-                    break;
             }
         }
 

app/bundles/FormBundle/Form/Type/FormFieldTelType.php

@@ -11,24 +11,57 @@
 
 namespace Mautic\FormBundle\Form\Type;
 
+use Mautic\CoreBundle\Form\Type\YesNoButtonGroupType;
 use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Translation\TranslatorInterface;
 
 /**
  * Class FormFieldTextType.
  */
 class FormFieldTelType extends AbstractType
 {
+    /**
+     * @var TranslatorInterface
+     */
+    private $translator;
+
+    /**
+     * FormFieldTelType constructor.
+     *
+     * @param TranslatorInterface $translator
+     */
+    public function __construct(TranslatorInterface $translator)
+    {
+        $this->translator = $translator;
+    }
+
     /**
      * {@inheritdoc}
      */
     public function buildForm(FormBuilderInterface $builder, array $options)
     {
         $builder->add(
             'international',
-            'yesno_button_group',
+            YesNoButtonGroupType::class,
             [
                 'label' => 'mautic.form.field.type.tel.international',
+                'data'  => isset($options['data']['international']) ? $options['data']['international'] : false,
+            ]
+        );
+
+        $builder->add(
+            'international_validationmsg',
+            TextType::class,
+            [
+                'label'      => 'mautic.form.field.form.validationmsg',
+                'label_attr' => ['class' => 'control-label'],
+                'attr'       => [
+                    'class'        => 'form-control',
+                    'tooltip'      => $this->translator->trans('mautic.core.form.default').': '.$this->translator->trans('mautic.form.submission.phone.invalid', [], 'validators'),
+                    'data-show-on' => '{"formfield_validation_international_1": "checked"}',
+                ],
             ]
         );
     }

app/bundles/FormBundle/FormEvents.php

@@ -64,6 +64,15 @@ final class FormEvents
      */
     const FORM_ON_BUILD = 'mautic.form_on_build';
 
+    /**
+     * The mautic.on_form_validate event is dispatched when a form is validated.
+     *
+     * The event listener receives a Mautic\FormBundle\Event\ValidationEvent instance.
+     *
+     * @var string
+     */
+    const ON_FORM_VALIDATE = 'mautic.on_form_validate';
+
     /**
      * The mautic.form_on_submit event is dispatched when a new submission is fired.
      *

app/bundles/FormBundle/Helper/FormFieldHelper.php

@@ -167,9 +167,6 @@ public function validateFieldValue($type, $value, $f = null)
                     continue;
                 }
 
-                if ($f !== null && $f->getType() === 'tel' && empty($f->getProperties()['international'])) {
-                    continue;
-                }
                 if ($type == 'captcha') {
                     $captcha = $f->getProperties()['captcha'];
                     if (empty($captcha) && Blank::class !== $constraint) {

app/bundles/FormBundle/Translations/en_US/messages.ini

@@ -103,7 +103,7 @@ mautic.form.field.type.pagebreak="Page break"
 mautic.form.field.type.radiogrp="Radio group"
 mautic.form.field.type.textarea="Textarea"
 mautic.form.field.type.file="File"
-mautic.form.field.type.tel.international="Validate as internationally-standardized format"
+mautic.form.field.type.tel.international="Validate as international format"
 mautic.form.field.file.public="Public accessible link to download"
 mautic.form.field.file.allowed_extensions="Allowed file extensions"
 mautic.form.field.file.allowed_size="Maximum size (MB)"