From baa67ddd515ae2c2be744011d011229e864e8472 Mon Sep 17 00:00:00 2001 From: Christian Stoller Date: Tue, 4 Mar 2014 10:32:49 +0100 Subject: [PATCH] Added documentation for message option of the `True` constraint --- reference/constraints/Valid.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/reference/constraints/Valid.rst b/reference/constraints/Valid.rst index 79c1b992ef9..029f6c50cde 100644 --- a/reference/constraints/Valid.rst +++ b/reference/constraints/Valid.rst @@ -9,6 +9,7 @@ object and all sub-objects associated with it. | Applies to | :ref:`property or method ` | +----------------+---------------------------------------------------------------------+ | Options | - `traverse`_ | +| | - `message`_ | +----------------+---------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Validator\\Constraints\\Type` | +----------------+---------------------------------------------------------------------+ @@ -263,3 +264,10 @@ traverse 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 +~~~~~~~ + +**type**: ``string`` **default**: ``This value should be true.`` + +This is the message that will be shown if the value is false.