minor #15124 [Validator] Add normalizer option to Unique constraint (henry2778)

javiereguiluz · javiereguiluz · commit b4d93f3a9316 · 2021-03-27T20:00:54.000+01:00
This PR was squashed before being merged into the 5.3-dev branch. Discussion ---------- [Validator] Add normalizer option to Unique constraint Hello. Documenting the feature symfony/symfony#38488 about `normalizer` option for Unique constraint. 1. Updated the intro paragraph mentioning the strict comparison 2. Added normalizer to the option list 3. Added normalizer option description. There is a include file for that, but since the description is slightly different, I decided not use it. Thanks! Commits ------- 92072d9 [Validator] Add normalizer option to Unique constraint
diff --git a/reference/constraints/Unique.rst b/reference/constraints/Unique.rst
@@ -2,8 +2,9 @@ Unique
 ======
 
 Validates that all the elements of the given collection are unique (none of them
-is present more than once). Elements are compared strictly, so ``'7'`` and ``7``
-are considered different elements (a string and an integer, respectively).
+is present more than once). By default elements are compared strictly,
+so ``'7'`` and ``7`` are considered different elements (a string and an integer, respectively).
+If you want any other comparison logic to be applied, use the `normalizer`_ option.
 
 .. seealso::
 
@@ -21,6 +22,7 @@ are considered different elements (a string and an integer, respectively).
 Applies to  :ref:`property or method <validation-property-target>`
 Options     - `groups`_
             - `message`_
+            - `normalizer`_
             - `payload`_
 Class       :class:`Symfony\\Component\\Validator\\Constraints\\Unique`
 Validator   :class:`Symfony\\Component\\Validator\\Constraints\\UniqueValidator`
@@ -123,4 +125,22 @@ Parameter                      Description
 ``{{ value }}``                The current (invalid) value
 =============================  ================================================
 
+``normalizer``
+~~~~~~~~~~~~~~
+
+**type**: a `PHP callable`_ **default**: ``null``
+
+.. versionadded:: 5.3
+
+    The ``normalizer`` option was introduced in Symfony 5.3.
+
+This option allows to define the PHP callable applied to each element of the given collection before
+checking if the collection is valid.
+
+For example, you may want to pass the ``'trim'`` string to apply the
+:phpfunction:`trim` PHP function to each element of the collection in order to ignore leading and trailing
+whitespace during validation.
+
 .. include:: /reference/constraints/_payload-option.rst.inc
+
+.. _`PHP callable`: https://www.php.net/callable
