Detect #[Column(enumType)], adjust ReflectionBasedMemberUsageProvider

Author: janedbal

src/Provider/DoctrineUsageProvider.php

@@ -10,9 +10,13 @@
 use PHPStan\BetterReflection\Reflection\Adapter\ReflectionMethod;
 use PHPStan\Node\InClassNode;
 use PHPStan\Reflection\ExtendedMethodReflection;
+use PHPStan\Reflection\ExtendedPropertyReflection;
 use PHPStan\Reflection\MethodReflection;
+use ShipMonk\PHPStan\DeadCode\Graph\ClassMemberUsage;
 use ShipMonk\PHPStan\DeadCode\Graph\ClassMethodRef;
 use ShipMonk\PHPStan\DeadCode\Graph\ClassMethodUsage;
+use ShipMonk\PHPStan\DeadCode\Graph\EnumCaseRef;
+use ShipMonk\PHPStan\DeadCode\Graph\EnumCaseUsage;
 use ShipMonk\PHPStan\DeadCode\Graph\UsageOrigin;
 
 class DoctrineUsageProvider implements MemberUsageProvider
@@ -36,7 +40,7 @@ public function getUsages(Node $node, Scope $scope): array
         if ($node instanceof InClassNode) { // @phpstan-ignore phpstanApi.instanceofAssumption
             $usages = [
                 ...$usages,
-                ...$this->getUsagesFromReflection($node),
+                ...$this->getUsagesFromReflection($node, $scope),
             ];
         }
 
@@ -51,15 +55,25 @@ public function getUsages(Node $node, Scope $scope): array
     }
 
     /**
-     * @return list<ClassMethodUsage>
+     * @return list<ClassMemberUsage>
      */
-    private function getUsagesFromReflection(InClassNode $node): array
+    private function getUsagesFromReflection(InClassNode $node, Scope $scope): array
     {
         $classReflection = $node->getClassReflection();
         $nativeReflection = $classReflection->getNativeReflection();
 
         $usages = [];
 
+        foreach ($nativeReflection->getProperties() as $nativePropertyReflection) {
+            $propertyName = $nativePropertyReflection->name;
+            $propertyReflection = $classReflection->getProperty($propertyName, $scope);
+
+            $usages = [
+                ...$usages,
+                ...$this->getUsagesOfEnumColumn($classReflection->getName(), $propertyName, $propertyReflection),
+            ];
+        }
+
         foreach ($nativeReflection->getMethods() as $method) {
             if ($method->getDeclaringClass()->getName() !== $nativeReflection->getName()) {
                 continue;
@@ -225,4 +239,36 @@ private function createMethodUsage(ExtendedMethodReflection $methodReflection, s
         );
     }
 
+    /**
+     * @return list<EnumCaseUsage>
+     */
+    private function getUsagesOfEnumColumn(string $className, string $propertyName, ExtendedPropertyReflection $property): array
+    {
+        $usages = [];
+
+        foreach ($property->getAttributes() as $attribute) {
+            if ($attribute->getName() !== 'Doctrine\ORM\Mapping\Column') {
+                continue;
+            }
+
+            foreach ($attribute->getArgumentTypes() as $name => $type) {
+                if ($name !== 'enumType') {
+                    continue;
+                }
+
+                foreach ($type->getConstantStrings() as $constantString) {
+                    $usages[] = new EnumCaseUsage(
+                        UsageOrigin::createVirtual($this, VirtualUsageData::withNote("Used in enumType of #[Column] of $className::$propertyName")),
+                        new EnumCaseRef(
+                            $constantString->getValue(),
+                            null,
+                        ),
+                    );
+                }
+            }
+        }
+
+        return $usages;
+    }
+
 }

src/Provider/ReflectionBasedMemberUsageProvider.php

@@ -7,12 +7,16 @@
 use PHPStan\Node\InClassNode;
 use PHPStan\Reflection\ClassReflection;
 use ReflectionClassConstant;
+use ReflectionEnum;
+use ReflectionEnumUnitCase;
 use ReflectionMethod;
 use ShipMonk\PHPStan\DeadCode\Graph\ClassConstantRef;
 use ShipMonk\PHPStan\DeadCode\Graph\ClassConstantUsage;
 use ShipMonk\PHPStan\DeadCode\Graph\ClassMemberUsage;
 use ShipMonk\PHPStan\DeadCode\Graph\ClassMethodRef;
 use ShipMonk\PHPStan\DeadCode\Graph\ClassMethodUsage;
+use ShipMonk\PHPStan\DeadCode\Graph\EnumCaseRef;
+use ShipMonk\PHPStan\DeadCode\Graph\EnumCaseUsage;
 use ShipMonk\PHPStan\DeadCode\Graph\UsageOrigin;
 use function array_merge;
 
@@ -30,6 +34,7 @@ public function getUsages(Node $node, Scope $scope): array
             return array_merge(
                 $this->getMethodUsages($classReflection),
                 $this->getConstantUsages($classReflection),
+                $this->getEnumCaseUsages($classReflection),
             );
         }
 
@@ -46,6 +51,11 @@ protected function shouldMarkConstantAsUsed(ReflectionClassConstant $constant):
         return null; // Expected to be overridden by subclasses.
     }
 
+    protected function shouldMarkEnumCaseAsUsed(ReflectionEnumUnitCase $enumCase): ?VirtualUsageData
+    {
+        return null; // Expected to be overridden by subclasses.
+    }
+
     /**
      * @return list<ClassMethodUsage>
      */
@@ -94,6 +104,30 @@ private function getConstantUsages(ClassReflection $classReflection): array
         return $usages;
     }
 
+    /**
+     * @return list<EnumCaseUsage>
+     */
+    private function getEnumCaseUsages(ClassReflection $classReflection): array
+    {
+        $nativeClassReflection = $classReflection->getNativeReflection();
+
+        if (!$nativeClassReflection instanceof ReflectionEnum) {
+            return [];
+        }
+
+        $usages = [];
+
+        foreach ($nativeClassReflection->getCases() as $nativeEnumCaseReflection) {
+            $usage = $this->shouldMarkEnumCaseAsUsed($nativeEnumCaseReflection);
+
+            if ($usage !== null) {
+                $usages[] = $this->createEnumCaseUsage($nativeEnumCaseReflection, $usage);
+            }
+        }
+
+        return $usages;
+    }
+
     private function createConstantUsage(ReflectionClassConstant $constantReflection, VirtualUsageData $data): ClassConstantUsage
     {
         return new ClassConstantUsage(
@@ -118,4 +152,15 @@ private function createMethodUsage(ReflectionMethod $methodReflection, VirtualUs
         );
     }
 
+    private function createEnumCaseUsage(ReflectionEnumUnitCase $enumCaseReflection, VirtualUsageData $usage): EnumCaseUsage
+    {
+        return new EnumCaseUsage(
+            UsageOrigin::createVirtual($this, $usage),
+            new EnumCaseRef(
+                $enumCaseReflection->getDeclaringClass()->getName(),
+                $enumCaseReflection->getName(),
+            ),
+        );
+    }
+
 }

tests/Rule/DeadCodeRuleTest.php

@@ -687,7 +687,7 @@ public static function provideFiles(): Traversable
         yield 'provider-symfony-7.1' => [__DIR__ . '/data/providers/symfony-gte71.php', self::requiresPhp(8_00_00) && self::requiresPackage('symfony/dependency-injection', '>= 7.1')];
         yield 'provider-twig' => [__DIR__ . '/data/providers/twig.php', self::requiresPhp(8_00_00)];
         yield 'provider-phpunit' => [__DIR__ . '/data/providers/phpunit.php', self::requiresPhp(8_00_00)];
-        yield 'provider-doctrine' => [__DIR__ . '/data/providers/doctrine.php', self::requiresPhp(8_00_00)];
+        yield 'provider-doctrine' => [__DIR__ . '/data/providers/doctrine.php', self::requiresPhp(8_01_00)];
         yield 'provider-phpstan' => [__DIR__ . '/data/providers/phpstan.php'];
         yield 'provider-nette' => [__DIR__ . '/data/providers/nette.php'];
 

tests/Rule/data/providers/doctrine.php

@@ -2,13 +2,22 @@
 
 namespace Doctrine;
 
+use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\EntityRepository;
 use Doctrine\ORM\Mapping\ClassMetadata;
 
+enum InvoiceStatus: string {
+    case Closed = 'closed';
+    case Open = 'open';
+}
+
 class MyEntity
 {
 
+    #[\Doctrine\ORM\Mapping\Column(type: Types::STRING, enumType: InvoiceStatus::class)]
+    private InvoiceStatus $status;
+
     #[\Doctrine\ORM\Mapping\PreUpdate]
     public function onUpdate(PreUpdateEventArgs $args): void {}