From a6533029db652e4b53a1babac631f0268ab68479 Mon Sep 17 00:00:00 2001 From: Sebastian Bergmann Date: Fri, 2 Dec 2022 11:45:21 +0100 Subject: [PATCH] Document collected/iterated type using Psalm template --- .psalm/baseline.xml | 93 ------------------- .../Filter/DirectoryCollection.php | 2 + .../Filter/DirectoryCollectionIterator.php | 2 + .../Filesystem/DirectoryCollection.php | 2 + .../DirectoryCollectionIterator.php | 2 + .../Filesystem/FileCollection.php | 2 + .../Filesystem/FileCollectionIterator.php | 2 + .../Group/GroupCollection.php | 2 + .../Group/GroupCollectionIterator.php | 2 + .../PHP/ConstantCollection.php | 2 + .../PHP/ConstantCollectionIterator.php | 2 + .../PHP/IniSettingCollection.php | 2 + .../PHP/IniSettingCollectionIterator.php | 2 + .../PHP/VariableCollection.php | 2 + .../PHP/VariableCollectionIterator.php | 2 + .../PHPUnit/ExtensionCollection.php | 2 + .../PHPUnit/ExtensionCollectionIterator.php | 2 + .../TestSuite/TestDirectoryCollection.php | 2 + .../TestDirectoryCollectionIterator.php | 2 + .../TestSuite/TestFileCollection.php | 2 + .../TestSuite/TestFileCollectionIterator.php | 2 + .../TestSuite/TestSuiteCollection.php | 2 + .../TestSuite/TestSuiteCollectionIterator.php | 2 + src/Util/Xml/SnapshotNodeList.php | 2 + 24 files changed, 46 insertions(+), 93 deletions(-) diff --git a/.psalm/baseline.xml b/.psalm/baseline.xml index 1b5ba6589ba..3cd70f5741e 100644 --- a/.psalm/baseline.xml +++ b/.psalm/baseline.xml @@ -1179,54 +1179,22 @@ $this->printer !== null - - - IteratorAggregate - - - - Iterator - $position - - - IteratorAggregate - - - - Iterator - $position - - - IteratorAggregate - - - - Iterator - $position - - - IteratorAggregate - - - - Iterator - $position @@ -1373,28 +1341,12 @@ value - - - IteratorAggregate - - - - Iterator - $position - - - IteratorAggregate - - - - Iterator - $position @@ -1407,28 +1359,12 @@ value - - - IteratorAggregate - - - - Iterator - $position - - - IteratorAggregate - - - - Iterator - $position @@ -1463,41 +1399,17 @@ (string) $this->testSuiteLoaderFile - - - IteratorAggregate - - - - Iterator - $position - - - IteratorAggregate - - - - Iterator - $position - - - IteratorAggregate - - - - Iterator - $position @@ -1792,11 +1704,6 @@ (string) $entry->getAttribute('key') - - - IteratorAggregate - - $suite->getIterator() diff --git a/src/TextUI/XmlConfiguration/CodeCoverage/Filter/DirectoryCollection.php b/src/TextUI/XmlConfiguration/CodeCoverage/Filter/DirectoryCollection.php index 6a267f80e36..88ec1e38419 100644 --- 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 */ final class DirectoryCollection implements Countable, IteratorAggregate { diff --git a/src/TextUI/XmlConfiguration/CodeCoverage/Filter/DirectoryCollectionIterator.php b/src/TextUI/XmlConfiguration/CodeCoverage/Filter/DirectoryCollectionIterator.php index c59a3ba998d..f2fee25d46e 100644 --- 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 */ final class DirectoryCollectionIterator implements Countable, Iterator { diff --git a/src/TextUI/XmlConfiguration/Filesystem/DirectoryCollection.php b/src/TextUI/XmlConfiguration/Filesystem/DirectoryCollection.php index c904f60a1de..cb8408925f7 100644 --- 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 */ final class DirectoryCollection implements Countable, IteratorAggregate { diff --git a/src/TextUI/XmlConfiguration/Filesystem/DirectoryCollectionIterator.php b/src/TextUI/XmlConfiguration/Filesystem/DirectoryCollectionIterator.php index 7f354eea5bd..4b09274472e 100644 --- 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 */ final class DirectoryCollectionIterator implements Countable, Iterator { diff --git a/src/TextUI/XmlConfiguration/Filesystem/FileCollection.php b/src/TextUI/XmlConfiguration/Filesystem/FileCollection.php index df0746d6983..60e7e401b20 100644 --- 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 */ final class FileCollection implements Countable, IteratorAggregate { diff --git a/src/TextUI/XmlConfiguration/Filesystem/FileCollectionIterator.php b/src/TextUI/XmlConfiguration/Filesystem/FileCollectionIterator.php index d9bab1f8ba1..0ce4273d1a0 100644 --- 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 */ final class FileCollectionIterator implements Countable, Iterator { diff --git a/src/TextUI/XmlConfiguration/Group/GroupCollection.php b/src/TextUI/XmlConfiguration/Group/GroupCollection.php index fabf8646469..735d8af18d6 100644 --- 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 */ final class GroupCollection implements IteratorAggregate { diff --git a/src/TextUI/XmlConfiguration/Group/GroupCollectionIterator.php b/src/TextUI/XmlConfiguration/Group/GroupCollectionIterator.php index 0755fdac4e3..843a708e551 100644 --- 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 */ final class GroupCollectionIterator implements Countable, Iterator { diff --git a/src/TextUI/XmlConfiguration/PHP/ConstantCollection.php b/src/TextUI/XmlConfiguration/PHP/ConstantCollection.php index 6a0332a9848..440b0b0bfbf 100644 --- 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 */ final class ConstantCollection implements Countable, IteratorAggregate { diff --git a/src/TextUI/XmlConfiguration/PHP/ConstantCollectionIterator.php b/src/TextUI/XmlConfiguration/PHP/ConstantCollectionIterator.php index c1c8d834bae..623de961c18 100644 --- 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 */ final class ConstantCollectionIterator implements Countable, Iterator { diff --git a/src/TextUI/XmlConfiguration/PHP/IniSettingCollection.php b/src/TextUI/XmlConfiguration/PHP/IniSettingCollection.php index 9266f231503..28e40d93a29 100644 --- 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 */ final class IniSettingCollection implements Countable, IteratorAggregate { diff --git a/src/TextUI/XmlConfiguration/PHP/IniSettingCollectionIterator.php b/src/TextUI/XmlConfiguration/PHP/IniSettingCollectionIterator.php index f31225e8f68..6c348b48a46 100644 --- 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 */ final class IniSettingCollectionIterator implements Countable, Iterator { diff --git a/src/TextUI/XmlConfiguration/PHP/VariableCollection.php b/src/TextUI/XmlConfiguration/PHP/VariableCollection.php index 9efefc47384..6662db6496f 100644 --- 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 */ final class VariableCollection implements Countable, IteratorAggregate { diff --git a/src/TextUI/XmlConfiguration/PHP/VariableCollectionIterator.php b/src/TextUI/XmlConfiguration/PHP/VariableCollectionIterator.php index 3d594c1ee58..032d0be1e3f 100644 --- 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 */ final class VariableCollectionIterator implements Countable, Iterator { diff --git a/src/TextUI/XmlConfiguration/PHPUnit/ExtensionCollection.php b/src/TextUI/XmlConfiguration/PHPUnit/ExtensionCollection.php index 61b37b535fb..76d07ebc98e 100644 --- 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 */ final class ExtensionCollection implements IteratorAggregate { diff --git a/src/TextUI/XmlConfiguration/PHPUnit/ExtensionCollectionIterator.php b/src/TextUI/XmlConfiguration/PHPUnit/ExtensionCollectionIterator.php index 4bd54be4943..a9fc1af8edb 100644 --- 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 */ final class ExtensionCollectionIterator implements Countable, Iterator { diff --git a/src/TextUI/XmlConfiguration/TestSuite/TestDirectoryCollection.php b/src/TextUI/XmlConfiguration/TestSuite/TestDirectoryCollection.php index 9a0d0778b7c..5f581c21005 100644 --- 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 */ final class TestDirectoryCollection implements Countable, IteratorAggregate { diff --git a/src/TextUI/XmlConfiguration/TestSuite/TestDirectoryCollectionIterator.php b/src/TextUI/XmlConfiguration/TestSuite/TestDirectoryCollectionIterator.php index 11a48a2476d..b2312a384ec 100644 --- 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 */ final class TestDirectoryCollectionIterator implements Countable, Iterator { diff --git a/src/TextUI/XmlConfiguration/TestSuite/TestFileCollection.php b/src/TextUI/XmlConfiguration/TestSuite/TestFileCollection.php index a60a29f8e3d..27ba9bd2836 100644 --- 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 */ final class TestFileCollection implements Countable, IteratorAggregate { diff --git a/src/TextUI/XmlConfiguration/TestSuite/TestFileCollectionIterator.php b/src/TextUI/XmlConfiguration/TestSuite/TestFileCollectionIterator.php index b44c368948f..45a5f160c6f 100644 --- 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 */ final class TestFileCollectionIterator implements Countable, Iterator { diff --git a/src/TextUI/XmlConfiguration/TestSuite/TestSuiteCollection.php b/src/TextUI/XmlConfiguration/TestSuite/TestSuiteCollection.php index cbd824d2662..f632e519425 100644 --- 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 */ final class TestSuiteCollection implements Countable, IteratorAggregate { diff --git a/src/TextUI/XmlConfiguration/TestSuite/TestSuiteCollectionIterator.php b/src/TextUI/XmlConfiguration/TestSuite/TestSuiteCollectionIterator.php index 33b0f849573..42d03db0f1e 100644 --- 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 */ final class TestSuiteCollectionIterator implements Countable, Iterator { diff --git a/src/Util/Xml/SnapshotNodeList.php b/src/Util/Xml/SnapshotNodeList.php index ebc3285a6f1..e383678df69 100644 --- 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 */ final class SnapshotNodeList implements Countable, IteratorAggregate {