Skip to content

Commit c06967c

Browse files
author
Adam Szaraniec
committed
code style standardization on form type options
1 parent a3e2469 commit c06967c

31 files changed

+54
-54
lines changed

reference/configuration/framework.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ http_method_override
7272
.. versionadded:: 2.3
7373
The ``http_method_override`` option was introduced in Symfony 2.3.
7474

75-
**type**: ``Boolean`` **default**: ``true``
75+
**type**: ``boolean`` **default**: ``true``
7676

7777
This determines whether the ``_method`` request parameter is used as the intended
7878
HTTP method on POST requests. If enabled, the
@@ -143,7 +143,7 @@ is set, then the ``ide`` option will be ignored.
143143
test
144144
~~~~
145145

146-
**type**: ``Boolean``
146+
**type**: ``boolean``
147147

148148
If this configuration parameter is present (and not ``false``), then the
149149
services related to testing your application (e.g. ``test.client``) are loaded.
@@ -251,14 +251,14 @@ to the cookie specification.
251251
cookie_secure
252252
.............
253253

254-
**type**: ``Boolean`` **default**: ``false``
254+
**type**: ``boolean`` **default**: ``false``
255255

256256
This determines whether cookies should only be sent over secure connections.
257257

258258
cookie_httponly
259259
...............
260260

261-
**type**: ``Boolean`` **default**: ``false``
261+
**type**: ``boolean`` **default**: ``false``
262262

263263
This determines whether cookies should only be accessible through the HTTP protocol.
264264
This means that the cookie won't be accessible by scripting languages, such
@@ -552,7 +552,7 @@ to implement the :class:`Symfony\\Component\\Validator\\Mapping\\Cache\\CacheInt
552552
enable_annotations
553553
..................
554554

555-
**type**: ``Boolean`` **default**: ``false``
555+
**type**: ``boolean`` **default**: ``false``
556556

557557
If this option is enabled, validation constraints can be defined using annotations.
558558

reference/configuration/security.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ a separate firewall just for ``check_path`` URL).
276276
use_forward
277277
...........
278278

279-
**type**: ``Boolean`` **default**: ``false``
279+
**type**: ``boolean`` **default**: ``false``
280280

281281
If you'd like the user to be forwarded to the login form instead of being
282282
redirected, set this option to ``true``.
@@ -302,7 +302,7 @@ will look for a POST parameter with this name.
302302
post_only
303303
.........
304304

305-
**type**: ``Boolean`` **default**: ``true``
305+
**type**: ``boolean`` **default**: ``true``
306306

307307
By default, you must submit your login form to the ``check_path`` URL as
308308
a POST request. By setting this option to ``false``, you can send a GET request
@@ -311,10 +311,10 @@ to the ``check_path`` URL.
311311
Redirecting after Login
312312
~~~~~~~~~~~~~~~~~~~~~~~
313313

314-
* ``always_use_default_target_path`` (type: ``Boolean``, default: ``false``)
314+
* ``always_use_default_target_path`` (type: ``boolean``, default: ``false``)
315315
* ``default_target_path`` (type: ``string``, default: ``/``)
316316
* ``target_path_parameter`` (type: ``string``, default: ``_target_path``)
317-
* ``use_referer`` (type: ``Boolean``, default: ``false``)
317+
* ``use_referer`` (type: ``boolean``, default: ``false``)
318318

319319
.. _reference-security-pbkdf2:
320320

reference/configuration/swiftmailer.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,15 +159,15 @@ on the ``X-Swift-To``, ``X-Swift-Cc`` and ``X-Swift-Bcc`` headers.
159159
disable_delivery
160160
~~~~~~~~~~~~~~~~
161161

162-
**type**: ``Boolean`` **default**: ``false``
162+
**type**: ``boolean`` **default**: ``false``
163163

164164
If true, the ``transport`` will automatically be set to ``null``, and no
165165
emails will actually be delivered.
166166

167167
logging
168168
~~~~~~~
169169

170-
**type**: ``Boolean`` **default**: ``%kernel.debug%``
170+
**type**: ``boolean`` **default**: ``%kernel.debug%``
171171

172172
If true, Symfony's data collector will be activated for Swift Mailer and the
173173
information will be available in the profiler.

reference/constraints/Choice.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ for details on its usage.
281281
multiple
282282
~~~~~~~~
283283

284-
**type**: ``Boolean`` **default**: ``false``
284+
**type**: ``boolean`` **default**: ``false``
285285

286286
If this option is true, the input value is expected to be an array instead
287287
of a single, scalar value. The constraint will check that each value of
@@ -344,7 +344,7 @@ too many options per the `max`_ option.
344344
strict
345345
~~~~~~
346346

347-
**type**: ``Boolean`` **default**: ``false``
347+
**type**: ``boolean`` **default**: ``false``
348348

349349
If true, the validator will also check the type of the input value. Specifically,
350350
this value is passed to as the third argument to the PHP :phpfunction:`in_array` method

reference/constraints/Collection.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ be executed against that element of the collection.
298298
allowExtraFields
299299
~~~~~~~~~~~~~~~~
300300

301-
**type**: ``Boolean`` **default**: false
301+
**type**: ``boolean`` **default**: false
302302

303303
If this option is set to ``false`` and the underlying collection contains
304304
one or more elements that are not included in the `fields`_ option, a validation
@@ -307,14 +307,14 @@ error will be returned. If set to ``true``, extra fields are ok.
307307
extraFieldsMessage
308308
~~~~~~~~~~~~~~~~~~
309309

310-
**type**: ``Boolean`` **default**: ``The fields {{ fields }} were not expected.``
310+
**type**: ``boolean`` **default**: ``The fields {{ fields }} were not expected.``
311311

312312
The message shown if `allowExtraFields`_ is false and an extra field is detected.
313313

314314
allowMissingFields
315315
~~~~~~~~~~~~~~~~~~
316316

317-
**type**: ``Boolean`` **default**: false
317+
**type**: ``boolean`` **default**: false
318318

319319
If this option is set to ``false`` and one or more fields from the `fields`_
320320
option are not present in the underlying collection, a validation error will
@@ -324,7 +324,7 @@ option are not present in the underlying collection.
324324
missingFieldsMessage
325325
~~~~~~~~~~~~~~~~~~~~
326326

327-
**type**: ``Boolean`` **default**: ``The fields {{ fields }} are missing.``
327+
**type**: ``boolean`` **default**: ``The fields {{ fields }} are missing.``
328328

329329
The message shown if `allowMissingFields`_ is false and one or more fields
330330
are missing from the underlying collection.

reference/constraints/Email.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,15 +99,15 @@ This message is shown if the underlying data is not a valid email address.
9999
checkMX
100100
~~~~~~~
101101

102-
**type**: ``Boolean`` **default**: ``false``
102+
**type**: ``boolean`` **default**: ``false``
103103

104104
If true, then the :phpfunction:`checkdnsrr` PHP function will be used to
105105
check the validity of the MX record of the host of the given email.
106106

107107
checkHost
108108
~~~~~~~~~
109109

110-
**type**: ``Boolean`` **default**: ``false``
110+
**type**: ``boolean`` **default**: ``false``
111111

112112
If true, then the :phpfunction:`checkdnsrr` PHP function will be used to
113113
check the validity of the MX *or* the A *or* the AAAA record of the host

reference/constraints/Issn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,15 +90,15 @@ The message shown if the given value is not a valid ISSN.
9090
caseSensitive
9191
~~~~~~~~~~~~~
9292

93-
**type**: ``Boolean`` default: ``false``
93+
**type**: ``boolean`` default: ``false``
9494

9595
The validator will allow ISSN values to end with a lower case 'x' by default.
9696
When switching this to ``true``, the validator requires an upper case 'X'.
9797

9898
requireHyphen
9999
~~~~~~~~~~~~~
100100

101-
**type**: ``Boolean`` default: ``false``
101+
**type**: ``boolean`` default: ``false``
102102

103103
The validator will allow non hyphenated ISSN values by default. When switching
104104
this to ``true``, the validator requires a hyphenated ISSN value.

reference/constraints/Regex.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ Setting ``htmlPattern`` to false will disable client side validation.
264264
match
265265
~~~~~
266266

267-
**type**: ``Boolean`` default: ``true``
267+
**type**: ``boolean`` default: ``true``
268268

269269
If ``true`` (or not set), this validator will pass if the given string matches
270270
the given `pattern`_ regular expression. However, when this option is set

reference/constraints/UniqueEntity.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ Now, the message would be bound to the ``port`` field with this configuration.
257257
ignoreNull
258258
~~~~~~~~~~
259259

260-
**type**: ``Boolean`` **default**: ``true``
260+
**type**: ``boolean`` **default**: ``true``
261261

262262
.. versionadded:: 2.1
263263
The ``ignoreNull`` option was introduced in Symfony 2.1.

reference/forms/types/choice.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -192,9 +192,9 @@ Field Variables
192192
+------------------------+--------------+-------------------------------------------------------------------+
193193
| Variable | Type | Usage |
194194
+========================+==============+===================================================================+
195-
| multiple | ``Boolean`` | The value of the `multiple`_ option. |
195+
| multiple | ``boolean`` | The value of the `multiple`_ option. |
196196
+------------------------+--------------+-------------------------------------------------------------------+
197-
| expanded | ``Boolean`` | The value of the `expanded`_ option. |
197+
| expanded | ``boolean`` | The value of the `expanded`_ option. |
198198
+------------------------+--------------+-------------------------------------------------------------------+
199199
| preferred_choices | ``array`` | A nested array containing the ``ChoiceView`` objects of |
200200
| | | choices which should be presented to the user with priority. |
@@ -210,7 +210,7 @@ Field Variables
210210
| is_selected | ``callable`` | A callable which takes a ``ChoiceView`` and the selected value(s) |
211211
| | | and returns whether the choice is in the selected value(s). |
212212
+------------------------+--------------+-------------------------------------------------------------------+
213-
| empty_value_in_choices | ``Boolean`` | Whether the empty value is in the choice list. |
213+
| empty_value_in_choices | ``boolean`` | Whether the empty value is in the choice list. |
214214
+------------------------+--------------+-------------------------------------------------------------------+
215215

216216
.. tip::

reference/forms/types/collection.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ Field Options
214214
allow_add
215215
~~~~~~~~~
216216

217-
**type**: ``Boolean`` **default**: ``false``
217+
**type**: ``boolean`` **default**: ``false``
218218

219219
If set to ``true``, then if unrecognized items are submitted to the collection,
220220
they will be added as new items. The ending array will contain the existing
@@ -235,7 +235,7 @@ client side. For more information, see the above example and :ref:`cookbook-form
235235
allow_delete
236236
~~~~~~~~~~~~
237237

238-
**type**: ``Boolean`` **default**: ``false``
238+
**type**: ``boolean`` **default**: ``false``
239239

240240
If set to ``true``, then if an existing item is not contained in the submitted
241241
data, it will be correctly absent from the final array of items. This means
@@ -280,7 +280,7 @@ you'd need to at least pass the ``choices`` option to the underlying type::
280280
prototype
281281
~~~~~~~~~
282282

283-
**type**: ``Boolean`` **default**: ``true``
283+
**type**: ``boolean`` **default**: ``true``
284284

285285
This option is useful when using the `allow_add`_ option. If ``true`` (and
286286
if `allow_add`_ is also ``true``), a special "prototype" attribute will be
@@ -319,7 +319,7 @@ as :ref:`cookbook-form-collections-new-prototype`.
319319
prototype_name
320320
~~~~~~~~~~~~~~
321321

322-
**type**: ``String`` **default**: ``__name__``
322+
**type**: ``string`` **default**: ``__name__``
323323

324324
If you have several collections in your form, or worse, nested collections
325325
you may want to change the placeholder so that unrelated placeholders are not
@@ -359,7 +359,7 @@ The default value is ``array()`` (empty array).
359359
error_bubbling
360360
~~~~~~~~~~~~~~
361361

362-
**type**: ``Boolean`` **default**: ``true``
362+
**type**: ``boolean`` **default**: ``true``
363363

364364
.. include:: /reference/forms/types/options/_error_bubbling_body.rst.inc
365365

@@ -379,6 +379,6 @@ Field Variables
379379
============ =========== ========================================
380380
Variable Type Usage
381381
============ =========== ========================================
382-
allow_add ``Boolean`` The value of the `allow_add`_ option.
383-
allow_delete ``Boolean`` The value of the `allow_delete`_ option.
382+
allow_add ``boolean`` The value of the `allow_add`_ option.
383+
allow_delete ``boolean`` The value of the `allow_delete`_ option.
384384
============ =========== ========================================

reference/forms/types/entity.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ directly.
183183
choices
184184
~~~~~~~
185185

186-
**type**: array | ``\Traversable`` **default**: ``null``
186+
**type**: ``array`` | ``\Traversable`` **default**: ``null``
187187

188188
Instead of allowing the `class`_ and `query_builder`_ options to fetch the
189189
entities to include for you, you can pass the ``choices`` option directly.

reference/forms/types/options/attr.rst.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
attr
22
~~~~
33

4-
**type**: array **default**: Empty array
4+
**type**: ``array`` **default**: ``array()``
55

66
If you want to add extra attributes to an HTML field representation
77
you can use the ``attr`` option. It's an associative array with HTML attributes

reference/forms/types/options/button_attr.rst.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
attr
22
~~~~
33

4-
**type**: array **default**: Empty array
4+
**type**: ``array`` **default**: ``array()``
55

66
If you want to add extra attributes to the HTML representation of the button,
77
you can use ``attr`` option. It's an associative array with HTML attribute

reference/forms/types/options/by_reference.rst.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
by_reference
22
~~~~~~~~~~~~
33

4-
**type**: ``Boolean`` **default**: ``true``
4+
**type**: ``boolean`` **default**: ``true``
55

66
In most cases, if you have a ``name`` field, then you expect ``setName()``
77
to be called on the underlying object. In some cases, however, ``setName()``

reference/forms/types/options/cascade_validation.rst.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
cascade_validation
22
~~~~~~~~~~~~~~~~~~
33

4-
**type**: Boolean **default**: false
4+
**type**: ``boolean`` **default**: ``false``
55

66
Set this option to ``true`` to force validation on embedded form types.
77
For example, if you have a ``ProductType`` with an embedded ``CategoryType``,

reference/forms/types/options/constraints.rst.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
constraints
22
~~~~~~~~~~~
33

4-
**type**: array or :class:`Symfony\\Component\\Validator\\Constraint` **default**: ``null``
4+
**type**: ``array`` or :class:`Symfony\\Component\\Validator\\Constraint` **default**: ``null``
55

66
Allows you to attach one or more validation constraints to a specific field.
77
For more information, see :ref:`Adding Validation<form-option-constraints>`.

reference/forms/types/options/data.rst.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
data
22
~~~~
33

4-
**type**: mixed **default**: Defaults to field of the underlying object (if there is one)
4+
**type**: ``mixed`` **default**: Defaults to field of the underlying object (if there is one)
55

66
When you create a form, each field initially displays the value of the
77
corresponding property of the form's domain object (if an object is bound

reference/forms/types/options/empty_value.rst.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ empty_value
55
Since Symfony 2.3, empty values are also supported if the ``expanded``
66
option is set to true.
77

8-
**type**: ``string`` or ``Boolean``
8+
**type**: ``string`` or ``boolean``
99

1010
This option determines whether or not a special "empty" option (e.g. "Choose an option")
1111
will appear at the top of a select widget. This option only applies if the
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
error_bubbling
22
~~~~~~~~~~~~~~
33

4-
**type**: ``Boolean`` **default**: ``false`` unless the form is ``compound``
4+
**type**: ``boolean`` **default**: ``false`` unless the form is ``compound``
55

66
.. include:: /reference/forms/types/options/_error_bubbling_body.rst.inc
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
expanded
22
~~~~~~~~
33

4-
**type**: ``Boolean`` **default**: ``false``
4+
**type**: ``boolean`` **default**: ``false``
55

66
If set to true, radio buttons or checkboxes will be rendered (depending
77
on the ``multiple`` value). If false, a select element will be rendered.

reference/forms/types/options/multiple.rst.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
multiple
22
~~~~~~~~
33

4-
**type**: ``Boolean`` **default**: ``false``
4+
**type**: ``boolean`` **default**: ``false``
55

66
If true, the user will be able to select multiple options (as opposed
77
to choosing just one option). Depending on the value of the ``expanded``
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
read_only
22
~~~~~~~~~
33

4-
**type**: ``Boolean`` **default**: ``false``
4+
**type**: ``boolean`` **default**: ``false``
55

66
If this option is true, the field will be rendered with the ``readonly``
77
attribute so that the field is not editable.

reference/forms/types/options/required.rst.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
required
22
~~~~~~~~
33

4-
**type**: ``Boolean`` **default**: ``true``
4+
**type**: ``boolean`` **default**: ``true``
55

66
If true, an `HTML5 required attribute`_ will be rendered. The corresponding
77
``label`` will also render with a ``required`` class.

reference/forms/types/options/trim.rst.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
trim
22
~~~~
33

4-
**type**: ``Boolean`` **default**: ``true``
4+
**type**: ``boolean`` **default**: ``true``
55

66
If true, the whitespace of the submitted string value will be stripped
77
via the ``trim()`` function when the data is bound. This guarantees that

0 commit comments

Comments
 (0)