Skip to content

[Validator] Implement countUnit option for Length constraint #17948

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 11, 2023
Merged

[Validator] Implement countUnit option for Length constraint #17948

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce4b915
[Validator] Implement countUnit option for Length constraint
spackmat Feb 21, 2023
6e2e2f7
Update reference/constraints/Length.rst
spackmat Feb 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions reference/constraints/Length.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,29 @@ Parameter Description
``{{ value }}`` The current (invalid) value
================= ============================================================

``countUnit``
~~~~~~~~~~~~~

**type**: ``string`` **default**: ``Length::COUNT_CODEPOINTS``

The character count unit to use for the length check. By default :phpfunction:`mb_strlen`
is used, which counts Unicode code points.

Can be one of the following constants of the
:class:`Symfony\\Component\\Validator\\Constraints\\Length` class:

* ``COUNT_BYTES``: Uses :phpfunction:`strlen` counting the length of the string in bytes.
* ``COUNT_CODEPOINTS``: Uses :phpfunction:`mb_strlen` counting the length of the string in Unicode
code points. This was the sole behavior until Symfony 6.2 and is the default since Symfony 6.3.
Simple (multibyte) Unicode characters count as 1 character, while for example ZWJ sequences of
composed emojis count as multiple characters.
* ``COUNT_GRAPHEMES``: Uses :phpfunction:`grapheme_strlen` counting the length of the string in
graphemes, i.e. even emojis and ZWJ sequences of composed emojis count as 1 character.

.. versionadded:: 6.3

The ``countUnit`` option was introduced in Symfony 6.3.

``exactly``
~~~~~~~~~~~

Expand Down