UUID

Warning: You are browsing the documentation for Symfony 7.0, which is no longer maintained.

Read the updated version of this page for Symfony 7.2 (the current stable version).

Validates that a value is a valid Universally unique identifier (UUID) per RFC 4122. By default, this will validate the format according to the RFC's guidelines, but this can be relaxed to accept non-standard UUIDs that other systems (like PostgreSQL) accept. UUID versions can also be restricted using a list of allowed versions.

Applies to	property or method
Class	Uuid
Validator	UuidValidator

Basic Usage

        1
2
3
4
5
6
7
8
9
10
        // src/Entity/File.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class File
{
    #[Assert\Uuid]
    protected string $identifier;
}
    

        1
2
3
4
5
        # config/validator/validation.yaml
App\Entity\File:
    properties:
        identifier:
            - Uuid: ~
    

        1
2
3
4
5
6
7
8
9
10
11
12
        <!-- 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\File">
        <property name="identifier">
            <constraint name="Uuid"/>
        </property>
    </class>
</constraint-mapping>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        // src/Entity/File.php
namespace App\Entity;

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

class File
{
    // ...

    public static function loadValidatorMetadata(ClassMetadata $metadata): void
    {
        $metadata->addPropertyConstraint('identifier', new Assert\Uuid());
    }
}
    

Note

As with most of the other constraints, null and empty strings are considered valid values. This is to allow them to be optional values. If the value is mandatory, a common solution is to combine this constraint with NotBlank.

Options

`groups`

type: array | string default: null

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

`message`

type: string default: This is not a valid UUID.

This message is shown if the string is not a valid UUID.

You can use the following parameters in this message:

Parameter	Description
`{{ value }}`	The current (invalid) value
`{{ label }}`	Corresponding form field label

`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.

`strict`

type: boolean default: true

If this option is set to true the constraint will check if the UUID is formatted per the RFC's input format rules: 216fff40-98d9-11e3-a5e2-0800200c9a66. Setting this to false will allow alternate input formats like:

216f-ff40-98d9-11e3-a5e2-0800-200c-9a66
{216fff40-98d9-11e3-a5e2-0800200c9a66}
216fff4098d911e3a5e20800200c9a66

`versions`

type: int[]|int default: [1,2,3,4,5,6,7,8]

This option can be used to only allow specific UUID versions (by default, all of them are allowed). Valid versions are 1 - 8. Instead of using numeric values, you can also use the following PHP constants to refer to each UUID version:

Uuid::V1_MAC
Uuid::V2_DCE
Uuid::V3_MD5
Uuid::V4_RANDOM
Uuid::V5_SHA1
Uuid::V6_SORTABLE
Uuid::V7_MONOTONIC
Uuid::V8_CUSTOM

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

TOC

Version