Regex ¶

groups ¶

type: array | string

It defines the validation group or groups of this constraint. Read more about validation groups.

htmlPattern ¶

type: string|boolean default: null

This option specifies the pattern to use in the HTML5 pattern attribute. You usually don't need to specify this option because by default, the constraint will convert the pattern given in the pattern option into an HTML5 compatible pattern. Notably, the delimiters are removed and the anchors are implicit (e.g. /^[a-z]+$/ becomes [a-z]+, and /[a-z]+/ becomes .*[a-z]+.*).

However, there are some other incompatibilities between both patterns which cannot be fixed by the constraint. For instance, the HTML5 pattern attribute does not support flags. If you have a pattern like /^[a-z]+$/i, you need to specify the HTML5 compatible pattern in the htmlPattern option:

1
2
3
4
5
6
7
8
9
10
11
12
13

// src/Entity/Author.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    #[Assert\Regex(
        pattern: '/^[a-z]+$/i',
        htmlPattern: '^[a-zA-Z]+$'
    )]
    protected $name;
}

1
2
3
4
5
6
7

# config/validator/validation.yaml
App\Entity\Author:
    properties:
        name:
            - Regex:
                pattern: '/^[a-z]+$/i'
                htmlPattern: '[a-zA-Z]+'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

<!-- config/validator/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 https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

    <class name="App\Entity\Author">
        <property name="name">
            <constraint name="Regex">
                <option name="pattern">/^[a-z]+$/i</option>
                <option name="htmlPattern">[a-zA-Z]+</option>
            </constraint>
        </property>
    </class>
</constraint-mapping>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

// src/Entity/Author.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Mapping\ClassMetadata;

class Author
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('name', new Assert\Regex([
            'pattern' => '/^[a-z]+$/i',
            'htmlPattern' => '[a-zA-Z]+',
        ]));
    }
}

Setting htmlPattern to false will disable client side validation.

match ¶

type: boolean default: true

If true (or not set), this validator will pass if the given string matches the given pattern regular expression. However, when this option is set to false, the opposite will occur: validation will pass only if the given string does not match the pattern regular expression.

message ¶

type: string default: This value is not valid.

This is the message that will be shown if this validator fails.

You can use the following parameters in this message:

pattern ¶

type: string [default option]

This required option is the regular expression pattern that the input will be matched against. By default, this validator will fail if the input string does not match this regular expression (via the preg_match PHP function). However, if match is set to false, then validation will fail if the input string does match this pattern.

normalizer ¶

type: a PHP callable default: null

This option allows to define the PHP callable applied to the given value before checking if it is valid.

For example, you may want to pass the 'trim' string to apply the trim PHP function in order to ignore leading and trailing whitespace during validation.

payload ¶

type: mixed default: null

This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.

For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.