Detect callables invoked via register_shutdown_function (#139)

Author: staabm

config/extension.neon

@@ -98,7 +98,7 @@ services:
             - phpstan.collector
 
     -
-        class: TomasVotruba\UnusedPublic\Collectors\Callable_\CallUserFuncCollector
+        class: TomasVotruba\UnusedPublic\Collectors\Callable_\CallbackFunctionCollector
         tags:
             - phpstan.collector
 

src/Collectors/Callable_/CallUserFuncCollector.php renamed to src/Collectors/Callable_/CallbackFunctionCollector.php

@@ -17,7 +17,7 @@
 /**
  * @implements Collector<FuncCall, non-empty-array<string>|null>
  */
-final readonly class CallUserFuncCollector implements Collector
+final readonly class CallbackFunctionCollector implements Collector
 {
     public function __construct(
         private Configuration $configuration,
@@ -92,6 +92,10 @@ private function shouldSkipNode(Node $node): bool
             return true;
         }
 
-        return strtolower($node->name->toString()) !== 'call_user_func';
+        return !in_array(
+            strtolower($node->name->toString()),
+            ['call_user_func', 'register_shutdown_function'],
+            true
+        );
     }
 }

src/NodeCollectorExtractor.php

@@ -7,7 +7,7 @@
 use PHPStan\Node\CollectedDataNode;
 use TomasVotruba\UnusedPublic\CollectorMapper\MethodCallCollectorMapper;
 use TomasVotruba\UnusedPublic\Collectors\Callable_\AttributeCallableCollector;
-use TomasVotruba\UnusedPublic\Collectors\Callable_\CallUserFuncCollector;
+use TomasVotruba\UnusedPublic\Collectors\Callable_\CallbackFunctionCollector;
 use TomasVotruba\UnusedPublic\Collectors\MethodCall\MethodCallableCollector;
 use TomasVotruba\UnusedPublic\Collectors\MethodCall\MethodCallCollector;
 use TomasVotruba\UnusedPublic\Collectors\StaticCall\StaticMethodCallableCollector;
@@ -48,7 +48,7 @@ private function extractCollectedDatas(CollectedDataNode $collectedDataNode): ar
             $collectedDataNode->get(StaticMethodCallCollector::class),
             $collectedDataNode->get(StaticMethodCallableCollector::class),
             $collectedDataNode->get(AttributeCallableCollector::class),
-            $collectedDataNode->get(CallUserFuncCollector::class),
+            $collectedDataNode->get(CallbackFunctionCollector::class),
         ];
     }
 }

tests/Rules/LocalOnlyPublicClassMethodRule/LocalOnlyPublicClassMethodRuleTest.php

@@ -10,7 +10,7 @@
 use PHPStan\Testing\RuleTestCase;
 use PHPUnit\Framework\Attributes\DataProvider;
 use TomasVotruba\UnusedPublic\Collectors\Callable_\AttributeCallableCollector;
-use TomasVotruba\UnusedPublic\Collectors\Callable_\CallUserFuncCollector;
+use TomasVotruba\UnusedPublic\Collectors\Callable_\CallbackFunctionCollector;
 use TomasVotruba\UnusedPublic\Collectors\MethodCall\MethodCallCollector;
 use TomasVotruba\UnusedPublic\Collectors\PublicClassMethodCollector;
 use TomasVotruba\UnusedPublic\Collectors\StaticCall\StaticMethodCallCollector;
@@ -80,7 +80,7 @@ protected function getCollectors(): array
             self::getContainer()->getByType(MethodCallCollector::class),
             self::getContainer()->getByType(StaticMethodCallCollector::class),
             self::getContainer()->getByType(AttributeCallableCollector::class),
-            self::getContainer()->getByType(CallUserFuncCollector::class),
+            self::getContainer()->getByType(CallbackFunctionCollector::class),
         ];
     }
 

tests/Rules/RelativeUnusedPublicClassMethodRule/RelativeUnusedPublicClassMethodRuleTest.php

@@ -10,7 +10,7 @@
 use PHPStan\Testing\RuleTestCase;
 use PHPUnit\Framework\Attributes\DataProvider;
 use TomasVotruba\UnusedPublic\Collectors\Callable_\AttributeCallableCollector;
-use TomasVotruba\UnusedPublic\Collectors\Callable_\CallUserFuncCollector;
+use TomasVotruba\UnusedPublic\Collectors\Callable_\CallbackFunctionCollector;
 use TomasVotruba\UnusedPublic\Collectors\FormTypeClassCollector;
 use TomasVotruba\UnusedPublic\Collectors\MethodCall\MethodCallableCollector;
 use TomasVotruba\UnusedPublic\Collectors\MethodCall\MethodCallCollector;
@@ -64,7 +64,7 @@ protected function getCollectors(): array
             // callables
             self::getContainer()->getByType(StaticMethodCallableCollector::class),
             self::getContainer()->getByType(AttributeCallableCollector::class),
-            self::getContainer()->getByType(CallUserFuncCollector::class),
+            self::getContainer()->getByType(CallbackFunctionCollector::class),
         ];
     }
 

tests/Rules/UnusedPublicClassMethodRule/Fixture/plain-call-shutdown-function.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TomasVotruba\UnusedPublic\Tests\Rules\UnusedPublicClassMethodRule\Fixture;
+
+/**
+ * @var \TomasVotruba\UnusedPublic\Tests\Rules\UnusedPublicClassMethodRule\Source\Caller1 $caller1
+ */
+
+register_shutdown_function([$caller1, 'callIt']);

tests/Rules/UnusedPublicClassMethodRule/UnusedPublicClassMethodRuleTest.php

@@ -10,7 +10,7 @@
 use PHPStan\Testing\RuleTestCase;
 use PHPUnit\Framework\Attributes\DataProvider;
 use TomasVotruba\UnusedPublic\Collectors\Callable_\AttributeCallableCollector;
-use TomasVotruba\UnusedPublic\Collectors\Callable_\CallUserFuncCollector;
+use TomasVotruba\UnusedPublic\Collectors\Callable_\CallbackFunctionCollector;
 use TomasVotruba\UnusedPublic\Collectors\FormTypeClassCollector;
 use TomasVotruba\UnusedPublic\Collectors\MethodCall\MethodCallableCollector;
 use TomasVotruba\UnusedPublic\Collectors\MethodCall\MethodCallCollector;
@@ -174,6 +174,7 @@ public static function provideData(): Iterator
 
         yield [[__DIR__ . '/Fixture/plain.php', __DIR__ . '/Source/Caller1.php'], []];
         yield [[__DIR__ . '/Fixture/plain-call-user-func.php', __DIR__ . '/Source/Caller1.php'], []];
+        yield [[__DIR__ . '/Fixture/plain-call-shutdown-function.php', __DIR__ . '/Source/Caller1.php'], []];
         yield [[__DIR__ . '/Fixture/SkipCrashBug89.php.inc'], []];
 
         yield [[__DIR__ . '/Fixture/SkipJsonSerialize.php'], []];
@@ -203,7 +204,7 @@ protected function getCollectors(): array
             // callables
             self::getContainer()->getByType(StaticMethodCallableCollector::class),
             self::getContainer()->getByType(AttributeCallableCollector::class),
-            self::getContainer()->getByType(CallUserFuncCollector::class),
+            self::getContainer()->getByType(CallbackFunctionCollector::class),
         ];
     }