Improve type inference for element attributes

Marks all attribute arrays and iterables as `<string, scalar|null>`

Signed-off-by: George Steel <george@net-glue.co.uk>

src/Element.php

@@ -17,19 +17,19 @@ class Element implements
     InitializableInterface,
     LabelAwareInterface
 {
-    /** @var array  */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [];
 
     /** @var null|string */
     protected $label;
 
-    /** @var array */
+    /** @var array<string, scalar|null> */
     protected $labelAttributes = [];
 
     /**
      * Label specific options
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $labelOptions = [];
 
@@ -158,12 +158,7 @@ public function setOption(string $key, $value)
         return $this;
     }
 
-    /**
-     * Set a single element attribute
-     *
-     * @param  mixed  $value
-     * @return $this
-     */
+    /** @inheritDoc */
     public function setAttribute(string $key, $value)
     {
         // Do not include the value in the list of attributes
@@ -175,11 +170,7 @@ public function setAttribute(string $key, $value)
         return $this;
     }
 
-    /**
-     * Retrieve a single element attribute
-     *
-     * @return mixed|null
-     */
+    /** @inheritDoc */
     public function getAttribute(string $key)
     {
         if (! isset($this->attributes[$key])) {
@@ -209,11 +200,7 @@ public function hasAttribute(string $key): bool
     }
 
     /**
-     * Set many attributes at once
-     *
-     * Implementation will decide if this will overwrite or merge.
-     *
-     * @return $this
+     * @inheritDoc
      * @throws Exception\InvalidArgumentException
      */
     public function setAttributes(iterable $arrayOrTraversable)
@@ -224,9 +211,7 @@ public function setAttributes(iterable $arrayOrTraversable)
         return $this;
     }
 
-    /**
-     * Retrieve all attributes at once
-     */
+    /** @inheritDoc */
     public function getAttributes(): array
     {
         return $this->attributes;
@@ -235,7 +220,7 @@ public function getAttributes(): array
     /**
      * Remove many attributes at once
      *
-     * @param array $keys
+     * @param list<string> $keys
      * @return $this
      */
     public function removeAttributes(array $keys)
@@ -307,7 +292,7 @@ public function getLabel(): ?string
     /**
      * Set the attributes to use with the label
      *
-     * @param array $labelAttributes
+     * @param array<string, mixed> $labelAttributes
      * @return $this
      */
     public function setLabelAttributes(array $labelAttributes)
@@ -319,7 +304,7 @@ public function setLabelAttributes(array $labelAttributes)
     /**
      * Get the attributes to use with the label
      *
-     * @return array
+     * @return array<string, mixed>
      */
     public function getLabelAttributes(): array
     {

src/Element/Button.php

@@ -8,11 +8,7 @@
 
 class Button extends Element
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'button',
     ];

src/Element/Checkbox.php

@@ -11,11 +11,7 @@
 
 class Checkbox extends Element implements InputProviderInterface
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'checkbox',
     ];

src/Element/Color.php

@@ -13,11 +13,7 @@
 
 class Color extends Element implements InputProviderInterface
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'color',
     ];

src/Element/Csrf.php

@@ -16,11 +16,7 @@
 
 class Csrf extends Element implements InputProviderInterface, ElementPrepareAwareInterface
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'hidden',
     ];
@@ -103,6 +99,8 @@ public function getValue(): string
      * Override: get attributes
      *
      * Seeds 'value' attribute with validator hash
+     *
+     * @inheritDoc
      */
     public function getAttributes(): array
     {

src/Element/Date.php

@@ -14,11 +14,7 @@
 
 class Date extends DateTimeElement
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'date',
     ];

src/Element/DateTime.php

@@ -11,11 +11,7 @@
  */
 class DateTime extends AbstractDateTime
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'datetime',
     ];

src/Element/DateTimeLocal.php

@@ -10,11 +10,7 @@
 
 class DateTimeLocal extends AbstractDateTime
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'datetime-local',
     ];

src/Element/Email.php

@@ -13,11 +13,7 @@
 
 class Email extends Element implements InputProviderInterface
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'email',
     ];

src/Element/File.php

@@ -12,11 +12,7 @@
 
 class File extends Element implements InputProviderInterface, ElementPrepareAwareInterface
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'file',
     ];

src/Element/Hidden.php

@@ -8,11 +8,7 @@
 
 class Hidden extends Element
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'hidden',
     ];

src/Element/Image.php

@@ -8,11 +8,7 @@
 
 class Image extends Element
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'image',
     ];

src/Element/Month.php

@@ -18,11 +18,7 @@ class Month extends AbstractDateTime
      */
     protected $format = '!Y-m';
 
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'month',
     ];

src/Element/MultiCheckbox.php

@@ -14,11 +14,7 @@
 
 class MultiCheckbox extends Checkbox
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'multi_checkbox',
     ];
@@ -99,12 +95,7 @@ public function setOptions(iterable $options)
         return $this;
     }
 
-    /**
-     * Set a single element attribute
-     *
-     * @param  mixed  $value
-     * @return $this
-     */
+    /** @inheritDoc */
     public function setAttribute(string $key, $value)
     {
         // Do not include the options in the list of attributes

src/Element/Number.php

@@ -15,11 +15,7 @@
 
 class Number extends Element implements InputProviderInterface
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'number',
     ];

src/Element/Password.php

@@ -10,11 +10,7 @@
 
 class Password extends Element implements ElementPrepareAwareInterface
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'password',
     ];

src/Element/Radio.php

@@ -9,11 +9,7 @@
 
 class Radio extends MultiCheckbox
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'radio',
     ];

src/Element/Range.php

@@ -13,11 +13,7 @@
 
 class Range extends NumberElement
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'range',
     ];

src/Element/Search.php

@@ -8,11 +8,7 @@
 
 class Search extends Element
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'search',
     ];

src/Element/Select.php

@@ -16,11 +16,7 @@
 
 class Select extends Element implements InputProviderInterface
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'select',
     ];
@@ -134,12 +130,7 @@ public function setOptions(iterable $options)
         return $this;
     }
 
-    /**
-     * Set a single element attribute
-     *
-     * @param  mixed  $value
-     * @return $this
-     */
+    /** @inheritDoc */
     public function setAttribute(string $key, $value)
     {
         // Do not include the options in the list of attributes

src/Element/Submit.php

@@ -8,11 +8,7 @@
 
 class Submit extends Element
 {
-    /**
-     * Seed attributes
-     *
-     * @var array
-     */
+    /** @var array<string, scalar|null>  */
     protected $attributes = [
         'type' => 'submit',
     ];