Skip to content
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

Fix analysis on array_map with named arguments #3763

Open
wants to merge 4 commits into
base: 2.1.x
Choose a base branch
from
Open

Fix analysis on array_map with named arguments #3763

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f4eb0bc
Fix analysis on `array_map` with named arguments
takaram Jan 1, 2025
0b072cf
More tests for `bug-12317.php`
takaram Jan 2, 2025
6a5496c
Add test cases that produce errors
takaram Jan 2, 2025
b6cef51
Refactor
takaram Jan 2, 2025
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
46 changes: 34 additions & 12 deletions src/Parser/ArrayMapArgVisitor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

use PhpParser\Node;
use PhpParser\NodeVisitorAbstract;
use function array_slice;
use function array_splice;
use function count;

final class ArrayMapArgVisitor extends NodeVisitorAbstract
Expand All @@ -14,19 +14,41 @@ final class ArrayMapArgVisitor extends NodeVisitorAbstract

public function enterNode(Node $node): ?Node
{
if ($node instanceof Node\Expr\FuncCall && $node->name instanceof Node\Name && !$node->isFirstClassCallable()) {
$functionName = $node->name->toLowerString();
if ($functionName === 'array_map') {
$args = $node->getArgs();
if (isset($args[0])) {
$slicedArgs = array_slice($args, 1);
if (count($slicedArgs) > 0) {
$args[0]->value->setAttribute(self::ATTRIBUTE_NAME, $slicedArgs);
}
}
}
if (!$this->isArrayMapCall($node)) {
return null;
}

$args = $node->getArgs();
if (count($args) < 2) {
return null;
}

$callbackPos = 0;
if ($args[1]->name !== null && $args[1]->name->name === 'callback') {
$callbackPos = 1;
}
[$callback] = array_splice($args, $callbackPos, 1);
Copy link
Member

Choose a reason for hiding this comment

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

I have no idea what's going on at this line. Please make the code easier to read.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I made some refactors.

$callback->value->setAttribute(self::ATTRIBUTE_NAME, $args);

return null;
}

/**
* @phpstan-assert-if-true Node\Expr\FuncCall $node
*/
private function isArrayMapCall(Node $node): bool
{
if (!$node instanceof Node\Expr\FuncCall) {
return false;
}
if (!$node->name instanceof Node\Name) {
return false;
}
if ($node->isFirstClassCallable()) {
return false;
}

return $node->name->toLowerString() === 'array_map';
}

}
11 changes: 11 additions & 0 deletions tests/PHPStan/Rules/Functions/CallToFunctionParametersRuleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1936,4 +1936,15 @@ public function testBug12051(): void
$this->analyse([__DIR__ . '/data/bug-12051.php'], []);
}

public function testBug12317(): void
{
if (PHP_VERSION_ID < 80000) {
$this->markTestSkipped('Test requires PHP 8.0.');
}

$this->checkExplicitMixed = true;
$this->checkImplicitMixed = true;
$this->analyse([__DIR__ . '/data/bug-12317.php'], []);
Copy link
Member

Choose a reason for hiding this comment

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

Would be a good idea to add an example that actually produces an error, to verify the args still look like they should.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for your suggestion. I added examples and fixed a bug caught by them.

}

}
25 changes: 25 additions & 0 deletions tests/PHPStan/Rules/Functions/data/bug-12317.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?php declare(strict_types = 1);

namespace Bug12317;

class Uuid {
public function __construct(public string $uuid) {}
public function __toString() { return $this->uuid; }
}

class HelloWorld
{
/**
* @param list<Uuid> $arr
*/
public function sayHello(array $arr): void
{
$callback = static fn(Uuid $uuid): string => (string) $uuid;

array_map(array: $arr, callback: $callback);
array_map(callback: $callback, array: $arr);
array_map($callback, $arr);
array_map($callback, array: $arr);
array_map(static fn (Uuid $u1, Uuid $u2): string => (string) $u1, $arr, $arr);
}
}
Loading