-
Notifications
You must be signed in to change notification settings - Fork 574
Add @implements to SPL iterator stubs
#5672
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: 2.1.x
Are you sure you want to change the base?
Changes from 2 commits
d96658b
cf76ad1
f1afbc5
beeb03a
636d49c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -159,22 +159,10 @@ class ArrayIterator implements SeekableIterator, ArrayAccess, Countable | |
| } | ||
|
|
||
| /** | ||
| * @template T of \RecursiveIterator|\IteratorAggregate | ||
| * @mixin T | ||
| * @implements SeekableIterator<string, DirectoryIterator> | ||
| */ | ||
| class RecursiveIteratorIterator | ||
| class DirectoryIterator extends SplFileInfo implements SeekableIterator | ||
| { | ||
| /** | ||
| * @param T $iterator | ||
| */ | ||
| public function __construct( | ||
| $iterator, | ||
| int $mode = RecursiveIteratorIterator::LEAVES_ONLY, | ||
| int $flags = 0 | ||
| ) | ||
| { | ||
|
|
||
| } | ||
|
|
||
| } | ||
|
|
||
|
|
@@ -207,6 +195,29 @@ class IteratorIterator implements OuterIterator { | |
| public function __construct(Traversable $iterator) {} | ||
| } | ||
|
|
||
| /** | ||
| * @template TIterator of \RecursiveIterator|\IteratorAggregate | ||
| * | ||
| * @implements OuterIterator<key-of<TIterator>, value-of<TIterator>> | ||
| * | ||
| * @mixin TIterator | ||
| */ | ||
| class RecursiveIteratorIterator implements OuterIterator | ||
| { | ||
| /** | ||
| * @param TIterator $iterator | ||
| */ | ||
| public function __construct( | ||
| $iterator, | ||
| int $mode = RecursiveIteratorIterator::LEAVES_ONLY, | ||
| int $flags = 0 | ||
| ) | ||
| { | ||
|
|
||
| } | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * @template-covariant TKey | ||
| * @template-covariant TValue | ||
|
|
@@ -289,6 +300,14 @@ class RecursiveArrayIterator extends ArrayIterator implements RecursiveIterator | |
| public function uksort($cmp_function) { } | ||
| } | ||
|
|
||
| /** | ||
| * @implements RecursiveIterator<string, SplFileInfo|string> | ||
| */ | ||
| class RecursiveDirectoryIterator extends FilesystemIterator implements RecursiveIterator | ||
|
Comment on lines
+312
to
+315
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. looking at the above baseline.neon comment, I realized it might be a nice improvement to infer the if we could do this, we would not have the baseline entry (this might also be stuff for a future PR) might be doable for more iterators which work with |
||
| { | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * @template TKey | ||
| * @template TValue | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace Bug8435; | ||
|
|
||
| use RecursiveDirectoryIterator; | ||
| use RecursiveIteratorIterator; | ||
| use function PHPStan\Testing\assertType; | ||
|
|
||
| class HelloWorld | ||
| { | ||
| public function sayHello1(string $path): void | ||
| { | ||
| $iterator = new RecursiveDirectoryIterator($path); | ||
| foreach ($iterator as $fileinfo) { | ||
| assertType('SplFileInfo|string', $fileinfo); | ||
| } | ||
| } | ||
|
|
||
| public function sayHello2(string $path): void | ||
| { | ||
| $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path)); | ||
| foreach ($iterator as $fileinfo) { | ||
| assertType('SplFileInfo|string', $fileinfo); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param RecursiveIteratorIterator<RecursiveDirectoryIterator> $iterator | ||
| */ | ||
| public function test(RecursiveIteratorIterator $iterator): void | ||
| { | ||
| foreach ($iterator as $fileinfo) { | ||
| assertType('SplFileInfo|string', $fileinfo); | ||
| } | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -351,7 +351,7 @@ public function testBug3425(): void | |
| { | ||
| $this->analyse([__DIR__ . '/data/bug-3425.php'], [ | ||
| [ | ||
| 'Parameter #1 $iterator of class RecursiveIteratorIterator constructor expects T of IteratorAggregate|RecursiveIterator, Generator<int, int, mixed, void> given.', | ||
| 'Parameter #1 $iterator of class RecursiveIteratorIterator constructor expects TIterator of IteratorAggregate|RecursiveIterator, Generator<int, int, mixed, void> given.', | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You can avoid this change by not renaming the template from T to TIterator
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thank you! Fixed. |
||
| 5, | ||
| ], | ||
| ]); | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should not baseline this error but add a explicit check into
FileCacheStorageto make sure we are working ongetPathname().my understanding is, that we get this error now (and did not before), because we work with
string|SplFileInfoafter this PR, but hadmixedbefore.