[Validator] Add documention for ULID validator

laurent35240 · laurent35240 · commit 42c3a6dc33ca · 2020-10-05T22:10:40.000+02:00
diff --git a/reference/constraints/Ulid.rst b/reference/constraints/Ulid.rst
@@ -0,0 +1,107 @@
+ULID
+====
+
+.. versionadded:: 5.2
+
+    The ULID validator was introduced in Symfony 5.2.
+
+Validates that a value is a valid `Universally Unique Lexicographically Sortable Identifier (ULID)`_.
+
+==========  ===================================================================
+Applies to  :ref:`property or method <validation-property-target>`
+Options     - `groups`_
+            - `message`_
+            - `normalizer`_
+            - `payload`_
+Class       :class:`Symfony\\Component\\Validator\\Constraints\\Ulid`
+Validator   :class:`Symfony\\Component\\Validator\\Constraints\\UlidValidator`
+==========  ===================================================================
+
+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\Ulid
+             */
+            protected $identifier;
+        }
+
+    .. code-block:: yaml
+
+        # config/validator/validation.yaml
+        App\Entity\File:
+            properties:
+                identifier:
+                    - Ulid: ~
+
+    .. 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="Ulid"/>
+                </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\Ulid());
+            }
+        }
+
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
+Options
+-------
+
+.. include:: /reference/constraints/_groups-option.rst.inc
+
+``message``
+~~~~~~~~~~~
+
+**type**: ``string`` **default**: ``This is not a valid ULID.``
+
+This message is shown if the string is not a valid ULID.
+
+You can use the following parameters in this message:
+
+===============  ==============================================================
+Parameter        Description
+===============  ==============================================================
+``{{ value }}``  The current (invalid) value
+``{{ label }}``  Corresponding form field label
+===============  ==============================================================
+
+.. include:: /reference/constraints/_normalizer-option.rst.inc
+
+.. include:: /reference/constraints/_payload-option.rst.inc
+
+
+.. _`Universally Unique Lexicographically Sortable Identifier (ULID)`: https://github.com/ulid/spec
diff --git a/reference/constraints/map.rst.inc b/reference/constraints/map.rst.inc
@@ -24,6 +24,7 @@ String Constraints
 * :doc:`Ip </reference/constraints/Ip>`
 * :doc:`Json</reference/constraints/Json>`
 * :doc:`Uuid</reference/constraints/Uuid>`
+* :doc:`Ulid</reference/constraints/Ulid>`
 * :doc:`UserPassword </reference/constraints/UserPassword>`
 * :doc:`NotCompromisedPassword </reference/constraints/NotCompromisedPassword>`
 
