[Form] Added explicit `getParent()` call in types inheritance mechanism #13488

HeahDude · 2020-04-04T16:11:53Z

No description provided.

form/create_custom_field_type.rst

HeahDude · 2020-04-05T19:42:05Z

Thanks for the review, I've addressed everything.

wouterj

The only thing I'm not sure if I'm really missing is that you must have FormType or any of its children as parent. I think it's sort of "unnecessary" information, but I also can see someone creating a type that has a completely weird parent (does the code catch this nicely, e.g. if I return stdClass there?)

HeahDude · 2020-04-05T22:15:33Z

The only thing I'm not sure if I'm really missing is that you must have FormType or any of its children as parent. I think it's sort of "unnecessary" information

Basically, when creating child types, the intention should be one of the following:

extend the FormType
extend the ButtonType
extend any type (built-in or custom)

The AbstractType makes the first option the default.

but I also can see someone creating a type that has a completely weird parent (does the code catch this nicely, e.g. if I return stdClass there?)

Yes, getParent expected a class name implementing FormTypeInterface and is checked against circular reference.

HeahDude · 2020-04-05T22:25:42Z

I've edited my comment as I mixup up with type extensions.

HeahDude · 2020-04-05T22:29:54Z

Th fourth option would be to implement the FormTypeInterface directly (enforcing implementing getBlockPrefix and empty getParent), and without even extending the abstract BaseType (with extends as done by FormType and ButtonType), that would make the type unable to use default options and configuration.

Maybe we should remove that sentence and add a clear note to explain all that. WDYT?

javiereguiluz · 2020-04-06T11:00:16Z

form/create_custom_field_type.rst


 .. _form-type-methods-explanation:

+``getParent()``


This description focuses on "what/how" instead of "when/why". It explains that this is "like PHP inheritance but implemented in PHP, because you can't use real PHP inheritance".

But I'm missing information about the "why" and "when" to use this:

Is it mandatory to define this method?

Which value should return this method? (the FQCN of a class implementing FormType??)

How should I use this? (e.g. if you create a form type similar to an existing one, extend from it ... otherwise, extend from the generic FormType ??)

I've pushed a rewording.

xabbuh · 2020-04-19T19:01:56Z

form/create_custom_field_type.rst


 .. _form-type-methods-explanation:

+``getParent()``
+    This return the class name of the type configuring the form before. It


I am not really sure if I completely understand what the meaning of the "the form before" part is supposed to be.

xabbuh · 2020-04-19T19:03:09Z

form/create_custom_field_type.rst

+    means all the other methods below will be called with this parent type
+    and all its type extensions before calling the ones defined in your
+    custom type.
+    By default, all classes inherit the ``AbstractType::getParent()`` which


"[...] all classes extend the AbstractType class [...]" or "[...] all classes inherit the AbstractType::getParent() method [...]"?

xabbuh · 2020-04-19T19:04:02Z

form/create_custom_field_type.rst

+    and all its type extensions before calling the ones defined in your
+    custom type.
+    By default, all classes inherit the ``AbstractType::getParent()`` which
+    defines the ``FormType`` as parent type to re-use its options and


[...] as the parent type [...]

xabbuh · 2020-04-19T19:04:33Z

form/create_custom_field_type.rst

+``configureOptions()``
+    This defines options for your type that
+    can be used in ``buildForm()`` and ``buildView()``. Options are inherited
+    from parent types and parent types extension but you can create any custom


[...] and parent type extensions, but [...]

xabbuh · 2020-04-19T19:05:08Z

form/create_custom_field_type.rst

-    but you can create any others that you need here.
+``finishView``
+    Same as ``buildView`` but to configure the nested field views.
+    This method as no use with types that build compound forms.


This method has no use [...]

This method as no use with types that build compound forms.

By the way, isn't that the other way around?

xabbuh · 2020-04-19T19:05:54Z

form/create_custom_field_type.rst

-    Also, if you need to modify the "view" of any of your child types from
-    your parent type, use the ``finishView()`` method.
+    If you're creating a field that consists of nested fields, then be sure to
+    set the parent type as ``FormType::class`` or one of its child.


[...] or one of its children.

wouterj · 2020-10-21T15:33:45Z

Hi @HeahDude. Do you have any time to finish on this PR?

wouterj · 2020-11-21T14:11:34Z

Closing in favor of #14588

…tance mechanism (HeahDude, wouterj) This PR was merged into the 4.4 branch. Discussion ---------- [Form] Added explicit `getParent()` call in types inheritance mechanism Continues #13488 Most of the original PR was already fixed in a slight rewrite of this article, but I think adding `getParent()` docs is still important. Commits ------- 97c94d7 Updated getParent() description with the why/when (thanks javier!) 68813a0 [Form] Added explicit `getParent()` call in types inheritance mechanism

HeahDude added the Form label Apr 4, 2020

HeahDude added this to the 3.4 milestone Apr 4, 2020

carsonbot added the Status: Needs Review label Apr 4, 2020

HeahDude requested review from wouterj and xabbuh April 4, 2020 23:52

HeahDude force-pushed the form/fix-get_parent branch from 1513ec3 to 526282e Compare April 5, 2020 00:03

xabbuh reviewed Apr 5, 2020

View reviewed changes