Skip to content

[Validator] Documented the allowEmptyString option in Length #11886

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.

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 1 commit into from
Jul 4, 2019
Merged
Changes from all commits
Commits
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: 16 additions & 7 deletions reference/constraints/Length.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,10 @@ Length

Validates that a given string length is *between* some minimum and maximum value.

.. caution::

``null`` and empty strings are not handled by this constraint. You need to
also add the :doc:`/reference/constraints/NotBlank` or :doc:`/reference/constraints/NotNull`
constraints to validate against these.

========== ===================================================================
Applies to :ref:`property or method <validation-property-target>`
Options - `charset`_
Options - `allowEmptyString`_
- `charset`_
- `charsetMessage`_
- `exactMessage`_
- `groups`_
Expand Down Expand Up @@ -115,6 +110,20 @@ and "50", you might add the following:
Options
-------

allowEmptyString
~~~~~~~~~~~~~~~~

**type**: ``boolean`` **default**: ``true``

.. versionadded:: 4.4

The ``allowEmptyString`` option was introduced in Symfony 4.4.

When using the ``min`` option, it's mandatory to also define this option. If
set to ``true``, empty strings are considered valid (which is the same behavior
as previous Symfony versions). Set it to ``false`` to consider empty strings not
valid.

charset
~~~~~~~

Expand Down