Skip to content

Commit 7c21546

Browse files
VincentLangletVincentLanglet
committed
Add stub for form options
1 parent 1ef4dce commit 7c21546

File tree

8 files changed

+161
-19
lines changed

8 files changed

+161
-19
lines changed

‎stubs/Symfony/Bundle/FrameworkBundle/Controller/AbstractController.stub

+3-2
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,13 @@ use Symfony\Contracts\Service\ServiceSubscriberInterface;
99
abstract class AbstractController implements ServiceSubscriberInterface
1010
{
1111
/**
12-
* @template TFormType of FormTypeInterface<TData>
12+
* @template TFormType of FormTypeInterface<TData, TOptions>
1313
* @template TData
14+
* @template TOptions
1415
*
1516
* @param class-string<TFormType> $type
1617
* @param TData $data
17-
* @param array<string, mixed> $options
18+
* @param TOptions $options
1819
*
1920
* @phpstan-return ($data is null ? FormInterface<null|TData> : FormInterface<TData>)
2021
*/

‎stubs/Symfony/Component/Form/AbstractType.stub

+5-4
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,28 @@ namespace Symfony\Component\Form;
44

55
/**
66
* @template TData
7+
* @template TOptions of array<string, mixed>
78
*
8-
* @implements FormTypeInterface<TData>
9+
* @implements FormTypeInterface<TData, TOptions>
910
*/
1011
abstract class AbstractType implements FormTypeInterface
1112
{
1213

1314
/**
1415
* @param FormBuilderInterface<TData|null> $builder
15-
* @param array<string, mixed> $options
16+
* @param TOptions $options
1617
*/
1718
public function buildForm(FormBuilderInterface $builder, array $options): void;
1819

1920
/**
2021
* @param FormInterface<TData> $form
21-
* @param array<string, mixed> $options
22+
* @param TOptions $options
2223
*/
2324
public function buildView(FormView $view, FormInterface $form, array $options): void;
2425

2526
/**
2627
* @param FormInterface<TData> $form
27-
* @param array<string, mixed> $options
28+
* @param TOptions $options
2829
*/
2930
public function finishView(FormView $view, FormInterface $form, array $options): void;
3031

‎stubs/Symfony/Component/Form/FormFactoryInterface.stub

+7-5
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,13 @@ use Symfony\Component\Form\Extension\Core\Type\FormType;
77
interface FormFactoryInterface
88
{
99
/**
10-
* @template TFormType of FormTypeInterface<TData>
10+
* @template TFormType of FormTypeInterface<TData, TOptions>
1111
* @template TData
12+
* @template TOptions
1213
*
1314
* @param class-string<TFormType> $type
1415
* @param TData $data
15-
* @param array<string, mixed> $options
16+
* @param TOptions $options
1617
*
1718
* @phpstan-return ($data is null ? FormInterface<null|TData> : FormInterface<TData>)
1819
*
@@ -21,12 +22,13 @@ interface FormFactoryInterface
2122
public function create(string $type = FormType::class, $data = null, array $options = []): FormInterface;
2223

2324
/**
24-
* @template TFormType of FormTypeInterface<TData>
25+
* @template TFormType of FormTypeInterface<TData, TOptions>
2526
* @template TData
27+
* @template TOptions
2628
*
27-
* @param class-string<TFormType> $type
29+
* @param class-string<TFormType> $type
2830
* @param TData $data
29-
* @param array<string, mixed> $options
31+
* @param TOptions $options
3032
*
3133
* @phpstan-return ($data is null ? FormInterface<null|TData> : FormInterface<TData>)
3234
*

‎stubs/Symfony/Component/Form/FormTypeExtensionInterface.stub

+6-5
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,25 @@ namespace Symfony\Component\Form;
44

55
/**
66
* @template TData
7+
* @template TOptions of array<string, mixed>
78
*/
89
interface FormTypeExtensionInterface
910
{
1011
/**
1112
* @param FormBuilderInterface<TData|null> $builder
12-
* @param array<string, mixed> $options
13+
* @param TOptions $options
1314
*/
1415
public function buildForm(FormBuilderInterface $builder, array $options): void;
1516

1617
/**
17-
* @phpstan-param FormInterface<TData> $form
18-
* @param array<string, mixed> $options
18+
* @param FormInterface<TData> $form
19+
* @param TOptions $options
1920
*/
2021
public function buildView(FormView $view, FormInterface $form, array $options): void;
2122

2223
/**
23-
* @phpstan-param FormInterface<TData> $form
24-
* @param array<string, mixed> $options
24+
* @param FormInterface<TData> $form
25+
* @param TOptions $options
2526
*/
2627
public function finishView(FormView $view, FormInterface $form, array $options): void;
2728
}

‎stubs/Symfony/Component/Form/FormTypeInterface.stub

+4-3
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,25 @@ namespace Symfony\Component\Form;
44

55
/**
66
* @template TData
7+
* @template TOptions of array<string, mixed>
78
*/
89
interface FormTypeInterface
910
{
1011
/**
1112
* @param FormBuilderInterface<TData|null> $builder
12-
* @param array<string, mixed> $options
13+
* @param TOptions $options
1314
*/
1415
public function buildForm(FormBuilderInterface $builder, array $options): void;
1516

1617
/**
1718
* @param FormInterface<TData> $form
18-
* @param array<string, mixed> $options
19+
* @param TOptions $options
1920
*/
2021
public function buildView(FormView $view, FormInterface $form, array $options): void;
2122

2223
/**
2324
* @param FormInterface<TData> $form
24-
* @param array<string, mixed> $options
25+
* @param TOptions $options
2526
*/
2627
public function finishView(FormView $view, FormInterface $form, array $options): void;
2728
}

‎tests/Type/Symfony/CallMethodsRuleTest.php

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace Type\Symfony;
4+
5+
use PHPStan\Rules\Methods\CallMethodsRule;
6+
use PHPStan\Rules\Rule;
7+
use PHPStan\Testing\RuleTestCase;
8+
9+
/**
10+
* @extends RuleTestCase<CallMethodsRule>
11+
*/
12+
class CallMethodsRuleTest extends RuleTestCase
13+
{
14+
15+
protected function getRule(): Rule
16+
{
17+
return self::getContainer()->getByType(CallMethodsRule::class);
18+
}
19+
20+
public function testExtension(): void
21+
{
22+
$this->analyse([__DIR__ . '/data/form_options.php'], []);
23+
}
24+
25+
public static function getAdditionalConfigFiles(): array
26+
{
27+
return [
28+
__DIR__ . '/../../../extension.neon',
29+
__DIR__ . '/../../../vendor/phpstan/phpstan-strict-rules/rules.neon',
30+
];
31+
}
32+
33+
}

‎tests/Type/Symfony/ExtensionTest.php

+1
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ public function dataFileAsserts(): iterable
5858
yield from $this->gatherAssertTypes(__DIR__ . '/data/FormInterface_getErrors.php');
5959
yield from $this->gatherAssertTypes(__DIR__ . '/data/cache.php');
6060
yield from $this->gatherAssertTypes(__DIR__ . '/data/form_data_type.php');
61+
yield from $this->gatherAssertTypes(__DIR__ . '/data/form_options.php');
6162

6263
yield from $this->gatherAssertTypes(__DIR__ . '/data/extension/with-configuration/WithConfigurationExtension.php');
6364
yield from $this->gatherAssertTypes(__DIR__ . '/data/extension/without-configuration/WithoutConfigurationExtension.php');

‎tests/Type/Symfony/data/form_options.php

+102
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace GenericFormOptionsType;
4+
5+
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
6+
use Symfony\Component\Form\AbstractType;
7+
use Symfony\Component\Form\Extension\Core\Type\NumberType;
8+
use Symfony\Component\Form\Extension\Core\Type\TextType;
9+
use Symfony\Component\Form\FormBuilderInterface;
10+
use Symfony\Component\Form\FormFactoryInterface;
11+
use Symfony\Component\OptionsResolver\OptionsResolver;
12+
use function PHPStan\Testing\assertType;
13+
14+
class DataClass
15+
{
16+
}
17+
18+
/**
19+
* @extends AbstractType<DataClass, array{required: string, optional: int}>
20+
*/
21+
class DataClassType extends AbstractType
22+
{
23+
24+
public function buildForm(FormBuilderInterface $builder, array $options): void
25+
{
26+
assertType('string', $options['required']);
27+
assertType('int', $options['optional']);
28+
29+
$builder
30+
->add('foo', NumberType::class)
31+
->add('bar', TextType::class)
32+
;
33+
}
34+
35+
public function configureOptions(OptionsResolver $resolver): void
36+
{
37+
$resolver
38+
->setDefaults([
39+
'data_class' => DataClass::class,
40+
'optional' => 0,
41+
])
42+
->setRequired('required')
43+
->setAllowedTypes('required', 'string')
44+
->setAllowedTypes('optional', 'int')
45+
;
46+
}
47+
48+
}
49+
50+
class FormFactoryAwareClass
51+
{
52+
53+
/** @var FormFactoryInterface */
54+
private $formFactory;
55+
56+
public function __construct(FormFactoryInterface $formFactory)
57+
{
58+
$this->formFactory = $formFactory;
59+
}
60+
61+
public function doSomething(): void
62+
{
63+
$form = $this->formFactory->create(DataClassType::class, new DataClass());
64+
assertType('Symfony\Component\Form\FormInterface<GenericFormOptionsType\DataClass>', $form);
65+
}
66+
67+
public function doSomethingWithOption(): void
68+
{
69+
$form = $this->formFactory->create(DataClassType::class, new DataClass(), ['required' => 'foo']);
70+
assertType('Symfony\Component\Form\FormInterface<GenericFormOptionsType\DataClass>', $form);
71+
}
72+
73+
public function doSomethingWithInvalidOption(): void
74+
{
75+
$form = $this->formFactory->create(DataClassType::class, new DataClass(), ['required' => 42]);
76+
assertType('Symfony\Component\Form\FormInterface<GenericFormOptionsType\DataClass>', $form);
77+
}
78+
79+
}
80+
81+
class FormController extends AbstractController
82+
{
83+
84+
public function doSomething(): void
85+
{
86+
$form = $this->createForm(DataClassType::class, new DataClass());
87+
assertType('Symfony\Component\Form\FormInterface<GenericFormOptionsType\DataClass>', $form);
88+
}
89+
90+
public function doSomethingWithOption(): void
91+
{
92+
$form = $this->createForm(DataClassType::class, new DataClass(), ['required' => 'foo']);
93+
assertType('Symfony\Component\Form\FormInterface<GenericFormOptionsType\DataClass>', $form);
94+
}
95+
96+
public function doSomethingWithInvalidOption(): void
97+
{
98+
$form = $this->createForm(DataClassType::class, new DataClass(), ['required' => 42]);
99+
assertType('Symfony\Component\Form\FormInterface<GenericFormOptionsType\DataClass>', $form);
100+
}
101+
102+
}

0 commit comments

Comments
 (0)