From 13b69811c8f331f3dac073e0637a2a782f3ccb44 Mon Sep 17 00:00:00 2001 From: dtonder Date: Wed, 10 Jan 2018 11:53:41 +0100 Subject: [PATCH 1/5] issue-13589: adjust docs for custom-false-values for checkbox type, refs #13589 on symfony --- reference/forms/types/checkbox.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/reference/forms/types/checkbox.rst b/reference/forms/types/checkbox.rst index 69c4fee5199..5bb0c5cc542 100644 --- a/reference/forms/types/checkbox.rst +++ b/reference/forms/types/checkbox.rst @@ -6,12 +6,13 @@ checkbox Field Type Creates a single input checkbox. This should always be used for a field that has a Boolean value: if the box is checked, the field will be set to true, -if the box is unchecked, the value will be set to false. +if the box is unchecked, the value will be set to false. Optionally you can specify values that, when submitted, will be evaluated to false as well (this differs from what HTTP defines, but can be helpful if you want to handle strings '0' / '1' with the CheckBoxType). +-------------+------------------------------------------------------------------------+ | Rendered as | ``input`` ``checkbox`` field | +-------------+------------------------------------------------------------------------+ | Options | - `value`_ | +| Options | - `false_values`_ | +-------------+------------------------------------------------------------------------+ | Overridden | - `empty_data`_ | | options | - `compound`_ | From 9ea3f4ff72e2218db0ab8aecef45ff00efee154e Mon Sep 17 00:00:00 2001 From: dtonder Date: Fri, 18 May 2018 10:34:24 +0200 Subject: [PATCH 2/5] adding type-options doc for false_values --- reference/forms/types/checkbox.rst | 1 + reference/forms/types/options/false_values.rst.inc | 6 ++++++ 2 files changed, 7 insertions(+) create mode 100644 reference/forms/types/options/false_values.rst.inc diff --git a/reference/forms/types/checkbox.rst b/reference/forms/types/checkbox.rst index cf3ae06eb4b..1df4bc961a2 100644 --- a/reference/forms/types/checkbox.rst +++ b/reference/forms/types/checkbox.rst @@ -52,6 +52,7 @@ Field Options ------------- .. include:: /reference/forms/types/options/value.rst.inc +.. include:: /reference/forms/types/options/false_values.rst.inc Overridden Options ------------------ diff --git a/reference/forms/types/options/false_values.rst.inc b/reference/forms/types/options/false_values.rst.inc new file mode 100644 index 00000000000..660212bc695 --- /dev/null +++ b/reference/forms/types/options/false_values.rst.inc @@ -0,0 +1,6 @@ +false_values +~~~~~ + +**type**: ``array`` **default**: ``array(null)`` + +An array of values to be interpreted as `false`. From ecc6fadfb9a9a02a74a4ad1555407851eef970f8 Mon Sep 17 00:00:00 2001 From: dtonder Date: Fri, 18 May 2018 14:32:56 +0200 Subject: [PATCH 3/5] fixing false-value doc markup --- reference/forms/types/options/false_values.rst.inc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/forms/types/options/false_values.rst.inc b/reference/forms/types/options/false_values.rst.inc index 660212bc695..094db3530e7 100644 --- a/reference/forms/types/options/false_values.rst.inc +++ b/reference/forms/types/options/false_values.rst.inc @@ -1,5 +1,5 @@ false_values -~~~~~ +~~~~~~~~~~~~ **type**: ``array`` **default**: ``array(null)`` From bb360df46e683dc02e9f75b00115decb95f6e233 Mon Sep 17 00:00:00 2001 From: dtonder Date: Fri, 18 May 2018 16:17:08 +0200 Subject: [PATCH 4/5] sort options in alphabetical order --- reference/forms/types/checkbox.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/reference/forms/types/checkbox.rst b/reference/forms/types/checkbox.rst index 1df4bc961a2..ce751f5dbdf 100644 --- a/reference/forms/types/checkbox.rst +++ b/reference/forms/types/checkbox.rst @@ -14,8 +14,8 @@ if you want to handle submitted values like "0" or "false"). +-------------+------------------------------------------------------------------------+ | Rendered as | ``input`` ``checkbox`` field | +-------------+------------------------------------------------------------------------+ -| Options | - `value`_ | -| | - `false_values`_ | +| Options | - `false_values`_ | +| | - `value`_ | +-------------+------------------------------------------------------------------------+ | Overridden | - `compound`_ | | options | - `empty_data`_ | @@ -51,8 +51,8 @@ Example Usage Field Options ------------- -.. include:: /reference/forms/types/options/value.rst.inc .. include:: /reference/forms/types/options/false_values.rst.inc +.. include:: /reference/forms/types/options/value.rst.inc Overridden Options ------------------ From 34f8c11f6f98f8446bf812f77f83236744045526 Mon Sep 17 00:00:00 2001 From: dtonder Date: Fri, 18 May 2018 17:01:32 +0200 Subject: [PATCH 5/5] fixing false-value doc markup --- reference/forms/types/options/false_values.rst.inc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/forms/types/options/false_values.rst.inc b/reference/forms/types/options/false_values.rst.inc index 094db3530e7..22325dc5122 100644 --- a/reference/forms/types/options/false_values.rst.inc +++ b/reference/forms/types/options/false_values.rst.inc @@ -3,4 +3,4 @@ false_values **type**: ``array`` **default**: ``array(null)`` -An array of values to be interpreted as `false`. +An array of values to be interpreted as ``false``.