Revert BC breaking parameter type changes and mark helpers @final w…

…here possible Signed-off-by: George Steel <[email protected]>
laminas · Jul 20, 2023 · 4364ebd · 4364ebd
1 parent 4a2ba1a
commit 4364ebd
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 25 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -225,6 +225,9 @@
     </RedundantConditionGivenDocblockType>
   </file>
   <file src="src/Helper/HeadLink.php">
+    <ArgumentTypeCoercion>
+      <code>$item</code>
+    </ArgumentTypeCoercion>
     <MethodSignatureMustProvideReturnType>
       <code>offsetSet</code>
     </MethodSignatureMustProvideReturnType>
@@ -237,7 +240,6 @@
       <code>$href</code>
       <code>$index</code>
       <code>$item</code>
-      <code>$item</code>
       <code><![CDATA[$this->autoEscape ? $this->escapeAttribute($attributes[$itemKey]) : $attributes[$itemKey]]]></code>
       <code><![CDATA[$this->autoEscape ? $this->escapeAttribute($value) : $value]]></code>
       <code>$value</code>
@@ -258,7 +260,6 @@
       <code>$href</code>
       <code>$index</code>
       <code>$item</code>
-      <code>$item</code>
       <code>$media</code>
       <code>$title</code>
       <code>$type</code>
@@ -277,6 +278,7 @@
   </file>
   <file src="src/Helper/HeadMeta.php">
     <ArgumentTypeCoercion>
+      <code>$item</code>
       <code>$value</code>
       <code>$value</code>
     </ArgumentTypeCoercion>
@@ -349,10 +351,6 @@
       <code>$content</code>
       <code>$index</code>
       <code>$index</code>
-      <code><![CDATA[$item->attributes['conditional']]]></code>
-      <code><![CDATA[$item->type]]></code>
-      <code><![CDATA[$item->type]]></code>
-      <code>$key</code>
       <code><![CDATA[$this->autoEscape ? $this->escapeAttribute($value) : $value]]></code>
       <code>$value</code>
     </MixedArgument>
@@ -364,8 +362,6 @@
       <code><![CDATA[$attrs['src']]]></code>
       <code>$content</code>
       <code>$index</code>
-      <code>$key</code>
-      <code>$type</code>
       <code>$value</code>
     </MixedAssignment>
     <MixedInferredReturnType>
@@ -374,16 +370,6 @@
     <MixedMethodCall>
       <code>isHtml5</code>
     </MixedMethodCall>
-    <MixedOperand>
-      <code><![CDATA[$item->attributes['conditional']]]></code>
-      <code><![CDATA[$item->source]]></code>
-      <code>$type</code>
-    </MixedOperand>
-    <MixedPropertyFetch>
-      <code><![CDATA[$item->attributes]]></code>
-      <code><![CDATA[$item->source]]></code>
-      <code><![CDATA[$item->type]]></code>
-    </MixedPropertyFetch>
     <MixedReturnStatement>
       <code>parent::__call($method, $args)</code>
       <code>parent::__call($method, $args)</code>
@@ -411,6 +397,9 @@
     <MethodSignatureMustProvideReturnType>
       <code>offsetSet</code>
     </MethodSignatureMustProvideReturnType>
+    <MismatchingDocblockParamType>
+      <code>ObjectShape</code>
+    </MismatchingDocblockParamType>
     <MixedArgument>
       <code>$content</code>
       <code>$index</code>

diff --git a/src/Helper/HeadLink.php b/src/Helper/HeadLink.php
@@ -7,6 +7,7 @@
 use Laminas\View\Exception;
 use Laminas\View\Helper\Placeholder\Container\AbstractContainer;
 use Laminas\View\Helper\Placeholder\Container\AbstractStandalone;
+use stdClass;
 
 use function array_intersect;
 use function array_keys;
@@ -36,6 +37,7 @@
  * @method HeadLink offsetSetAlternate($index, $href, $type, $title, $extras = [])
  * @method HeadLink prependAlternate($href, $type, $title, $extras = [])
  * @method HeadLink setAlternate($href, $type, $title, $extras = [])
+ * @final
  */
 class HeadLink extends AbstractStandalone
 {
@@ -300,7 +302,7 @@ public function set($value)
      *
      * @return string
      */
-    public function itemToString(object $item)
+    public function itemToString(stdClass $item)
     {
         $attributes = (array) $item;
         $link       = '<link';

diff --git a/src/Helper/HeadMeta.php b/src/Helper/HeadMeta.php
@@ -8,6 +8,7 @@
 use Laminas\View\Exception;
 use Laminas\View\Helper\Placeholder\Container\AbstractContainer;
 use Laminas\View\Helper\Placeholder\Container\AbstractStandalone;
+use stdClass;
 
 use function array_shift;
 use function array_unshift;
@@ -63,6 +64,7 @@
  *     itemprop?: string,
  * }
  * @extends AbstractStandalone<int, ObjectShape>
+ * @final
  */
 class HeadMeta extends AbstractStandalone
 {
@@ -254,7 +256,7 @@ public function createData($type, $typeValue, $content, array $modifiers)
      * @throws Exception\InvalidArgumentException
      * @return string
      */
-    public function itemToString(object $item)
+    public function itemToString(stdClass $item)
     {
         if (! in_array($item->type, $this->typeKeys)) {
             throw new Exception\InvalidArgumentException(sprintf(

diff --git a/src/Helper/HeadScript.php b/src/Helper/HeadScript.php
@@ -422,10 +422,10 @@ protected function isValid($value)
      *
      * @internal This method will become private in version 3.0
      *
-     * @param  mixed  $item        Item to convert
-     * @param  string $indent      String to add before the item
-     * @param  string $escapeStart Starting sequence
-     * @param  string $escapeEnd   Ending sequence
+     * @param ObjectShape $item Item to convert
+     * @param string $indent String to add before the item
+     * @param string $escapeStart Starting sequence
+     * @param string $escapeEnd Ending sequence
      * @return string
      */
     public function itemToString($item, $indent, $escapeStart, $escapeEnd)

diff --git a/src/Helper/HeadStyle.php b/src/Helper/HeadStyle.php
@@ -44,6 +44,7 @@
  * @method HeadStyle prependStyle(string $content, array $attributes = [])
  * @method HeadStyle setStyle(string $content, array $attributes = [])
  * @method HeadStyle setIndent(int|string $indent)
+ * @final
  */
 class HeadStyle extends AbstractStandalone
 {
@@ -369,7 +370,7 @@ private function styleTagAttributesString(object $item): string
      * @param string $indent Indentation to use
      * @return string
      */
-    public function itemToString(object $item, $indent)
+    public function itemToString(stdClass $item, $indent)
     {
         if (! isset($item->content) || ! is_string($item->content) || $item->content === '') {
             return '';

diff --git a/src/Helper/HeadTitle.php b/src/Helper/HeadTitle.php
@@ -21,6 +21,7 @@
  * @method HeadTitle set(string $string)
  * @method HeadTitle prepend(string $string)
  * @method HeadTitle append(string $string)
+ * @final
  */
 class HeadTitle extends AbstractStandalone
 {

diff --git a/src/Helper/InlineScript.php b/src/Helper/InlineScript.php
@@ -7,6 +7,8 @@
 /**
  * Helper for setting and retrieving script elements for inclusion in HTML body
  * section
+ *
+ * @final
  */
 class InlineScript extends HeadScript
 {