Skip to content

More precise RecursiveIteratorIterator::__construct() types #2835

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Jan 3, 2024
Merged

More precise RecursiveIteratorIterator::__construct() types #2835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0a0b279
More precise RecursiveIteratorIterator::__construct() types
staabm Dec 21, 2023
b2a0fb3
simplify
staabm Dec 21, 2023
00b8eb6
simplify
staabm Dec 21, 2023
5b7886e
Update iterable.stub
staabm Dec 21, 2023
49c356e
Update iterable.stub
staabm Dec 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions resources/functionMap_bleedingEdge.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@
'stream_socket_client' => ['resource|false', 'remoteaddress'=>'string', '&w_errcode='=>'int', '&w_errstring='=>'string', 'timeout='=>'float', 'flags='=>'int-mask<STREAM_CLIENT_CONNECT|STREAM_CLIENT_ASYNC_CONNECT|STREAM_CLIENT_PERSISTENT>', 'context='=>'resource'],
'stream_socket_enable_crypto' => ['0|bool', 'stream'=>'resource', 'enable'=>'bool', 'crypto_method='=>'STREAM_CRYPTO_METHOD_SSLv2_CLIENT|STREAM_CRYPTO_METHOD_SSLv3_CLIENT|STREAM_CRYPTO_METHOD_SSLv23_CLIENT|STREAM_CRYPTO_METHOD_ANY_CLIENT|STREAM_CRYPTO_METHOD_TLS_CLIENT|STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT|STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT|STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT|STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT|STREAM_CRYPTO_METHOD_SSLv2_SERVER|STREAM_CRYPTO_METHOD_SSLv3_SERVER|STREAM_CRYPTO_METHOD_SSLv23_SERVER|STREAM_CRYPTO_METHOD_ANY_SERVER|STREAM_CRYPTO_METHOD_TLS_SERVER|STREAM_CRYPTO_METHOD_TLSv1_0_SERVER|STREAM_CRYPTO_METHOD_TLSv1_1_SERVER|STREAM_CRYPTO_METHOD_TLSv1_2_SERVER|STREAM_CRYPTO_METHOD_TLSv1_3_SERVER', 'session_stream='=>'resource'],
'extract' => ['0|positive-int', '&rw_var_array'=>'array', 'extract_type='=>'EXTR_OVERWRITE|EXTR_SKIP|EXTR_PREFIX_SAME|EXTR_PREFIX_ALL|EXTR_PREFIX_INVALID|EXTR_IF_EXISTS|EXTR_PREFIX_IF_EXISTS|EXTR_REFS', 'prefix='=>'string|null'],
'RecursiveIteratorIterator::__construct' => ['void', 'iterator'=>'RecursiveIterator|IteratorAggregate', 'mode='=>'RecursiveIteratorIterator::LEAVES_ONLY|RecursiveIteratorIterator::SELF_FIRST|RecursiveIteratorIterator::CHILD_FIRST', 'flags='=>'0|RecursiveIteratorIterator::CATCH_GET_CHILD'],
],
'old' => [

Expand Down
5 changes: 1 addition & 4 deletions stubs/iterable.stub
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,15 +157,12 @@ class ArrayIterator implements SeekableIterator, ArrayAccess, Countable
*/
class RecursiveIteratorIterator
{

/**
* @param T $iterator
* @param int $mode
* @param int $flags
Comment on lines -163 to -164
Copy link
Contributor Author

@staabm staabm Dec 21, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it seems as soon as I keep these phpdocs here, the signature from resources/functionMap_bleedingEdge.php does not work, as it starts failling

There was 1 failure:

1) PHPStan\Rules\Classes\InstantiationRuleTest::testBug10324
Failed asserting that two strings are identical.
--- Expected
+++ Actual
@@ @@
-'23: Parameter #3 $flags of class RecursiveIteratorIterator constructor expects 0|16, 2 given.
+'
 '

/Users/staabm/workspace/phpstan-src/src/Testing/RuleTestCase.php:159
/Users/staabm/workspace/phpstan-src/tests/PHPStan/Rules/Classes/InstantiationRuleTest.php:466

*/
public function __construct(
$iterator,
$mode = RecursiveIteratorIterator::LEAVES_ONLY,
int $mode = RecursiveIteratorIterator::LEAVES_ONLY,
int $flags = 0
)
{
Expand Down
10 changes: 10 additions & 0 deletions tests/PHPStan/Rules/Classes/InstantiationRuleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,4 +461,14 @@ public function testBug9946(): void
$this->analyse([__DIR__ . '/data/bug-9946.php'], []);
}

public function testBug10324(): void
{
$this->analyse([__DIR__ . '/data/bug-10324.php'], [
[
'Parameter #3 $flags of class RecursiveIteratorIterator constructor expects 0|16, 2 given.',
23,
],
]);
}

}
33 changes: 33 additions & 0 deletions tests/PHPStan/Rules/Classes/data/bug-10324.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?php

namespace Bug10324;

use RecursiveIteratorIterator;
use RecursiveDirectoryIterator;

class HelloWorld
{
public function findfile(string $directory, string $filename): ?string
{
$fontPath = null;
$it = new RecursiveDirectoryIterator(
$directory,
RecursiveDirectoryIterator::SKIP_DOTS
| RecursiveDirectoryIterator::FOLLOW_SYMLINKS
);
foreach (
new RecursiveIteratorIterator(
$it,
RecursiveIteratorIterator::LEAVES_ONLY,
//RecursiveIteratorIterator::CATCH_GET_CHILD
RecursiveIteratorIterator::CHILD_FIRST
) as $file
) {
if (basename($file) === $filename) {
$fontPath = $file;
break;
}
}
return $fontPath;
}
}