Improve type inference for element attributes

Marks all attribute arrays and iterables as `<string, mixed>` which is slightly better than `<array-key, mixed>` Signed-off-by: George Steel <george@net-glue.co.uk>
laminas · Nov 16, 2023 · bf98515 · bf98515
1 parent 943ece1
commit bf98515
Show file tree

Hide file tree

Showing 31 changed files with 40 additions and 34 deletions.
diff --git a/src/Element.php b/src/Element.php
@@ -17,19 +17,19 @@ class Element implements
     InitializableInterface,
     LabelAwareInterface
 {
-    /** @var array  */
+    /** @var array<string, mixed>  */
     protected $attributes = [];
 
     /** @var null|string */
     protected $label;
 
-    /** @var array */
+    /** @var array<string, mixed> */
     protected $labelAttributes = [];
 
     /**
      * Label specific options
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $labelOptions = [];
 
@@ -226,6 +226,8 @@ public function setAttributes(iterable $arrayOrTraversable)
 
     /**
      * Retrieve all attributes at once
+     *
+     * @return array<string, mixed>
      */
     public function getAttributes(): array
     {
@@ -235,7 +237,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 +309,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 +321,7 @@ public function setLabelAttributes(array $labelAttributes)
     /**
      * Get the attributes to use with the label
      *
-     * @return array
+     * @return array<string, mixed>
      */
     public function getLabelAttributes(): array
     {

diff --git a/src/Element/Button.php b/src/Element/Button.php
@@ -11,7 +11,7 @@ class Button extends Element
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'button',

diff --git a/src/Element/Checkbox.php b/src/Element/Checkbox.php
@@ -14,7 +14,7 @@ class Checkbox extends Element implements InputProviderInterface
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'checkbox',

diff --git a/src/Element/Color.php b/src/Element/Color.php
@@ -16,7 +16,7 @@ class Color extends Element implements InputProviderInterface
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'color',

diff --git a/src/Element/Csrf.php b/src/Element/Csrf.php
@@ -19,7 +19,7 @@ class Csrf extends Element implements InputProviderInterface, ElementPrepareAwar
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'hidden',

diff --git a/src/Element/Date.php b/src/Element/Date.php
@@ -17,7 +17,7 @@ class Date extends DateTimeElement
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'date',

diff --git a/src/Element/DateTime.php b/src/Element/DateTime.php
@@ -14,7 +14,7 @@ class DateTime extends AbstractDateTime
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'datetime',

diff --git a/src/Element/DateTimeLocal.php b/src/Element/DateTimeLocal.php
@@ -13,7 +13,7 @@ class DateTimeLocal extends AbstractDateTime
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'datetime-local',

diff --git a/src/Element/Email.php b/src/Element/Email.php
@@ -16,7 +16,7 @@ class Email extends Element implements InputProviderInterface
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'email',

diff --git a/src/Element/File.php b/src/Element/File.php
@@ -15,7 +15,7 @@ class File extends Element implements InputProviderInterface, ElementPrepareAwar
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'file',

diff --git a/src/Element/Hidden.php b/src/Element/Hidden.php
@@ -11,7 +11,7 @@ class Hidden extends Element
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'hidden',

diff --git a/src/Element/Image.php b/src/Element/Image.php
@@ -11,7 +11,7 @@ class Image extends Element
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'image',

diff --git a/src/Element/Month.php b/src/Element/Month.php
@@ -21,7 +21,7 @@ class Month extends AbstractDateTime
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'month',

diff --git a/src/Element/MultiCheckbox.php b/src/Element/MultiCheckbox.php
@@ -17,7 +17,7 @@ class MultiCheckbox extends Checkbox
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'multi_checkbox',

diff --git a/src/Element/Number.php b/src/Element/Number.php
@@ -18,7 +18,7 @@ class Number extends Element implements InputProviderInterface
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'number',

diff --git a/src/Element/Password.php b/src/Element/Password.php
@@ -13,7 +13,7 @@ class Password extends Element implements ElementPrepareAwareInterface
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'password',

diff --git a/src/Element/Radio.php b/src/Element/Radio.php
@@ -12,7 +12,7 @@ class Radio extends MultiCheckbox
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'radio',

diff --git a/src/Element/Range.php b/src/Element/Range.php
@@ -16,7 +16,7 @@ class Range extends NumberElement
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'range',

diff --git a/src/Element/Search.php b/src/Element/Search.php
@@ -11,7 +11,7 @@ class Search extends Element
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'search',

diff --git a/src/Element/Select.php b/src/Element/Select.php
@@ -19,7 +19,7 @@ class Select extends Element implements InputProviderInterface
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'select',

diff --git a/src/Element/Submit.php b/src/Element/Submit.php
@@ -11,7 +11,7 @@ class Submit extends Element
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'submit',

diff --git a/src/Element/Tel.php b/src/Element/Tel.php
@@ -16,7 +16,7 @@ class Tel extends Element implements InputProviderInterface
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'tel',

diff --git a/src/Element/Text.php b/src/Element/Text.php
@@ -11,7 +11,7 @@ class Text extends Element
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'text',

diff --git a/src/Element/Textarea.php b/src/Element/Textarea.php
@@ -11,7 +11,7 @@ class Textarea extends Element
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'textarea',

diff --git a/src/Element/Time.php b/src/Element/Time.php
@@ -15,7 +15,7 @@ class Time extends AbstractDateTime
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'time',

diff --git a/src/Element/Url.php b/src/Element/Url.php
@@ -15,7 +15,7 @@ class Url extends Element implements InputProviderInterface
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'url',

diff --git a/src/Element/Week.php b/src/Element/Week.php
@@ -16,7 +16,7 @@ class Week extends AbstractDateTime
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'type' => 'week',

diff --git a/src/ElementAttributeRemovalInterface.php b/src/ElementAttributeRemovalInterface.php
@@ -16,6 +16,7 @@ public function removeAttribute(string $key);
     /**
      * Remove many attributes at once
      *
+     * @param list<string> $keys
      * @return $this
      */
     public function removeAttributes(array $keys);

diff --git a/src/ElementInterface.php b/src/ElementInterface.php
@@ -73,12 +73,15 @@ public function hasAttribute(string $key): bool;
      *
      * Implementation will decide if this will overwrite or merge.
      *
+     * @param iterable<string, mixed> $arrayOrTraversable
      * @return $this
      */
     public function setAttributes(iterable $arrayOrTraversable);
 
     /**
      * Retrieve all attributes at once
+     *
+     * @return array<string, mixed>
      */
     public function getAttributes(): array;
 

diff --git a/src/Form.php b/src/Form.php
@@ -29,7 +29,7 @@ class Form extends Fieldset implements FormInterface
     /**
      * Seed attributes
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'method' => 'POST',

diff --git a/src/LabelAwareInterface.php b/src/LabelAwareInterface.php
@@ -21,7 +21,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);