How to Handle Different Error Levels

3.3 version

How to Handle Different Error Levels

Sometimes, you may want to display constraint validation error messages differently based on some rules. For example, you have a registration form for new users where they enter some personal information and choose their authentication credentials. They would have to choose a username and a secure password, but providing bank account information would be optional. Nonetheless, you want to make sure that these optional fields, if entered, are still valid, but display their errors differently.

The process to achieve this behavior consists of two steps:

  1. Apply different error levels to the validation constraints;
  2. Customize your error messages depending on the configured error level.

1. Assigning the Error Level

Use the payload option to configure the error level for each constraint:

  • Annotations
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    // src/AppBundle/Entity/User.php
    namespace AppBundle\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    
    class User
    {
        /**
         * @Assert\NotBlank(payload = {"severity" = "error"})
         */
        protected $username;
    
        /**
         * @Assert\NotBlank(payload = {"severity" = "error"})
         */
        protected $password;
    
        /**
         * @Assert\Iban(payload = {"severity" = "warning"})
         */
        protected $bankAccountNumber;
    }
    
  • YAML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    # src/AppBundle/Resources/config/validation.yml
    AppBundle\Entity\User:
        properties:
            username:
                - NotBlank:
                    payload:
                        severity: error
            password:
                - NotBlank:
                    payload:
                        severity: error
            bankAccountNumber:
                - Iban:
                    payload:
                        severity: warning
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    <!-- src/AppBundle/Resources/config/validation.xml -->
    <?xml version="1.0" encoding="UTF-8" ?>
    <constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
    
        <class name="AppBundle\Entity\User">
            <property name="username">
                <constraint name="NotBlank">
                    <option name="payload">
                        <value key="severity">error</value>
                    </option>
                </constraint>
            </property>
            <property name="password">
                <constraint name="NotBlank">
                    <option name="payload">
                        <value key="severity">error</value>
                    </option>
                </constraint>
            </property>
            <property name="bankAccountNumber">
                <constraint name="Iban">
                    <option name="payload">
                        <value key="severity">warning</value>
                    </option>
                </constraint>
            </property>
        </class>
    </constraint-mapping>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    // src/AppBundle/Entity/User.php
    namespace AppBundle\Entity;
    
    use Symfony\Component\Validator\Mapping\ClassMetadata;
    use Symfony\Component\Validator\Constraints as Assert;
    
    class User
    {
        public static function loadValidatorMetadata(ClassMetadata $metadata)
        {
            $metadata->addPropertyConstraint('username', new Assert\NotBlank(array(
                'payload' => array('severity' => 'error'),
            )));
            $metadata->addPropertyConstraint('password', new Assert\NotBlank(array(
                'payload' => array('severity' => 'error'),
            )));
            $metadata->addPropertyConstraint('bankAccountNumber', new Assert\Iban(array(
                'payload' => array('severity' => 'warning'),
            )));
        }
    }
    

2. Customize the Error Message Template

When validation of the User object fails, you can retrieve the constraint that caused a particular failure using the getConstraint() method. Each constraint exposes the attached payload as a public property:

1
2
3
4
5
// a constraint validation failure, instance of
// Symfony\Component\Validator\ConstraintViolation
$constraintViolation = ...;
$constraint = $constraintViolation->getConstraint();
$severity = isset($constraint->payload['severity']) ? $constraint->payload['severity'] : null;

For example, you can leverage this to customize the form_errors block so that the severity is added as an additional HTML class:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{%- block form_errors -%}
    {%- if errors|length > 0 -%}
    <ul>
        {%- for error in errors -%}
            {% if error.cause.constraint.payload.severity is defined %}
                {% set severity = error.cause.constraint.payload.severity %}
            {% endif %}
            <li{% if severity is defined %} class="{{ severity }}"{% endif %}>{{ error.message }}</li>
        {%- endfor -%}
    </ul>
    {%- endif -%}
{%- endblock form_errors -%}
For more information on customizing form rendering, see How to Customize Form Rendering.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.