Change return types from $this to self so that psalm infers inher…

…ited templates Signed-off-by: George Steel <[email protected]>
laminas · Nov 24, 2023 · a29ef60 · a29ef60
1 parent 93c2673
commit a29ef60
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 5 deletions.
diff --git a/src/Element.php b/src/Element.php
@@ -311,7 +311,7 @@ public function getLabelAttributes(): array
      *
      * Implementation will decide if this will overwrite or merge.
      *
-     * @return $this
+     * @return self
      * @throws Exception\InvalidArgumentException
      */
     public function setLabelOptions(iterable $arrayOrTraversable)

diff --git a/src/Fieldset.php b/src/Fieldset.php
@@ -585,7 +585,7 @@ public function bindValues(array $values = [], ?array $validationGroup = null)
     /**
      * Set if this fieldset is used as a base fieldset
      *
-     * @return $this
+     * @return self
      */
     public function setUseAsBaseFieldset(bool $useAsBaseFieldset)
     {

diff --git a/src/Form.php b/src/Form.php
@@ -675,7 +675,7 @@ public function useInputFilterDefaults(): bool
     /**
      * Set flag indicating whether or not to prefer the form input filter over element and fieldset defaults
      *
-     * @return $this
+     * @return self<TFilteredValues>
      */
     public function setPreferFormInputFilter(bool $preferFormInputFilter)
     {

diff --git a/src/LabelAwareInterface.php b/src/LabelAwareInterface.php
@@ -22,7 +22,7 @@ public function getLabel(): ?string;
      * Set the attributes to use with the label
      *
      * @param  array<string, scalar|null> $labelAttributes
-     * @return $this
+     * @return self
      */
     public function setLabelAttributes(array $labelAttributes);
 
@@ -38,7 +38,7 @@ public function getLabelAttributes(): array;
      *
      * Implementation will decide if this will overwrite or merge.
      *
-     * @return $this
+     * @return self
      */
     public function setLabelOptions(iterable $arrayOrTraversable);
 

diff --git a/test/StaticAnalysis/FormTemplates.php b/test/StaticAnalysis/FormTemplates.php
@@ -55,4 +55,20 @@ public function getDataWithValuesNormalized(): string
 
         return $data['string'];
     }
+
+    /** @return non-empty-string */
+    public function testThatFluidReturnTypesPreserveTemplatesForSetPreferFormInputFilter(): string
+    {
+        $form = new ExampleForm();
+        return $form->setPreferFormInputFilter(true)
+            ->getData(FormInterface::VALUES_AS_ARRAY)['string'];
+    }
+
+    /** @return non-empty-string */
+    public function testThatFluidReturnTypesPreserveTemplatesForSetWrapElements(): string
+    {
+        $form = new ExampleForm();
+        return $form->setWrapElements(true)
+            ->getData(FormInterface::VALUES_AS_ARRAY)['string'];
+    }
 }