Skip to content

[Validator] Document the invalidDateTimeMessage option #14284

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
Oct 3, 2020
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
25 changes: 23 additions & 2 deletions reference/constraints/Range.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Validates that a given number or ``DateTime`` object is *between* some minimum a
========== ===================================================================
Applies to :ref:`property or method <validation-property-target>`
Options - `groups`_
- `invalidDateTimeMessage`_
- `invalidMessage`_
- `max`_
- `maxMessage`_
Expand Down Expand Up @@ -316,13 +317,33 @@ Options

.. include:: /reference/constraints/_groups-option.rst.inc

invalidDateTimeMessage
~~~~~~~~~~~~~~~~~~~~~~

**type**: ``string`` **default**: ``This value should be a valid number.``

.. versionadded:: 5.2

The ``invalidDateTimeMessage`` option was introduced in Symfony 5.2.

The message displayed when the ``min`` and ``max`` values are PHP datetimes but
the given value is not.

You can use the following parameters in this message:

=============== ==============================================================
Parameter Description
=============== ==============================================================
``{{ value }}`` The current (invalid) value
=============== ==============================================================

invalidMessage
~~~~~~~~~~~~~~

**type**: ``string`` **default**: ``This value should be a valid number.``

The message that will be shown if the underlying value is not a number (per
the :phpfunction:`is_numeric` PHP function).
The message displayed when the ``min`` and ``max`` values are numeric (per
the :phpfunction:`is_numeric` PHP function) but the given value is not.

You can use the following parameters in this message:

Expand Down