feat: stub DataMapperInterface #418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Open

roerbakei wants to merge 3 commits into phpstan:2.0.x

from roerbakei:stub/data-mapper-interface

Open

feat: stub DataMapperInterface #418

roerbakei wants to merge 3 commits into phpstan:2.0.x from roerbakei:stub/data-mapper-interface

Conversation

@roerbakei

Copy link

@roerbakei roerbakei commented Dec 4, 2024

Ensure TData of FormInterface is provided.
Set TData on mixed since we don't know the type of the child forms.
Add template for DataMapperInterface.

I've set TData of FormInterface to mixed since each child form can have a different type.

refs: #417

wietse added 3 commits

December 4, 2024 11:53


 feat: stub DataMapperInterface

12ff984

Ensure TData of FormInterface is provided
Set TData on mixed since we don't know the type of the child forms
Add template for in DataMapperInterface
refs: phpstan#417


 fix: incorrect file extension for stub file

632853f

refs: phpstan#417


 feat: define param out type for passed by reference

9f1c406

refs: phpstan#417

JefvdA

JefvdA reviewed

Jan 7, 2025

View reviewed changes

stubs/Symfony/Component/Form/DataMapperInterface.stub

Comment on lines +11 to +21

* @param TViewData $viewData

* @param \Traversable<mixed, FormInterface<mixed>> $forms

public function mapDataToForms(mixed $viewData, \Traversable $forms): void;

/**

* @param \Traversable<mixed, FormInterface<mixed>> $forms

* @param TViewData $viewData

* @param-out TViewData $viewData

public function mapFormsToData(\Traversable $forms, mixed &$viewData): void;

Copy link

@JefvdA JefvdA Jan 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As it's stated in the docs ( https://symfony.com/doc/current/form/data_mappers.html#creating-a-data-mapper ), the following logic is needed:

// there is no data yet, so nothing to prepopulate
if (null === $viewData) {
 return;
}

This, as it seems that mapDataToForms is called before the data is avaialble. Which will mean that $viewData will be null at that time.

Thus I propose the following change:

Suggested change

* @param TViewData $viewData

* @param \Traversable<mixed, FormInterface<mixed>> $forms

public function mapDataToForms(mixed $viewData, \Traversable $forms): void;

/**

* @param \Traversable<mixed, FormInterface<mixed>> $forms

* @param TViewData $viewData

* @param-out TViewData $viewData

public function mapFormsToData(\Traversable $forms, mixed &$viewData): void;

* @param TViewData|null $viewData

* @param \Traversable<mixed, FormInterface<mixed>> $forms

public function mapDataToForms(mixed $viewData, \Traversable $forms): void;

/**

* @param \Traversable<mixed, FormInterface<mixed>> $forms

* @param TViewData|null $viewData

* @param-out TViewData $viewData

public function mapFormsToData(\Traversable $forms, mixed &$viewData): void;

For example, the stub file for the FormTypeInterface also has a generic type, but also has it defined nullable when it's being passed to it's buildForm method.