Skip to content

Updated Valid constraint reference #4351

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

Closed
wants to merge 1 commit into from
Closed

Updated Valid constraint reference #4351

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 11 additions & 5 deletions reference/constraints/Valid.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
Valid
=====

.. caution::

The ``deep`` option is deprecated since Symfony 2.5 and will be removed in Symfony 3.0.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be moved to just after the deep title.


This constraint is used to enable validation on objects that are embedded
as properties on an object being validated. This allows you to validate an
object and all sub-objects associated with it.
Expand All @@ -9,9 +13,9 @@ object and all sub-objects associated with it.
| Applies to | :ref:`property or method <validation-property-target>` |
+----------------+---------------------------------------------------------------------+
| Options | - `traverse`_ |
| | - `message`_ |
| | - `deep`_ |
+----------------+---------------------------------------------------------------------+
| Class | :class:`Symfony\\Component\\Validator\\Constraints\\Type` |
| Class | :class:`Symfony\\Component\\Validator\\Constraints\\Valid` |
+----------------+---------------------------------------------------------------------+

.. include:: /reference/forms/types/options/_error_bubbling_hint.rst.inc
Expand Down Expand Up @@ -267,9 +271,11 @@ If this constraint is applied to a property that holds an array of objects,
then each object in that array will be validated only if this option is set
to ``true``.

message
deep
~~~~~~~
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the length of the ~ needs to be equal to the length of the title


**type**: ``string`` **default**: ``This value should be true.``
**type**: ``boolean`` **default**: ``false``

This is the message that will be shown if the value is false.
If this constraint is applied to a property that holds an array of objects,
then each object in that array will be validated recursively if this option is set
to ``true``.