Skip to content
/ rector-src Public

Fix adding string[] in explode() for ClassMethodArrayDocblockParamFromLocalCallsRector #7331

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
TomasVotruba merged 2 commits into from
Sep 25, 2025
Merged

Fix adding string[] in explode() for ClassMethodArrayDocblockParamFromLocalCallsRector #7331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d699b04
add fixture
TomasVotruba Sep 25, 2025
746df9a
fix adding string[] in explode() for ClassMethodArrayDocblockParamFro…
TomasVotruba Sep 25, 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
38 changes: 38 additions & 0 deletions ...tor/Class_/ClassMethodArrayDocblockParamFromLocalCallsRector/Fixture/from_explode.php.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<?php

namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\ClassMethodArrayDocblockParamFromLocalCallsRector\Fixture;

final class FromExplode
{
public function go()
{
$this->run(explode(':', '1:1'));
}

private function run(array $items)
{
}
}

?>
-----
<?php

namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\ClassMethodArrayDocblockParamFromLocalCallsRector\Fixture;

final class FromExplode
{
public function go()
{
$this->run(explode(':', '1:1'));
}

/**
* @param string[] $items
*/
private function run(array $items)
{
}
}

?>
7 changes: 7 additions & 0 deletions src/NodeTypeResolver/NodeTypeResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,13 @@
use PHPStan\Type\Constant\ConstantBooleanType;
use PHPStan\Type\Constant\ConstantStringType;
use PHPStan\Type\ErrorType;
use PHPStan\Type\IntegerType;
use PHPStan\Type\MixedType;
use PHPStan\Type\NeverType;
use PHPStan\Type\NullType;
use PHPStan\Type\ObjectType;
use PHPStan\Type\ObjectWithoutClassType;
use PHPStan\Type\StringType;
use PHPStan\Type\ThisType;
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;
Expand Down Expand Up @@ -178,6 +180,11 @@ public function getType(Node $node): Type
}
}

// correction for explode() that always returns array
Copy link
Contributor

@staabm staabm Sep 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

This assumption is only true for php8+

https://3v4l.org/N1eUT

Copy link
Member

@samsonasik samsonasik Sep 26, 2025

Choose a reason for hiding this comment

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

This is getType(), not getNativeType(), I guess it ok for most usage that allow based on docblock, but I think we can add check PhpVersionProvider->isAtLeastPhpVersion() for it.

Copy link
Contributor

@staabm staabm Sep 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Any reason why rector re-implements the type inference for such functions instead of using return-type extensions from PHPStan?
(Which would already do php version specific types)

Copy link
Member

@samsonasik samsonasik Sep 26, 2025

Choose a reason for hiding this comment

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

For this PR, looking for fixture, use for docblock array iterable value type reason.

Other type resolver and corrector are for common resolve type that are needed, eg Intersection string to string, Intersection array to array, also node verify by its attribute, eg, Name with its attribute, eg

rector-src/src/NodeTypeResolver/NodeTypeResolver/NameTypeResolver.php

Lines 41 to 43 in fe64244

if (! $node instanceof FullyQualified && $node->hasAttribute(AttributeKey::NAMESPACED_NAME)) {
return $this->resolve(new FullyQualified($node->getAttribute(AttributeKey::NAMESPACED_NAME)));
}

Copy link
Member

@samsonasik samsonasik Sep 26, 2025

Choose a reason for hiding this comment

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

I checked locally, without this, it seems got mixed[] on explode() function:

-     * @param string[] $items
+     * @param mixed[] $items

When using scope->getType(), it got Intersection:

PHPStan\Type\IntersectionType #11668
   types: array (3)
   |  0 => PHPStan\Type\ArrayType #13424
   |  |  itemType: PHPStan\Type\IntersectionType #11020
   |  |  |  types: array (3)
   |  |  |  |  0 => PHPStan\Type\Accessory\AccessoryLowercaseStringType #11687
   |  |  |  |  1 => PHPStan\Type\Accessory\AccessoryUppercaseStringType #11035
   |  |  |  |  2 => PHPStan\Type\StringType #10771
   |  |  |  sortedTypes: false
   |  |  keyType: PHPStan\Type\IntegerRangeType #11763
   |  |  |  min: 0
   |  |  |  max: null
   |  1 => PHPStan\Type\Accessory\AccessoryArrayListType #12617
   |  2 => PHPStan\Type\Accessory\NonEmptyArrayType #10765
   sortedTypes: false

It possibly can be handled in new corrector, eg: AccessoryNonEmptyArrayTypeCorrector, I will create new PR if this can be handled there.

Copy link
Member

@samsonasik samsonasik Sep 26, 2025

Choose a reason for hiding this comment

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

I created new PR for it:

if ($node instanceof FuncCall && $node->name instanceof Name && $node->name->toString() === 'explode') {
return new ArrayType(new IntegerType(), new StringType());
}

if ($node instanceof Ternary) {
$ternaryType = $this->resolveTernaryType($node);
if (! $ternaryType instanceof MixedType) {
Expand Down
Loading