Skip to content

[Validator] Add support for the otherwise option in the When constraint #20627

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
Feb 10, 2025
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
33 changes: 32 additions & 1 deletion reference/constraints/When.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Applies to :ref:`class <validation-class-target>`
or :ref:`property/method <validation-property-target>`
Options - `expression`_
- `constraints`_
_ `otherwise`_
- `groups`_
- `payload`_
- `values`_
Expand Down Expand Up @@ -47,7 +48,7 @@ properties::
To validate the object, you have some requirements:

A) If ``type`` is ``percent``, then ``value`` must be less than or equal 100;
B) If ``type`` is ``absolute``, then ``value`` can be anything;
B) If ``type`` is not ``percent``, then ``value`` must be less than 9999;
C) No matter the value of ``type``, the ``value`` must be greater than 0.

One way to accomplish this is with the When constraint:
Expand All @@ -69,6 +70,9 @@ One way to accomplish this is with the When constraint:
constraints: [
new Assert\LessThanOrEqual(100, message: 'The value should be between 1 and 100!')
],
otherwise: [
new Assert\LessThan(9999, message: 'The value should be less than 9999!')
],
)]
private ?int $value;
Expand All @@ -88,6 +92,10 @@ One way to accomplish this is with the When constraint:
- LessThanOrEqual:
value: 100
message: "The value should be between 1 and 100!"
otherwise:
- LessThan:
value: 9999
message: "The value should be less than 9999!"
.. code-block:: xml
Expand All @@ -109,6 +117,12 @@ One way to accomplish this is with the When constraint:
<option name="message">The value should be between 1 and 100!</option>
</constraint>
</option>
<option name="otherwise">
<constraint name="LessThan">
<option name="value">9999</option>
<option name="message">The value should be less than 9999!</option>
</constraint>
</option>
</constraint>
</property>
</class>
Expand All @@ -135,6 +149,12 @@ One way to accomplish this is with the When constraint:
message: 'The value should be between 1 and 100!',
),
],
otherwise: [
new Assert\LessThan(
value: 9999,
message: 'The value should be less than 9999!',
),
],
));
}
Expand Down Expand Up @@ -279,6 +299,17 @@ You can also pass custom variables using the `values`_ option.

One or multiple constraints that are applied if the expression returns true.

``otherwise``
~~~~~~~~~~~~~

**type**: ``array|Constraint``

One or multiple constraints that are applied if the expression returns false.

.. versionadded:: 7.3

The ``otherwise`` option was introduced in Symfony 7.3.

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

.. include:: /reference/constraints/_payload-option.rst.inc
Expand Down