Uuid.rst

UUID

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	:ref:`property or method <validation-property-target>`
Class	:class:`Symfony\\Component\\Validator\\Constraints\\Uuid`
Validator	:class:`Symfony\\Component\\Validator\\Constraints\\UuidValidator`

Basic Usage

.. configuration-block::

    .. code-block:: php-annotations

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

        use Symfony\Component\Validator\Constraints as Assert;

        class File
        {
            /**
             * @Assert\Uuid
             */
            protected $identifier;
        }

    .. code-block:: php-attributes

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

        use Symfony\Component\Validator\Constraints as Assert;

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

    .. code-block:: yaml

        # config/validator/validation.yaml
        App\Entity\File:
            properties:
                identifier:
                    - Uuid: ~

    .. code-block:: xml

        <!-- 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>

    .. code-block:: php

        // 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)
            {
                $metadata->addPropertyConstraint('identifier', new Assert\Uuid());
            }
        }

Options

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

.. versionadded:: 5.2

    The ``{{ label }}`` parameter was introduced in Symfony 5.2.

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[] default: [1,2,3,4,5,6]

This option can be used to only allow specific UUID versions. Valid versions are 1 - 6. The following PHP constants can also be used:

• Uuid::V1_MAC
• Uuid::V2_DCE
• Uuid::V3_MD5
• Uuid::V4_RANDOM
• Uuid::V5_SHA1
• Uuid::V6_SORTABLE

All six versions are allowed by default.

.. versionadded:: 5.2

    The UUID 6 version support was introduced in Symfony 5.2.