Make FormElements and FormElement generic

phpstan-baseline.neon

@@ -241,7 +241,7 @@ parameters:
 			path: src/Form.php
 
 		-
-			message: "#^Parameter \\#1 \\$attributes of method ipl\\\\Html\\\\Contract\\\\FormElement\\:\\:addAttributes\\(\\) expects iterable, mixed given\\.$#"
+			message: "#^Parameter \\#1 \\$attributes of method ipl\\\\Html\\\\Contract\\\\FormElement\\<mixed\\>\\:\\:addAttributes\\(\\) expects iterable, mixed given\\.$#"
 			count: 1
 			path: src/Form.php
 
@@ -250,21 +250,6 @@ parameters:
 			count: 1
 			path: src/Form.php
 
-		-
-			message: "#^Parameter \\#3 \\$postfix of method ipl\\\\Html\\\\Form\\:\\:addPluginLoader\\(\\) expects string, string\\|null given\\.$#"
-			count: 2
-			path: src/Form.php
-
-		-
-			message: "#^Property ipl\\\\Html\\\\Form\\:\\:\\$defaultElementDecorator \\(ipl\\\\Html\\\\Contract\\\\FormElementDecorator\\|null\\) does not accept ipl\\\\Html\\\\Contract\\\\FormElementDecorator\\|ipl\\\\Html\\\\FormDecorator\\\\DecoratorInterface\\.$#"
-			count: 1
-			path: src/Form.php
-
-		-
-			message: "#^Property ipl\\\\Html\\\\Form\\:\\:\\$submitButton \\(ipl\\\\Html\\\\Contract\\\\FormSubmitElement\\) does not accept null\\.$#"
-			count: 1
-			path: src/Form.php
-
 		-
 			message: "#^Method ipl\\\\Html\\\\FormDecorator\\\\CallbackDecorator\\:\\:assemble\\(\\) has no return type specified\\.$#"
 			count: 1
@@ -326,7 +311,7 @@ parameters:
 			path: src/FormDecorator/DivDecorator.php
 
 		-
-			message: "#^Call to an undefined method ipl\\\\Html\\\\Contract\\\\FormElement\\:\\:ensureAssembled\\(\\)\\.$#"
+			message: "#^Call to an undefined method ipl\\\\Html\\\\Contract\\\\FormElement\\<mixed\\>\\:\\:ensureAssembled\\(\\)\\.$#"
 			count: 1
 			path: src/FormDecorator/DivDecorator.php
 
@@ -362,7 +347,7 @@ parameters:
 
 		-
 			message: "#^Cannot access offset 'name' on mixed\\.$#"
-			count: 2
+			count: 1
 			path: src/FormElement/BaseFormElement.php
 
 		-
@@ -405,6 +390,11 @@ parameters:
 			count: 1
 			path: src/FormElement/BaseFormElement.php
 
+		-
+			message: "#^Parameter \\#1 \\$validators of method ipl\\\\Validator\\\\ValidatorChain\\:\\:addValidators\\(\\) expects Traversable\\<int\\|string, mixed\\>, iterable given\\.$#"
+			count: 2
+			path: src/FormElement/BaseFormElement.php
+
 		-
 			message: "#^Trying to invoke mixed but it's not a callable\\.$#"
 			count: 1
@@ -436,25 +426,10 @@ parameters:
 			path: src/FormElement/FieldsetElement.php
 
 		-
-			message: "#^Parameter \\#1 \\$attributes of method ipl\\\\Html\\\\Contract\\\\FormElement\\:\\:addAttributes\\(\\) expects iterable, mixed given\\.$#"
-			count: 1
-			path: src/FormElement/FieldsetElement.php
-
-		-
-			message: "#^Parameter \\#3 \\$postfix of method ipl\\\\Html\\\\FormElement\\\\FieldsetElement\\:\\:addPluginLoader\\(\\) expects string, string\\|null given\\.$#"
-			count: 2
-			path: src/FormElement/FieldsetElement.php
-
-		-
-			message: "#^Property ipl\\\\Html\\\\FormElement\\\\FieldsetElement\\:\\:\\$defaultElementDecorator \\(ipl\\\\Html\\\\Contract\\\\FormElementDecorator\\|null\\) does not accept ipl\\\\Html\\\\Contract\\\\FormElementDecorator\\|ipl\\\\Html\\\\FormDecorator\\\\DecoratorInterface\\.$#"
+			message: "#^Parameter \\#1 \\$attributes of method ipl\\\\Html\\\\Contract\\\\FormElement\\<mixed\\>\\:\\:addAttributes\\(\\) expects iterable, mixed given\\.$#"
 			count: 1
 			path: src/FormElement/FieldsetElement.php
 
-		-
-			message: "#^Cannot access offset 0 on mixed\\.$#"
-			count: 1
-			path: src/FormElement/FileElement.php
-
 		-
 			message: "#^Method ipl\\\\Html\\\\FormElement\\\\FileElement\\:\\:assemble\\(\\) has no return type specified\\.$#"
 			count: 1
@@ -530,16 +505,6 @@ parameters:
 			count: 1
 			path: src/FormElement/SelectElement.php
 
-		-
-			message: "#^Method ipl\\\\Html\\\\FormElement\\\\SelectElement\\:\\:getValue\\(\\) return type has no value type specified in iterable type array\\.$#"
-			count: 1
-			path: src/FormElement/SelectElement.php
-
-		-
-			message: "#^Method ipl\\\\Html\\\\FormElement\\\\SelectElement\\:\\:getValue\\(\\) should return array\\|string\\|null but returns mixed\\.$#"
-			count: 2
-			path: src/FormElement/SelectElement.php
-
 		-
 			message: "#^Method ipl\\\\Html\\\\FormElement\\\\SelectElement\\:\\:makeOption\\(\\) has parameter \\$label with no value type specified in iterable type array\\.$#"
 			count: 1
@@ -565,11 +530,6 @@ parameters:
 			count: 1
 			path: src/FormElement/SelectElement.php
 
-		-
-			message: "#^Property ipl\\\\Html\\\\FormElement\\\\SelectElement\\:\\:\\$value type has no value type specified in iterable type array\\.$#"
-			count: 1
-			path: src/FormElement/SelectElement.php
-
 		-
 			message: "#^Method ipl\\\\Html\\\\FormElement\\\\SelectOption\\:\\:assemble\\(\\) has no return type specified\\.$#"
 			count: 1

src/Contract/FormElement.php

@@ -7,6 +7,8 @@
 
 /**
  * Representation of form elements
+ *
+ * @template TValue of mixed
  */
 interface FormElement extends Wrappable
 {
@@ -67,20 +69,22 @@ public function getName();
      * Get whether the element has a value
      *
      * @return bool False if the element's value is null, the empty string or the empty array; true otherwise
+     *
+     * @phpstan-assert-if-false null|''|array{} $this->getValue()
      */
     public function hasValue();
 
     /**
      * Get the value of the element
      *
-     * @return mixed
+     * @return ?TValue
      */
     public function getValue();
 
     /**
      * Set the value of the element
      *
-     * @param mixed $value
+     * @param ?TValue $value
      *
      * @return $this
      */
@@ -124,7 +128,7 @@ public function validate();
     /**
      * Handler which is called after this element has been registered
      *
-     * @param Form $form
+     * @param Form<array<string, FormElement<mixed>>> $form
      *
      * @return void
      */

src/Contract/FormElementDecorator.php

@@ -34,7 +34,7 @@ interface FormElementDecorator extends ValidHtml
      * }
      * ```
      *
-     * @param FormElement $formElement
+     * @param FormElement<mixed> $formElement
      */
     public function decorate(FormElement $formElement);
 }

src/Contract/FormSubmitElement.php

@@ -2,6 +2,7 @@
 
 namespace ipl\Html\Contract;
 
+/** @extends FormElement<string> */
 interface FormSubmitElement extends FormElement
 {
     /**

src/Contract/ValueCandidates.php

@@ -2,19 +2,20 @@
 
 namespace ipl\Html\Contract;
 
+/** @template TValue of mixed */
 interface ValueCandidates
 {
     /**
      * Get value candidates of this element
      *
-     * @return array<int, mixed>
+     * @return array<int, TValue>
      */
     public function getValueCandidates();
 
     /**
      * Set value candidates of this element
      *
-     * @param array<int, mixed> $values
+     * @param array<int, TValue> $values
      *
      * @return $this
      */

src/Form.php

@@ -9,8 +9,10 @@
 use ipl\Stdlib\Messages;
 use Psr\Http\Message\ServerRequestInterface;
 
+/** @template TFormElements of array<string, FormElement<mixed>> */
 class Form extends BaseHtmlElement
 {
+    /** @use FormElements<TFormElements> */
     use FormElements {
         FormElements::remove as private removeElement;
     }
@@ -29,7 +31,7 @@ class Form extends BaseHtmlElement
     /** @var string HTTP method to submit the form with */
     protected $method = 'POST';
 
-    /** @var FormSubmitElement Primary submit button */
+    /** @var ?FormSubmitElement Primary submit button */
     protected $submitButton;
 
     /** @var FormSubmitElement[] Other elements that may submit the form */
@@ -380,6 +382,7 @@ protected function onSuccess()
         // $this->redirectOnSuccess();
     }
 
+    /** @param value-of<TFormElements> $element */
     protected function onElementRegistered(FormElement $element)
     {
         if ($element instanceof FormSubmitElement) {

src/FormDecorator/CallbackDecorator.php

@@ -12,7 +12,7 @@ class CallbackDecorator extends HtmlDocument implements FormElementDecorator
     /** @var Closure The decorating callback */
     protected $callback;
 
-    /** @var FormElement The decorated form element */
+    /** @var FormElement<mixed> The decorated form element */
     protected $formElement;
 
     /**

src/FormDecorator/DdDtDecorator.php

@@ -15,13 +15,13 @@ class DdDtDecorator extends BaseHtmlElement implements DecoratorInterface
 
     protected $dd;
 
-    /** @var BaseFormElement */
+    /** @var BaseFormElement<mixed> */
     protected $wrappedElement;
 
     protected $ready = false;
 
     /**
-     * @param BaseFormElement $element
+     * @param BaseFormElement<mixed> $element
      * @return static
      */
     public function decorate(BaseFormElement $element)

src/FormDecorator/DecoratorInterface.php

@@ -11,7 +11,7 @@ interface DecoratorInterface
     /**
      * Set the form element to decorate
      *
-     * @param BaseFormElement $formElement
+     * @param BaseFormElement<mixed> $formElement
      *
      * @return static
      */

src/FormDecorator/DivDecorator.php

@@ -33,7 +33,7 @@ class DivDecorator extends BaseHtmlElement implements FormElementDecorator
     /** @var string CSS class to set on the decorator if the element has errors */
     public const ERROR_HINT_CLASS = 'has-error';
 
-    /** @var FormElement The decorated form element */
+    /** @var FormElement<mixed> The decorated form element */
     protected $formElement;
 
     protected $tag = 'div';

src/FormElement/BaseFormElement.php

@@ -13,6 +13,11 @@
 use ipl\Validator\ValidatorChain;
 use ReflectionProperty;
 
+/**
+ * @template TValue of mixed
+ * @implements FormElement<TValue>
+ * @implements ValueCandidates<TValue>
+ */
 abstract class BaseFormElement extends BaseHtmlElement implements FormElement, ValueCandidates
 {
     use Messages;
@@ -39,10 +44,10 @@ abstract class BaseFormElement extends BaseHtmlElement implements FormElement, V
     /** @var ValidatorChain Registered validators */
     protected $validators;
 
-    /** @var mixed Value of the element */
+    /** @var ?TValue Value of the element */
     protected $value;
 
-    /** @var array<int, mixed> Value candidates of the element */
+    /** @var array<int, TValue> Value candidates of the element */
     protected $valueCandidates = [];
 
     /**

src/FormElement/ButtonElement.php

@@ -2,6 +2,7 @@
 
 namespace ipl\Html\FormElement;
 
+/** @extends BaseFormElement<string> */
 class ButtonElement extends BaseFormElement
 {
     protected $tag = 'button';

src/FormElement/CheckboxElement.php

@@ -4,6 +4,7 @@
 
 use ipl\Html\Attributes;
 
+/** @extends InputElement<string> */
 class CheckboxElement extends InputElement
 {
     /** @var bool Whether the checkbox is checked */

src/FormElement/ColorElement.php

@@ -5,6 +5,7 @@
 use ipl\Validator\HexColorValidator;
 use ipl\Validator\ValidatorChain;
 
+/** @extends InputElement<string> */
 class ColorElement extends InputElement
 {
     protected $type = 'color';

src/FormElement/DateElement.php

@@ -2,6 +2,7 @@
 
 namespace ipl\Html\FormElement;
 
+/** @extends InputElement<string> */
 class DateElement extends InputElement
 {
     protected $type = 'date';

src/FormElement/FieldsetElement.php

@@ -10,8 +10,13 @@
 
 use function ipl\Stdlib\get_php_type;
 
+/**
+ * @template TElements of array<string, FormElement<mixed>>
+ * @extends BaseFormElement<mixed>
+ */
 class FieldsetElement extends BaseFormElement
 {
+    /** @use FormElements<TElements> */
     use FormElements {
         FormElements::getValue as private getElementValue;
     }
@@ -104,6 +109,7 @@ public function setWrapper(Wrappable $wrapper)
         return parent::setWrapper($wrapper);
     }
 
+    /** @param value-of<TElements> $element */
     protected function onElementRegistered(FormElement $element)
     {
         $element->getAttributes()->registerAttributeCallback('name', function () use ($element) {

src/FormElement/FileElement.php

@@ -22,6 +22,8 @@
  *
  * Once the file element is added to the form and the form attribute `enctype` is not set,
  * it is automatically set to `multipart/form-data`.
+ *
+ * @extends InputElement<UploadedFileInterface|array<UploadedFileInterface>>
  */
 class FileElement extends InputElement
 {
@@ -30,9 +32,6 @@ class FileElement extends InputElement
 
     protected $type = 'file';
 
-    /** @var UploadedFileInterface|UploadedFileInterface[] */
-    protected $value;
-
     /** @var UploadedFileInterface[] Files that are stored on disk */
     protected $files = [];
 
@@ -120,7 +119,7 @@ public function setValue($value)
     {
         if (! empty($value)) {
             $fileToTest = $value;
-            if ($this->isMultiple()) {
+            if ($this->isMultiple() && is_array($value)) {
                 $fileToTest = $value[0];
             }
 
@@ -135,7 +134,7 @@ public function setValue($value)
                 $value = null;
             } else {
                 $files = $value;
-                if (! $this->isMultiple()) {
+                if (! $this->isMultiple() || ! is_array($files)) {
                     $files = [$files];
                 }