Use generics for BaseControl and Control

nepada · Dec 27, 2023 · f90f5eb · f90f5eb
1 parent e5bc24b
commit f90f5eb
Show file tree

Hide file tree

Showing 9 changed files with 49 additions and 15 deletions.
diff --git a/src/FormRenderer/Filters/ValidationClassFilter.php b/src/FormRenderer/Filters/ValidationClassFilter.php
@@ -20,6 +20,10 @@ public function __construct(?string $invalidClass, ?string $validClass)
         $this->validClass = $validClass;
     }
 
+    /**
+     * @template T
+     * @param Nette\Forms\Control<T> $control
+     */
     public function __invoke(Nette\Forms\Control $control): ?string
     {
         if (count($control->getErrors()) > 0) {
@@ -33,6 +37,10 @@ public function __invoke(Nette\Forms\Control $control): ?string
         return null;
     }
 
+    /**
+     * @template T
+     * @param Nette\Forms\Control<T> $control
+     */
     private function isFilled(Nette\Forms\Control $control): bool
     {
         if ($control instanceof Nette\Forms\Controls\TextInput && $control->getControlPrototype()->type === 'password') {

diff --git a/tests/FormRenderer/Bootstrap3RendererTest.phpt b/tests/FormRenderer/Bootstrap3RendererTest.phpt
@@ -85,7 +85,7 @@ class Bootstrap3RendererTest extends TestCase
         $form = $this->createTestForm();
         $form->addError('Form error 1.');
         $form->addError('Form error 2.');
-        /** @var Nette\Forms\Controls\BaseControl $control */
+        /** @var Nette\Forms\Controls\BaseControl<mixed> $control */
         foreach ($form->getControls() as $control) {
             if ($control instanceof Nette\Forms\Controls\Button) {
                 continue;
@@ -106,7 +106,7 @@ class Bootstrap3RendererTest extends TestCase
     public function testRequiredControl(string $mode): void
     {
         $form = $this->createTestForm();
-        /** @var Nette\Forms\Controls\BaseControl $control */
+        /** @var Nette\Forms\Controls\BaseControl<mixed> $control */
         foreach ($form->getControls() as $control) {
             $control->setRequired('REQUIRED');
         }
@@ -123,7 +123,7 @@ class Bootstrap3RendererTest extends TestCase
     public function testControlDescription(string $mode): void
     {
         $form = $this->createTestForm();
-        /** @var Nette\Forms\Controls\BaseControl $control */
+        /** @var Nette\Forms\Controls\BaseControl<mixed> $control */
         foreach ($form->getControls() as $control) {
             $control->setOption('description', "Control {$control->getName()} description.");
         }
@@ -140,7 +140,7 @@ class Bootstrap3RendererTest extends TestCase
     public function testCustomControlId(string $mode): void
     {
         $form = $this->createTestForm();
-        /** @var Nette\Forms\Controls\BaseControl $control */
+        /** @var Nette\Forms\Controls\BaseControl<mixed> $control */
         foreach ($form->getControls() as $control) {
             $control->setOption('id', sprintf('custom-%s', $control->lookupPath()));
         }
@@ -157,7 +157,7 @@ class Bootstrap3RendererTest extends TestCase
     public function testCustomControlClass(string $mode): void
     {
         $form = $this->createTestForm();
-        /** @var Nette\Forms\Controls\BaseControl $control */
+        /** @var Nette\Forms\Controls\BaseControl<mixed> $control */
         foreach ($form->getControls() as $control) {
             $control->setOption('class', sprintf('custom-%s', $control->lookupPath()));
         }

diff --git a/tests/FormRenderer/Bootstrap4RendererTest.phpt b/tests/FormRenderer/Bootstrap4RendererTest.phpt
@@ -100,7 +100,7 @@ class Bootstrap4RendererTest extends TestCase
         $form = $this->createTestForm();
         $form->addError('Form error 1.');
         $form->addError('Form error 2.');
-        /** @var BaseControl $control */
+        /** @var BaseControl<mixed> $control */
         foreach ($form->getControls() as $control) {
             if ($control instanceof Nette\Forms\Controls\Button) {
                 continue;
@@ -126,7 +126,7 @@ class Bootstrap4RendererTest extends TestCase
     public function testRequiredControl(string $mode): void
     {
         $form = $this->createTestForm();
-        /** @var BaseControl $control */
+        /** @var BaseControl<mixed> $control */
         foreach ($form->getControls() as $control) {
             $control->setRequired('REQUIRED');
         }
@@ -143,7 +143,7 @@ class Bootstrap4RendererTest extends TestCase
     public function testControlDescription(string $mode): void
     {
         $form = $this->createTestForm();
-        /** @var BaseControl $control */
+        /** @var BaseControl<mixed> $control */
         foreach ($form->getControls() as $control) {
             $control->setOption('description', "Control {$control->getName()} description.");
         }
@@ -160,7 +160,7 @@ class Bootstrap4RendererTest extends TestCase
     public function testCustomControlId(string $mode): void
     {
         $form = $this->createTestForm();
-        /** @var BaseControl $control */
+        /** @var BaseControl<mixed> $control */
         foreach ($form->getControls() as $control) {
             $control->setOption('id', sprintf('custom-%s', $control->lookupPath()));
         }
@@ -177,7 +177,7 @@ class Bootstrap4RendererTest extends TestCase
     public function testCustomControlClass(string $mode): void
     {
         $form = $this->createTestForm();
-        /** @var BaseControl $control */
+        /** @var BaseControl<mixed> $control */
         foreach ($form->getControls() as $control) {
             $control->setOption('class', sprintf('custom-%s', $control->lookupPath()));
         }

diff --git a/tests/FormRenderer/Filters/Fixtures/CustomControl.php b/tests/FormRenderer/Filters/Fixtures/CustomControl.php
@@ -5,6 +5,9 @@
 
 use Nette;
 
+/**
+ * @implements  Nette\Forms\Control<mixed>
+ */
 class CustomControl implements Nette\Forms\Control
 {
 

diff --git a/tests/FormRenderer/Filters/ValidationClassFilterTest.phpt b/tests/FormRenderer/Filters/ValidationClassFilterTest.phpt
@@ -22,6 +22,8 @@ class ValidationClassFilterTest extends TestCase
 
     /**
      * @dataProvider getFilterData
+     * @template T
+     * @param Control<T> $control
      */
     public function testFilter(string $description, ?string $invalidClass, ?string $validClass, Control $control, ?string $expectedClass): void
     {

diff --git a/tests/FormRenderer/Fixtures/FooControl.php b/tests/FormRenderer/Fixtures/FooControl.php
@@ -4,8 +4,12 @@
 namespace NepadaTests\FormRenderer\Fixtures;
 
 use Nette;
+use Nette\Forms\Controls\BaseControl;
 use Nette\Utils\Html;
 
+/**
+ * @extends BaseControl<mixed>
+ */
 class FooControl extends Nette\Forms\Controls\BaseControl
 {
 

diff --git a/tests/FormRenderer/TemplateRendererTest.phpt b/tests/FormRenderer/TemplateRendererTest.phpt
@@ -62,7 +62,7 @@ class TemplateRendererTest extends TestCase
         $form = $this->testFormFactory->create();
         $form->addError('Form error 1.');
         $form->addError('Form error 2.');
-        /** @var Nette\Forms\Controls\BaseControl $control */
+        /** @var Nette\Forms\Controls\BaseControl<mixed> $control */
         foreach ($form->getControls() as $control) {
             if ($control instanceof Nette\Forms\Controls\Button) {
                 continue;
@@ -80,7 +80,7 @@ class TemplateRendererTest extends TestCase
     public function testRequiredControl(): void
     {
         $form = $this->testFormFactory->create();
-        /** @var Nette\Forms\Controls\BaseControl $control */
+        /** @var Nette\Forms\Controls\BaseControl<mixed> $control */
         foreach ($form->getControls() as $control) {
             $control->setRequired('REQUIRED');
         }
@@ -94,7 +94,7 @@ class TemplateRendererTest extends TestCase
     public function testControlDescription(): void
     {
         $form = $this->testFormFactory->create();
-        /** @var Nette\Forms\Controls\BaseControl $control */
+        /** @var Nette\Forms\Controls\BaseControl<mixed> $control */
         foreach ($form->getControls() as $control) {
             $control->setOption('description', "Control {$control->getName()} description.");
         }
@@ -108,7 +108,7 @@ class TemplateRendererTest extends TestCase
     public function testCustomControlId(): void
     {
         $form = $this->testFormFactory->create();
-        /** @var Nette\Forms\Controls\BaseControl $control */
+        /** @var Nette\Forms\Controls\BaseControl<mixed> $control */
         foreach ($form->getControls() as $control) {
             $control->setOption('id', sprintf('custom-%s', $control->lookupPath()));
         }
@@ -122,7 +122,7 @@ class TemplateRendererTest extends TestCase
     public function testCustomControlClass(): void
     {
         $form = $this->testFormFactory->create();
-        /** @var Nette\Forms\Controls\BaseControl $control */
+        /** @var Nette\Forms\Controls\BaseControl<mixed> $control */
         foreach ($form->getControls() as $control) {
             $control->setOption('class', sprintf('custom-%s', $control->lookupPath()));
         }

diff --git a/tests/PHPStan/conditional.config.php b/tests/PHPStan/conditional.config.php
@@ -1,6 +1,8 @@
 <?php
 declare(strict_types = 1);
 
+use Composer\InstalledVersions;
+use Composer\Semver\VersionParser;
 use Nette\Localization\Translator;
 
 $config = [];
@@ -15,4 +17,10 @@
     ];
 }
 
+if (InstalledVersions::satisfies(new VersionParser(), 'nette/forms', '<3.1.15')) {
+    $config['parameters']['ignoreErrors'][] = [
+        'message' => '~contains generic type Nette\\\\Forms\\\\Control<mixed> but interface Nette\\\\Forms\\\\Control is not generic~',
+    ];
+}
+
 return $config;
diff --git a/tests/PHPStan/conditional.config.tests.php b/tests/PHPStan/conditional.config.tests.php
@@ -15,4 +15,13 @@
     ];
 }
 
+if (InstalledVersions::satisfies(new VersionParser(), 'nette/forms', '<3.1.15')) {
+    $config['parameters']['ignoreErrors'][] = [
+        'message' => '~contains generic type Nette\\\\Forms\\\\Controls\\\\BaseControl<mixed> but class Nette\\\\Forms\\\\Controls\\\\BaseControl is not generic~',
+    ];
+    $config['parameters']['ignoreErrors'][] = [
+        'message' => '~contains generic type Nette\\\\Forms\\\\Control<mixed> but interface Nette\\\\Forms\\\\Control is not generic~',
+    ];
+}
+
 return $config;