[Maintenance] Fix PHPStan errors related to class-string

Author: lchrusciel

phpstan.neon

@@ -5,8 +5,6 @@ includes:
     - vendor/phpstan/phpstan-phpunit/rules.neon
 
 parameters:
-    checkGenericClassInNonGenericObjectType: false
-    checkMissingIterableValueType: false
     reportUnmatchedIgnoredErrors: false
 
     excludePaths:
@@ -72,7 +70,7 @@ parameters:
         - '/Parameter \#1 \$maxPerPage of method Pagerfanta\\Pagerfanta<mixed>::setMaxPerPage\(\) expects int<1, max>, int given\./'
         - '/Parameter \#1 \$array[0-9]? of function array_multisort expects array, array\|int given\./'
         - '/Parameter \#2 \$class of static method Webmozart\\Assert\\Assert::isInstanceOf\(\) expects class-string<object>, string given./'
-        - '/Parameter \#1 \$objectOrClass of class ReflectionClass constructor expects class-string<object>|object, object|string given./'
+        - '/Parameter \#1 \$objectOrClass of class ReflectionClass constructor expects class-string<object>\|object, object\|string given./'
         - '/Parameter \#1 \$package of method Symfony\\Component\\DependencyInjection\\Alias::setDeprecated\(\)/'
         - '/Return typehint of method Sylius\\Bundle\\ResourceBundle\\Routing\\CrudRoutesAttributesLoader::getClassAttributes\(\) has invalid type ReflectionAttribute./'
         - '/Return typehint of method Sylius\\Bundle\\ResourceBundle\\Routing\\RoutesAttributesLoader::getClassAttributes\(\) has invalid type ReflectionAttribute./'
@@ -102,3 +100,7 @@ parameters:
         - '/Parameter #1 \$submittedData of method Symfony\\Component\\Form\\FormInterface::submit\(\) expects array\|string\|null, mixed given\./'
         - '/Parameter #2 \$callback of function preg_replace_callback expects callable\(array<int\|string, string>\): string, Closure\(array\): mixed given\./'
         - '/Unable to resolve the template type T in call to method Doctrine\\Persistence\\ObjectManager::getClassMetadata\(\)/'
+        -
+            identifier: missingType.generics
+        -
+            identifier: missingType.iterableValue

src/Bundle/Routing/CrudRoutesAttributesLoader.php

@@ -39,14 +39,16 @@ public function __invoke(): RouteCollection
         $routeCollection = new RouteCollection();
         $paths = $this->mapping['paths'] ?? [];
 
-        /** @var string $className */
         foreach (ClassReflection::getResourcesByPaths($paths) as $className) {
             $this->addRoutesForSyliusCrudRoutesAttributes($routeCollection, $className);
         }
 
         return $routeCollection;
     }
 
+    /**
+     * @param class-string $className
+     */
     private function addRoutesForSyliusCrudRoutesAttributes(RouteCollection $routeCollection, string $className): void
     {
         $attributes = ClassReflection::getClassAttributes($className, SyliusCrudRoutes::class);

src/Bundle/Routing/RoutesAttributesLoader.php

@@ -32,7 +32,6 @@ public function __invoke(): RouteCollection
         $routeCollection = new RouteCollection();
         $paths = $this->mapping['paths'] ?? [];
 
-        /** @var string $className */
         foreach (ClassReflection::getResourcesByPaths($paths) as $className) {
             $this->routesAttributesFactory->createRouteForClass($routeCollection, $className);
             $this->attributesOperationRouteFactory->createRouteForClass($routeCollection, $className);

src/Component/legacy/tests/Reflection/ClassInfoTraitTest.php

@@ -28,18 +28,38 @@ private function getClassInfoTraitImplementation(): object
         };
     }
 
-    public function testDoctrineRealClassName(): void
+    /**
+     * @dataProvider getValidClasses
+     */
+    public function testRealClassName(string $class): void
     {
         $classInfo = $this->getClassInfoTraitImplementation();
 
-        $this->assertSame(Book::class, $classInfo->getRealClassName('Proxies\__CG__\App\Entity\Book'));
+        $this->assertSame(Book::class, $classInfo->getRealClassName($class));
     }
 
-    public function testProxyManagerRealClassName(): void
+    /**
+     * @dataProvider getInvalidClasses
+     */
+    public function testThrowsExceptionIfUnproxiedClassDoNotExist(string $class): void
     {
+        $this->expectException(\InvalidArgumentException::class);
+
         $classInfo = $this->getClassInfoTraitImplementation();
 
-        $this->assertSame(Book::class, $classInfo->getRealClassName('MongoDBODMProxies\__PM__\App\Entity\Book\Generated'));
+        $classInfo->getRealClassName($class);
+    }
+
+    public function getInvalidClasses(): Iterable
+    {
+        yield ['class' => 'Proxies\__CG__\App\Entity\Book1'];
+        yield ['class' => 'MongoDBODMProxies\__PM__\App\Entity\Book1\Generated'];
+    }
+
+    public function getValidClasses(): Iterable
+    {
+        yield ['class' => 'Proxies\__CG__\App\Entity\Book'];
+        yield ['class' => 'MongoDBODMProxies\__PM__\App\Entity\Book\Generated'];
     }
 
     public function testUnmarkedRealClassName(): void

src/Component/src/Reflection/ClassInfoTrait.php

@@ -13,6 +13,8 @@
 
 namespace Sylius\Resource\Reflection;
 
+use Webmozart\Assert\Assert;
+
 /**
  * Retrieves information about a class.
  *
@@ -22,6 +24,8 @@ trait ClassInfoTrait
 {
     /**
      * Get class name of the given object.
+     *
+     * @return class-string
      */
     private function getObjectClass(object $object): string
     {
@@ -30,6 +34,10 @@ private function getObjectClass(object $object): string
 
     /**
      * Get the real class name of a class name that could be a proxy.
+     *
+     * @param class-string $className
+     *
+     * @return class-string
      */
     private function getRealClassName(string $className): string
     {
@@ -43,15 +51,23 @@ private function getRealClassName(string $className): string
         }
 
         if (false !== $positionCg) {
-            return substr($className, $positionCg + 8);
+            $unProxiedClassName = substr($className, $positionCg + 8);
+
+            Assert::classExists($unProxiedClassName);
+
+            return $unProxiedClassName;
         }
 
         $className = ltrim($className, '\\');
 
-        return substr(
+        $unProxiedClassName = substr(
             $className,
             8 + $positionPm,
             strrpos($className, '\\') - ($positionPm + 8),
         );
+
+        Assert::classExists($unProxiedClassName);
+
+        return $unProxiedClassName;
     }
 }

src/Component/src/Reflection/ClassReflection.php

@@ -17,6 +17,9 @@
 
 final class ClassReflection
 {
+    /**
+     * @return \Generator<class-string>
+     */
     public static function getResourcesByPaths(array $paths): iterable
     {
         foreach ($paths as $resourceDirectory) {