Skip to content

Narrow type of Collection::last() when using Collection::isEmpty() #173

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 1 commit into from
Feb 9, 2021
Merged

Narrow type of Collection::last() when using Collection::isEmpty() #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion extension.neon
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,6 @@ services:

# Doctrine Collection
-
class: PHPStan\Type\Doctrine\Collection\FirstTypeSpecifyingExtension
class: PHPStan\Type\Doctrine\Collection\IsEmptyTypeSpecifyingExtension
tags:
- phpstan.typeSpecifier.methodTypeSpecifyingExtension
13 changes: 11 additions & 2 deletions ...llection/FirstTypeSpecifyingExtension.php → ...ection/IsEmptyTypeSpecifyingExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,13 @@
use PHPStan\Type\Constant\ConstantBooleanType;
use PHPStan\Type\MethodTypeSpecifyingExtension;

final class FirstTypeSpecifyingExtension implements MethodTypeSpecifyingExtension, TypeSpecifierAwareExtension
final class IsEmptyTypeSpecifyingExtension implements MethodTypeSpecifyingExtension, TypeSpecifierAwareExtension
{

private const COLLECTION_CLASS = 'Doctrine\Common\Collections\Collection';
private const IS_EMPTY_METHOD_NAME = 'isEmpty';
private const FIRST_METHOD_NAME = 'first';
private const LAST_METHOD_NAME = 'last';

/** @var TypeSpecifier */
private $typeSpecifier;
Expand Down Expand Up @@ -47,11 +48,19 @@ public function specifyTypes(
TypeSpecifierContext $context
): SpecifiedTypes
{
return $this->typeSpecifier->create(
$first = $this->typeSpecifier->create(
new MethodCall($node->var, self::FIRST_METHOD_NAME),
new ConstantBooleanType(false),
$context
);

$last = $this->typeSpecifier->create(
new MethodCall($node->var, self::LAST_METHOD_NAME),
new ConstantBooleanType(false),
$context
);

return $first->unionWith($last);
}

public function setTypeSpecifier(TypeSpecifier $typeSpecifier): void
Expand Down
26 changes: 19 additions & 7 deletions ...tion/FirstTypeSpecifyingExtensionTest.php → ...on/IsEmptyTypeSpecifyingExtensionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/**
* @extends \PHPStan\Testing\RuleTestCase<VariableTypeReportingRule>
*/
class FirstTypeSpecifyingExtensionTest extends \PHPStan\Testing\RuleTestCase
class IsEmptyTypeSpecifyingExtensionTest extends \PHPStan\Testing\RuleTestCase
{

protected function getRule(): Rule
Expand All @@ -21,24 +21,36 @@ protected function getRule(): Rule
protected function getMethodTypeSpecifyingExtensions(): array
{
return [
new FirstTypeSpecifyingExtension(),
new IsEmptyTypeSpecifyingExtension(),
];
}

public function testExtension(): void
{
$this->analyse([__DIR__ . '/data/collection.php'], [
[
'Variable $entityOrFalse is: MyEntity|false',
'Variable $entityOrFalse1 is: MyEntity|false',
18,
],
[
'Variable $false is: false',
22,
'Variable $entityOrFalse2 is: MyEntity|false',
21,
],
[
'Variable $entity is: MyEntity',
27,
'Variable $false1 is: false',
25,
],
[
'Variable $false2 is: false',
28,
],
[
'Variable $entity1 is: MyEntity',
33,
],
[
'Variable $entity2 is: MyEntity',
36,
],
]);
}
Expand Down
21 changes: 15 additions & 6 deletions tests/Type/Doctrine/Collection/data/collection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,24 @@ class MyEntity
*/
$collection = new ArrayCollection();

$entityOrFalse = $collection->first();
$entityOrFalse;
$entityOrFalse1 = $collection->first();
$entityOrFalse1;

$entityOrFalse2 = $collection->last();
$entityOrFalse2;

if ($collection->isEmpty()) {
$false = $collection->first();
$false;
$false1 = $collection->first();
$false1;

$false2 = $collection->last();
$false2;
}

if (!$collection->isEmpty()) {
$entity = $collection->first();
$entity;
$entity1 = $collection->first();
$entity1;

$entity2 = $collection->last();
$entity2;
}