False positive with Symfony Forms

[aturki]

Hello all,

I get a "Call to an undefined method Symfony\Component\Form\FormInterface::getClickedButton()." error when working with Symfony Forms using the following code (within a Symfony Controller class):

$form = $this->createForm(...); $clickedButton = $form->getClickedButton();

The second line will raise the error since the createForm method returns a FormInterface

[lookyman]

FIxed in 1b66d8e

[lookyman]

Actually it wasn't, I completely screwed that up. @aturki can you show me what parameters (especially the first one) are you calling createForm with, your FormType class, and anything else you feel I could need? Thanks.

[aturki]

Hi @lookyman, createForm is called as:
$this->createFormat(DocumentType::class, $entity, $parameters);

Note the DocumentType is a subclass of the Symfony standard Symfony\Component\Form\AbstractType

Let me know if you need extra infos ;)

[althaus]

I think it's no false positive, but something ugly in the Form component:

The FormInterface returned by the builder does not include the getClickedButton() method which is part of the Form class. So phpstan would have to inspect the returned form object.

[ThomasLandauer]

I opened a ticket for this at Symfony, see symfony/symfony#35277

[ThomasLandauer]

For now, the solution is to add a PHPDoc - see symfony/symfony#35277 (comment) :

use Symfony\Component\Form\Form;

/** @var Form $form */
$button = $form->getClickedButton();

[thePanz]

@ThomasLandauer note that with PHPStan v2.x we now get the following warning when using the suggested fix:

/** @var Form $form */
$button = $form->getClickedButton();

Error:

PHPDoc tag @var with type Symfony\Component\Form\Form is not subtype of native type Symfony\Component\Form\FormInterface

[kristoftorfs]

@thePanz I resolved this by adding an assertion:

assert($form instanceof Form);