minor #18585 [Form] Improve form type methods explanation (HeahDude)

javiereguiluz · javiereguiluz · commit 21f2d8fdbe25 · 2023-07-20T12:45:24.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- [Form] Improve form type methods explanation I propose to keep methods ordered the same way they are used by the component: - `getParent()`: a type is first configured by its parent and its parent extensions - `configureOptions()`: a type defines what options are available - `buildForm()`: a type configures the current form and its fields based on defined options - `buildView()`: a type configures its view based on the built form and defined options - `finishView()`: a type configures its child views based on the built form, built view and defined options Commits ------- aeee305 [Form] Improve form type methods explanation
diff --git a/form/create_custom_field_type.rst b/form/create_custom_field_type.rst
@@ -116,25 +116,6 @@ These are the most important methods that a form type class can define:
 
 .. _form-type-methods-explanation:
 
-``buildForm()``
-    It adds and configures other types into this type. It's the same method used
-    when :ref:`creating Symfony form classes <creating-forms-in-classes>`.
-
-``buildView()``
-    It sets any extra variables you'll need when rendering the field in a template.
-
-``finishView()``
-    This method allows to modify the "view" of any rendered widget. This is useful
-    if your form type consists of many fields, or contains a type that produces
-    many HTML elements (e.g. ``ChoiceType``). For any other use case, it's
-    recommended to use ``buildView()`` instead.
-
-``configureOptions()``
-    It defines the options configurable when using the form type, which are also
-    the options that can be used in ``buildForm()`` and ``buildView()``
-    methods. Options are inherited from parent types and parent type
-    extensions, but you can create any custom option you need.
-
 ``getParent()``
     If your custom type is based on another type (i.e. they share some
     functionality), add this method to return the fully-qualified class name
@@ -149,6 +130,28 @@ These are the most important methods that a form type class can define:
     :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\FormType`
     type, which is the root parent for all form types in the Form component.
 
+``configureOptions()``
+    It defines the options configurable when using the form type, which are also
+    the options that can be used in the following methods. Options are inherited
+    from parent types and parent type extensions, but you can create any custom
+    option you need.
+
+``buildForm()``
+    It configures the current form and may add nested fields. It's the same
+    method used when
+    :ref:`creating Symfony form classes <creating-forms-in-classes>`.
+
+``buildView()``
+    It sets any extra variables you'll need when rendering the field in a form
+    theme template.
+
+``finishView()``
+    Same as ``buildView()``. This is useful only if your form type consists of
+    many fields (i.e. A ``ChoiceType`` composed of many radio or checkboxes),
+    as this method will allow accessing child views with
+    ``$view['child_name']``. For any other use case, it's recommended to use
+    ``buildView()`` instead.
+
 Defining the Form Type
 ~~~~~~~~~~~~~~~~~~~~~~
 
