Document collected/iterated type using Psalm template

sebastianbergmann · Dec 2, 2022 · a653302 · a653302
1 parent 70de842
commit a653302
Show file tree

Hide file tree

Showing 24 changed files with 46 additions and 93 deletions.
diff --git a/.psalm/baseline.xml b/.psalm/baseline.xml
@@ -1179,54 +1179,22 @@
       <code>$this-&gt;printer !== null</code>
     </RedundantConditionGivenDocblockType>
   </file>
-  <file src="src/TextUI/XmlConfiguration/CodeCoverage/Filter/DirectoryCollection.php">
-    <MissingTemplateParam occurrences="1">
-      <code>IteratorAggregate</code>
-    </MissingTemplateParam>
-  </file>
   <file src="src/TextUI/XmlConfiguration/CodeCoverage/Filter/DirectoryCollectionIterator.php">
-    <MissingTemplateParam occurrences="1">
-      <code>Iterator</code>
-    </MissingTemplateParam>
     <PropertyNotSetInConstructor occurrences="1">
       <code>$position</code>
     </PropertyNotSetInConstructor>
   </file>
-  <file src="src/TextUI/XmlConfiguration/Filesystem/DirectoryCollection.php">
-    <MissingTemplateParam occurrences="1">
-      <code>IteratorAggregate</code>
-    </MissingTemplateParam>
-  </file>
   <file src="src/TextUI/XmlConfiguration/Filesystem/DirectoryCollectionIterator.php">
-    <MissingTemplateParam occurrences="1">
-      <code>Iterator</code>
-    </MissingTemplateParam>
     <PropertyNotSetInConstructor occurrences="1">
       <code>$position</code>
     </PropertyNotSetInConstructor>
   </file>
-  <file src="src/TextUI/XmlConfiguration/Filesystem/FileCollection.php">
-    <MissingTemplateParam occurrences="1">
-      <code>IteratorAggregate</code>
-    </MissingTemplateParam>
-  </file>
   <file src="src/TextUI/XmlConfiguration/Filesystem/FileCollectionIterator.php">
-    <MissingTemplateParam occurrences="1">
-      <code>Iterator</code>
-    </MissingTemplateParam>
     <PropertyNotSetInConstructor occurrences="1">
       <code>$position</code>
     </PropertyNotSetInConstructor>
   </file>
-  <file src="src/TextUI/XmlConfiguration/Group/GroupCollection.php">
-    <MissingTemplateParam occurrences="1">
-      <code>IteratorAggregate</code>
-    </MissingTemplateParam>
-  </file>
   <file src="src/TextUI/XmlConfiguration/Group/GroupCollectionIterator.php">
-    <MissingTemplateParam occurrences="1">
-      <code>Iterator</code>
-    </MissingTemplateParam>
     <PropertyNotSetInConstructor occurrences="1">
       <code>$position</code>
     </PropertyNotSetInConstructor>
@@ -1373,28 +1341,12 @@
       <code>value</code>
     </MissingReturnType>
   </file>
-  <file src="src/TextUI/XmlConfiguration/PHP/ConstantCollection.php">
-    <MissingTemplateParam occurrences="1">
-      <code>IteratorAggregate</code>
-    </MissingTemplateParam>
-  </file>
   <file src="src/TextUI/XmlConfiguration/PHP/ConstantCollectionIterator.php">
-    <MissingTemplateParam occurrences="1">
-      <code>Iterator</code>
-    </MissingTemplateParam>
     <PropertyNotSetInConstructor occurrences="1">
       <code>$position</code>
     </PropertyNotSetInConstructor>
   </file>
-  <file src="src/TextUI/XmlConfiguration/PHP/IniSettingCollection.php">
-    <MissingTemplateParam occurrences="1">
-      <code>IteratorAggregate</code>
-    </MissingTemplateParam>
-  </file>
   <file src="src/TextUI/XmlConfiguration/PHP/IniSettingCollectionIterator.php">
-    <MissingTemplateParam occurrences="1">
-      <code>Iterator</code>
-    </MissingTemplateParam>
     <PropertyNotSetInConstructor occurrences="1">
       <code>$position</code>
     </PropertyNotSetInConstructor>
@@ -1407,28 +1359,12 @@
       <code>value</code>
     </MissingReturnType>
   </file>
-  <file src="src/TextUI/XmlConfiguration/PHP/VariableCollection.php">
-    <MissingTemplateParam occurrences="1">
-      <code>IteratorAggregate</code>
-    </MissingTemplateParam>
-  </file>
   <file src="src/TextUI/XmlConfiguration/PHP/VariableCollectionIterator.php">
-    <MissingTemplateParam occurrences="1">
-      <code>Iterator</code>
-    </MissingTemplateParam>
     <PropertyNotSetInConstructor occurrences="1">
       <code>$position</code>
     </PropertyNotSetInConstructor>
   </file>
-  <file src="src/TextUI/XmlConfiguration/PHPUnit/ExtensionCollection.php">
-    <MissingTemplateParam occurrences="1">
-      <code>IteratorAggregate</code>
-    </MissingTemplateParam>
-  </file>
   <file src="src/TextUI/XmlConfiguration/PHPUnit/ExtensionCollectionIterator.php">
-    <MissingTemplateParam occurrences="1">
-      <code>Iterator</code>
-    </MissingTemplateParam>
     <PropertyNotSetInConstructor occurrences="1">
       <code>$position</code>
     </PropertyNotSetInConstructor>
@@ -1463,41 +1399,17 @@
       <code>(string) $this-&gt;testSuiteLoaderFile</code>
     </RedundantCastGivenDocblockType>
   </file>
-  <file src="src/TextUI/XmlConfiguration/TestSuite/TestDirectoryCollection.php">
-    <MissingTemplateParam occurrences="1">
-      <code>IteratorAggregate</code>
-    </MissingTemplateParam>
-  </file>
   <file src="src/TextUI/XmlConfiguration/TestSuite/TestDirectoryCollectionIterator.php">
-    <MissingTemplateParam occurrences="1">
-      <code>Iterator</code>
-    </MissingTemplateParam>
     <PropertyNotSetInConstructor occurrences="1">
       <code>$position</code>
     </PropertyNotSetInConstructor>
   </file>
-  <file src="src/TextUI/XmlConfiguration/TestSuite/TestFileCollection.php">
-    <MissingTemplateParam occurrences="1">
-      <code>IteratorAggregate</code>
-    </MissingTemplateParam>
-  </file>
   <file src="src/TextUI/XmlConfiguration/TestSuite/TestFileCollectionIterator.php">
-    <MissingTemplateParam occurrences="1">
-      <code>Iterator</code>
-    </MissingTemplateParam>
     <PropertyNotSetInConstructor occurrences="1">
       <code>$position</code>
     </PropertyNotSetInConstructor>
   </file>
-  <file src="src/TextUI/XmlConfiguration/TestSuite/TestSuiteCollection.php">
-    <MissingTemplateParam occurrences="1">
-      <code>IteratorAggregate</code>
-    </MissingTemplateParam>
-  </file>
   <file src="src/TextUI/XmlConfiguration/TestSuite/TestSuiteCollectionIterator.php">
-    <MissingTemplateParam occurrences="1">
-      <code>Iterator</code>
-    </MissingTemplateParam>
     <PropertyNotSetInConstructor occurrences="1">
       <code>$position</code>
     </PropertyNotSetInConstructor>
@@ -1792,11 +1704,6 @@
       <code>(string) $entry-&gt;getAttribute('key')</code>
     </RedundantCast>
   </file>
-  <file src="src/Util/Xml/SnapshotNodeList.php">
-    <MissingTemplateParam occurrences="1">
-      <code>IteratorAggregate</code>
-    </MissingTemplateParam>
-  </file>
   <file src="src/Util/XmlTestListRenderer.php">
     <ArgumentTypeCoercion occurrences="1">
       <code>$suite-&gt;getIterator()</code>

diff --git a/src/TextUI/XmlConfiguration/CodeCoverage/Filter/DirectoryCollection.php b/src/TextUI/XmlConfiguration/CodeCoverage/Filter/DirectoryCollection.php
@@ -17,6 +17,8 @@
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
  *
  * @psalm-immutable
+ *
+ * @template-implements IteratorAggregate<int, Directory>
  */
 final class DirectoryCollection implements Countable, IteratorAggregate
 {

diff --git a/src/TextUI/XmlConfiguration/CodeCoverage/Filter/DirectoryCollectionIterator.php b/src/TextUI/XmlConfiguration/CodeCoverage/Filter/DirectoryCollectionIterator.php
@@ -16,6 +16,8 @@
 
 /**
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ *
+ * @template-implements Iterator<int, Directory>
  */
 final class DirectoryCollectionIterator implements Countable, Iterator
 {

diff --git a/src/TextUI/XmlConfiguration/Filesystem/DirectoryCollection.php b/src/TextUI/XmlConfiguration/Filesystem/DirectoryCollection.php
@@ -17,6 +17,8 @@
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
  *
  * @psalm-immutable
+ *
+ * @template-implements IteratorAggregate<int, Directory>
  */
 final class DirectoryCollection implements Countable, IteratorAggregate
 {

diff --git a/src/TextUI/XmlConfiguration/Filesystem/DirectoryCollectionIterator.php b/src/TextUI/XmlConfiguration/Filesystem/DirectoryCollectionIterator.php
@@ -16,6 +16,8 @@
 
 /**
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ *
+ * @template-implements Iterator<int, Directory>
  */
 final class DirectoryCollectionIterator implements Countable, Iterator
 {

diff --git a/src/TextUI/XmlConfiguration/Filesystem/FileCollection.php b/src/TextUI/XmlConfiguration/Filesystem/FileCollection.php
@@ -17,6 +17,8 @@
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
  *
  * @psalm-immutable
+ *
+ * @template-implements IteratorAggregate<int, File>
  */
 final class FileCollection implements Countable, IteratorAggregate
 {

diff --git a/src/TextUI/XmlConfiguration/Filesystem/FileCollectionIterator.php b/src/TextUI/XmlConfiguration/Filesystem/FileCollectionIterator.php
@@ -16,6 +16,8 @@
 
 /**
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ *
+ * @template-implements Iterator<int, File>
  */
 final class FileCollectionIterator implements Countable, Iterator
 {

diff --git a/src/TextUI/XmlConfiguration/Group/GroupCollection.php b/src/TextUI/XmlConfiguration/Group/GroupCollection.php
@@ -15,6 +15,8 @@
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
  *
  * @psalm-immutable
+ *
+ * @template-implements IteratorAggregate<int, Group>
  */
 final class GroupCollection implements IteratorAggregate
 {

diff --git a/src/TextUI/XmlConfiguration/Group/GroupCollectionIterator.php b/src/TextUI/XmlConfiguration/Group/GroupCollectionIterator.php
@@ -16,6 +16,8 @@
 
 /**
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ *
+ * @template-implements Iterator<int, Group>
  */
 final class GroupCollectionIterator implements Countable, Iterator
 {

diff --git a/src/TextUI/XmlConfiguration/PHP/ConstantCollection.php b/src/TextUI/XmlConfiguration/PHP/ConstantCollection.php
@@ -17,6 +17,8 @@
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
  *
  * @psalm-immutable
+ *
+ * @template-implements IteratorAggregate<int, Constant>
  */
 final class ConstantCollection implements Countable, IteratorAggregate
 {

diff --git a/src/TextUI/XmlConfiguration/PHP/ConstantCollectionIterator.php b/src/TextUI/XmlConfiguration/PHP/ConstantCollectionIterator.php
@@ -16,6 +16,8 @@
 
 /**
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ *
+ * @template-implements Iterator<int, Constant>
  */
 final class ConstantCollectionIterator implements Countable, Iterator
 {

diff --git a/src/TextUI/XmlConfiguration/PHP/IniSettingCollection.php b/src/TextUI/XmlConfiguration/PHP/IniSettingCollection.php
@@ -17,6 +17,8 @@
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
  *
  * @psalm-immutable
+ *
+ * @template-implements IteratorAggregate<int, IniSetting>
  */
 final class IniSettingCollection implements Countable, IteratorAggregate
 {

diff --git a/src/TextUI/XmlConfiguration/PHP/IniSettingCollectionIterator.php b/src/TextUI/XmlConfiguration/PHP/IniSettingCollectionIterator.php
@@ -16,6 +16,8 @@
 
 /**
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ *
+ * @template-implements Iterator<int, IniSetting>
  */
 final class IniSettingCollectionIterator implements Countable, Iterator
 {

diff --git a/src/TextUI/XmlConfiguration/PHP/VariableCollection.php b/src/TextUI/XmlConfiguration/PHP/VariableCollection.php
@@ -17,6 +17,8 @@
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
  *
  * @psalm-immutable
+ *
+ * @template-implements IteratorAggregate<int, Variable>
  */
 final class VariableCollection implements Countable, IteratorAggregate
 {

diff --git a/src/TextUI/XmlConfiguration/PHP/VariableCollectionIterator.php b/src/TextUI/XmlConfiguration/PHP/VariableCollectionIterator.php
@@ -16,6 +16,8 @@
 
 /**
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ *
+ * @template-implements Iterator<int, Variable>
  */
 final class VariableCollectionIterator implements Countable, Iterator
 {

diff --git a/src/TextUI/XmlConfiguration/PHPUnit/ExtensionCollection.php b/src/TextUI/XmlConfiguration/PHPUnit/ExtensionCollection.php
@@ -15,6 +15,8 @@
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
  *
  * @psalm-immutable
+ *
+ * @template-implements IteratorAggregate<int, Extension>
  */
 final class ExtensionCollection implements IteratorAggregate
 {

diff --git a/src/TextUI/XmlConfiguration/PHPUnit/ExtensionCollectionIterator.php b/src/TextUI/XmlConfiguration/PHPUnit/ExtensionCollectionIterator.php
@@ -16,6 +16,8 @@
 
 /**
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ *
+ * @template-implements Iterator<int, Extension>
  */
 final class ExtensionCollectionIterator implements Countable, Iterator
 {

diff --git a/src/TextUI/XmlConfiguration/TestSuite/TestDirectoryCollection.php b/src/TextUI/XmlConfiguration/TestSuite/TestDirectoryCollection.php
@@ -17,6 +17,8 @@
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
  *
  * @psalm-immutable
+ *
+ * @template-implements IteratorAggregate<int, TestDirectory>
  */
 final class TestDirectoryCollection implements Countable, IteratorAggregate
 {

diff --git a/src/TextUI/XmlConfiguration/TestSuite/TestDirectoryCollectionIterator.php b/src/TextUI/XmlConfiguration/TestSuite/TestDirectoryCollectionIterator.php
@@ -16,6 +16,8 @@
 
 /**
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ *
+ * @template-implements Iterator<int, TestDirectory>
  */
 final class TestDirectoryCollectionIterator implements Countable, Iterator
 {

diff --git a/src/TextUI/XmlConfiguration/TestSuite/TestFileCollection.php b/src/TextUI/XmlConfiguration/TestSuite/TestFileCollection.php
@@ -17,6 +17,8 @@
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
  *
  * @psalm-immutable
+ *
+ * @template-implements IteratorAggregate<int, TestFile>
  */
 final class TestFileCollection implements Countable, IteratorAggregate
 {

diff --git a/src/TextUI/XmlConfiguration/TestSuite/TestFileCollectionIterator.php b/src/TextUI/XmlConfiguration/TestSuite/TestFileCollectionIterator.php
@@ -16,6 +16,8 @@
 
 /**
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ *
+ * @template-implements Iterator<int, TestFile>
  */
 final class TestFileCollectionIterator implements Countable, Iterator
 {

diff --git a/src/TextUI/XmlConfiguration/TestSuite/TestSuiteCollection.php b/src/TextUI/XmlConfiguration/TestSuite/TestSuiteCollection.php
@@ -17,6 +17,8 @@
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
  *
  * @psalm-immutable
+ *
+ * @template-implements IteratorAggregate<int, TestSuite>
  */
 final class TestSuiteCollection implements Countable, IteratorAggregate
 {

diff --git a/src/TextUI/XmlConfiguration/TestSuite/TestSuiteCollectionIterator.php b/src/TextUI/XmlConfiguration/TestSuite/TestSuiteCollectionIterator.php
@@ -16,6 +16,8 @@
 
 /**
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ *
+ * @template-implements Iterator<int, TestSuite>
  */
 final class TestSuiteCollectionIterator implements Countable, Iterator
 {

diff --git a/src/Util/Xml/SnapshotNodeList.php b/src/Util/Xml/SnapshotNodeList.php
@@ -18,6 +18,8 @@
 
 /**
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ *
+ * @template-implements IteratorAggregate<int, DOMNode>
  */
 final class SnapshotNodeList implements Countable, IteratorAggregate
 {
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,8 @@ @@
     /**
      * @internal This class is not covered by the backward compatibility promise for PHPUnit
+     *
+     * @template-implements Iterator<int, Directory>
      */
     final class DirectoryCollectionIterator implements Countable, Iterator
     {
@@ Expand Down @@