From 75d70c47510f2c23d2d7a6246473429c45aaeb6b Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Sun, 2 Nov 2014 20:09:53 +0100 Subject: [PATCH 1/5] Documented the new label_format option --- reference/forms/types/checkbox.rst | 2 ++ reference/forms/types/choice.rst | 2 ++ reference/forms/types/collection.rst | 2 ++ reference/forms/types/country.rst | 2 ++ reference/forms/types/currency.rst | 2 ++ reference/forms/types/email.rst | 2 ++ reference/forms/types/entity.rst | 2 ++ reference/forms/types/file.rst | 2 ++ reference/forms/types/form.rst | 2 ++ reference/forms/types/integer.rst | 2 ++ reference/forms/types/language.rst | 4 +++- reference/forms/types/locale.rst | 2 ++ reference/forms/types/money.rst | 2 ++ reference/forms/types/number.rst | 4 +++- .../forms/types/options/label_format.rst | 20 +++++++++++++++++++ reference/forms/types/password.rst | 2 ++ reference/forms/types/percent.rst | 2 ++ reference/forms/types/radio.rst | 2 ++ reference/forms/types/reset.rst | 2 ++ reference/forms/types/search.rst | 2 ++ reference/forms/types/submit.rst | 2 ++ reference/forms/types/text.rst | 2 ++ reference/forms/types/textarea.rst | 2 ++ reference/forms/types/timezone.rst | 2 ++ reference/forms/types/url.rst | 2 ++ 25 files changed, 70 insertions(+), 2 deletions(-) create mode 100644 reference/forms/types/options/label_format.rst diff --git a/reference/forms/types/checkbox.rst b/reference/forms/types/checkbox.rst index eeddb8031de..f688cc6a348 100644 --- a/reference/forms/types/checkbox.rst +++ b/reference/forms/types/checkbox.rst @@ -70,6 +70,8 @@ These options inherit from the :doc:`form ` type: .. include:: /reference/forms/types/options/label_attr.rst.inc +.. include:: /reference/forms/types/options/label_format.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc diff --git a/reference/forms/types/choice.rst b/reference/forms/types/choice.rst index 95c91e8442b..fed65381453 100644 --- a/reference/forms/types/choice.rst +++ b/reference/forms/types/choice.rst @@ -180,6 +180,8 @@ These options inherit from the :doc:`form ` type: .. include:: /reference/forms/types/options/label_attr.rst.inc +.. include:: /reference/forms/types/options/label_format.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc diff --git a/reference/forms/types/collection.rst b/reference/forms/types/collection.rst index 78df3fdf7b9..57c9d2fc830 100644 --- a/reference/forms/types/collection.rst +++ b/reference/forms/types/collection.rst @@ -383,6 +383,8 @@ error_bubbling .. include:: /reference/forms/types/options/label_attr.rst.inc +.. include:: /reference/forms/types/options/label_format.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/country.rst b/reference/forms/types/country.rst index c50ac519a48..372ad490270 100644 --- a/reference/forms/types/country.rst +++ b/reference/forms/types/country.rst @@ -100,6 +100,8 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/label_attr.rst.inc +.. include:: /reference/forms/types/options/label_format.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc diff --git a/reference/forms/types/currency.rst b/reference/forms/types/currency.rst index f009d726993..06a5b51586f 100644 --- a/reference/forms/types/currency.rst +++ b/reference/forms/types/currency.rst @@ -90,6 +90,8 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/label_attr.rst.inc +.. include:: /reference/forms/types/options/label_format.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc diff --git a/reference/forms/types/email.rst b/reference/forms/types/email.rst index d6277f5bee9..28cd86365be 100644 --- a/reference/forms/types/email.rst +++ b/reference/forms/types/email.rst @@ -53,6 +53,8 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/label_attr.rst.inc +.. include:: /reference/forms/types/options/label_format.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/max_length.rst.inc diff --git a/reference/forms/types/entity.rst b/reference/forms/types/entity.rst index dcada6d96eb..92ff6a4f745 100644 --- a/reference/forms/types/entity.rst +++ b/reference/forms/types/entity.rst @@ -240,6 +240,8 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/label_attr.rst.inc +.. include:: /reference/forms/types/options/label_format.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc diff --git a/reference/forms/types/file.rst b/reference/forms/types/file.rst index 67e7d34c5b3..506a211def7 100644 --- a/reference/forms/types/file.rst +++ b/reference/forms/types/file.rst @@ -116,6 +116,8 @@ The default value is ``null``. .. include:: /reference/forms/types/options/label_attr.rst.inc +.. include:: /reference/forms/types/options/label_format.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc diff --git a/reference/forms/types/form.rst b/reference/forms/types/form.rst index ae0f66edcc0..45be80c30b5 100644 --- a/reference/forms/types/form.rst +++ b/reference/forms/types/form.rst @@ -94,6 +94,8 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/label_attr.rst.inc +.. include:: /reference/forms/types/options/label_format.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc .. _reference-form-option-max_length: diff --git a/reference/forms/types/integer.rst b/reference/forms/types/integer.rst index edf9e9c1b9b..74c40e93958 100644 --- a/reference/forms/types/integer.rst +++ b/reference/forms/types/integer.rst @@ -102,6 +102,8 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/label_attr.rst.inc +.. include:: /reference/forms/types/options/label_format.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc diff --git a/reference/forms/types/language.rst b/reference/forms/types/language.rst index 120cb37b11c..798171c0a56 100644 --- a/reference/forms/types/language.rst +++ b/reference/forms/types/language.rst @@ -8,7 +8,7 @@ The ``language`` type is a subset of the ``ChoiceType`` that allows the user to select from a large list of languages. As an added bonus, the language names are displayed in the language of the user. -The "value" for each language is the *Unicode language identifier* used in +The "value" for each language is the *Unicode language identifier* used in the `International Components for Unicode`_ (e.g. ``fr`` or ``zh_Hant``). .. note:: @@ -101,6 +101,8 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/label_attr.rst.inc +.. include:: /reference/forms/types/options/label_format.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc diff --git a/reference/forms/types/locale.rst b/reference/forms/types/locale.rst index e8610495901..07ad8d56b95 100644 --- a/reference/forms/types/locale.rst +++ b/reference/forms/types/locale.rst @@ -103,6 +103,8 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/label_attr.rst.inc +.. include:: /reference/forms/types/options/label_format.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc diff --git a/reference/forms/types/money.rst b/reference/forms/types/money.rst index dd466595c3b..5eae31cd7f8 100644 --- a/reference/forms/types/money.rst +++ b/reference/forms/types/money.rst @@ -112,6 +112,8 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/label_attr.rst.inc +.. include:: /reference/forms/types/options/label_format.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc diff --git a/reference/forms/types/number.rst b/reference/forms/types/number.rst index 29f4edfaf2e..453379b8da5 100644 --- a/reference/forms/types/number.rst +++ b/reference/forms/types/number.rst @@ -48,7 +48,7 @@ rounding_mode If a submitted number needs to be rounded (based on the ``precision`` option), you have several configurable options for that rounding. Each option is a constant on the :class:`Symfony\\Component\\Form\\Extension\\Core\\DataTransformer\\NumberToLocalizedStringTransformer`: - + * ``NumberToLocalizedStringTransformer::ROUND_DOWN`` Round towards zero. * ``NumberToLocalizedStringTransformer::ROUND_FLOOR`` Round towards negative @@ -98,6 +98,8 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/label_attr.rst.inc +.. include:: /reference/forms/types/options/label_format.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc diff --git a/reference/forms/types/options/label_format.rst b/reference/forms/types/options/label_format.rst new file mode 100644 index 00000000000..c867ca90055 --- /dev/null +++ b/reference/forms/types/options/label_format.rst @@ -0,0 +1,20 @@ +label_format +~~~~~~~~~~~~ + +**type**: ``string`` **default**: The label is "humanized" version of the field name + +Sets the format applied to generate the ``