minor #6996 Improve some phpdoc thanks to phpstan (VincentLanglet)

This PR was merged into the 4.x branch.

Discussion
----------

Improve some phpdoc thanks to phpstan

Commits
-------

5e93713 Improve phpdoc

Author: javiereguiluz

src/Dto/CrudDto.php

@@ -22,6 +22,7 @@ final class CrudDto
     private ?string $actionName = null;
     private ?ActionConfigDto $actionConfigDto = null;
     private ?FilterConfigDto $filters = null;
+    /** @var class-string|null */
     private ?string $entityFqcn = null;
     /** @var TranslatableInterface|string|callable|null */
     private $entityLabelInSingular;
@@ -111,11 +112,17 @@ public function setFieldAssets(AssetsDto $assets): void
         $this->fieldAssetsDto = $assets;
     }
 
+    /**
+     * @return class-string
+     */
     public function getEntityFqcn(): string
     {
         return $this->entityFqcn;
     }
 
+    /**
+     * @param class-string $entityFqcn
+     */
     public function setEntityFqcn(string $entityFqcn): void
     {
         $this->entityFqcn = $entityFqcn;

src/Event/BeforeEntityUpdatedEvent.php

@@ -4,6 +4,10 @@
 
 /**
  * @author Javier Eguiluz <[email protected]>
+ *
+ * @template TEntity of object
+ *
+ * @extends AbstractLifecycleEvent<TEntity>
  */
 final class BeforeEntityUpdatedEvent extends AbstractLifecycleEvent
 {

src/EventListener/AdminRouterSubscriber.php

@@ -250,6 +250,8 @@ public function onKernelController(ControllerEvent $event): void
      * Because of how EasyAdmin works, all backend requests are handled via the
      * Dashboard controller, so its enough to check if the request controller implements
      * the DashboardControllerInterface.
+     *
+     * @return class-string|null
      */
     private function getDashboardControllerFqcn(Request $request): ?string
     {

src/Factory/ControllerFactory.php

@@ -44,6 +44,13 @@ private function getCrudController(?string $crudControllerFqcn, ?string $crudAct
         return $this->getController(CrudControllerInterface::class, $crudControllerFqcn, $crudAction, $request);
     }
 
+    /**
+     * @template T of object
+     *
+     * @param class-string<T> $controllerInterface
+     *
+     * @return T|null
+     */
     private function getController(string $controllerInterface, ?string $controllerFqcn, ?string $controllerAction, Request $request): ?object
     {
         if (null === $controllerFqcn || null === $controllerAction) {
@@ -68,6 +75,9 @@ private function getController(string $controllerInterface, ?string $controllerF
         }
 
         $controllerInstance = $controllerCallable[0];
+        if (!\is_object($controllerInstance)) {
+            return null;
+        }
 
         return is_subclass_of($controllerInstance, $controllerInterface) ? $controllerInstance : null;
     }

src/Factory/EntityFactory.php

@@ -143,6 +143,9 @@ private function doCreate(?string $entityFqcn = null, mixed $entityId = null, st
         return $entityDto;
     }
 
+    /**
+     * @param class-string $entityFqcn
+     */
     private function getEntityManager(string $entityFqcn): ObjectManager
     {
         if (null === $entityManager = $this->doctrine->getManagerForClass($entityFqcn)) {
@@ -171,6 +174,10 @@ private function getEntityInstance(string $entityFqcn, mixed $entityIdValue): ob
      * Code copied from Symfony\Bridge\Doctrine\Form\DoctrineOrmTypeGuesser
      * because Doctrine ORM 3.x removed the ClassUtil class where this method was defined
      * (c) Fabien Potencier <[email protected]> - MIT License.
+     *
+     * @param class-string $class
+     *
+     * @return class-string
      */
     private function getRealClass(string $class): string
     {

src/Field/Configurator/ImageConfigurator.php

@@ -53,7 +53,7 @@ public function configure(FieldDto $field, EntityDto $entityDto, AdminContext $c
         }
         $relativeUploadDir = u($relativeUploadDir)->trimStart(\DIRECTORY_SEPARATOR)->ensureEnd(\DIRECTORY_SEPARATOR)->toString();
         $isStreamWrapper = filter_var($relativeUploadDir, \FILTER_VALIDATE_URL);
-        if ($isStreamWrapper) {
+        if (false !== $isStreamWrapper) {
             $absoluteUploadDir = $relativeUploadDir;
         } else {
             $absoluteUploadDir = u($relativeUploadDir)->ensureStart($this->projectDir.\DIRECTORY_SEPARATOR)->toString();

src/Form/Type/FileUploadType.php

@@ -145,11 +145,11 @@ public function configureOptions(OptionsResolver $resolver): void
             }
 
             $isStreamWrapper = filter_var($value, \FILTER_VALIDATE_URL);
-            if (!$isStreamWrapper && !str_starts_with($value, $this->projectDir)) {
+            if (false !== $isStreamWrapper && !str_starts_with($value, $this->projectDir)) {
                 $value = $this->projectDir.'/'.$value;
             }
 
-            if (!$isStreamWrapper && (!is_dir($value) || !is_writable($value))) {
+            if (false !== $isStreamWrapper && (!is_dir($value) || !is_writable($value))) {
                 throw new InvalidArgumentException(sprintf('Invalid upload directory "%s" it does not exist or is not writable.', $value));
             }
 

src/Resources/bin/logical-css-properties-linter.php

@@ -102,7 +102,7 @@ function lintFileCssProperties(string $file, array $logicalCssProperties): int
             }
 
             $pattern = '/(?<!-)\b'.preg_quote($forbidden, '/').'\s*:/';
-            if (preg_match($pattern, $line)) {
+            if (1 === preg_match($pattern, $line)) {
                 echo sprintf("File: %s\n", $file);
                 echo sprintf("Line: %d\n", $lineNumber + 1);
                 echo sprintf("Issue: you can't use the property '%s' because it's not safe for different writing systems; use instead the logical property '%s'\n", $forbidden, $alternative);

src/Router/AdminRouteGenerator.php

@@ -6,6 +6,8 @@
 use EasyCorp\Bundle\EasyAdminBundle\Attribute\AdminCrud;
 use EasyCorp\Bundle\EasyAdminBundle\Attribute\AdminDashboard;
 use EasyCorp\Bundle\EasyAdminBundle\Config\Option\EA;
+use EasyCorp\Bundle\EasyAdminBundle\Contracts\Controller\CrudControllerInterface;
+use EasyCorp\Bundle\EasyAdminBundle\Contracts\Controller\DashboardControllerInterface;
 use EasyCorp\Bundle\EasyAdminBundle\Contracts\Router\AdminRouteGeneratorInterface;
 use Psr\Cache\CacheItemPoolInterface;
 use Symfony\Component\Filesystem\Filesystem;
@@ -215,7 +217,7 @@ private function getDefaultRoutesConfig(string $dashboardFqcn): array
                 throw new \RuntimeException(sprintf('In the #[AdminDashboard] attribute of the "%s" dashboard controller, the route configuration for the "%s" action defines some unsupported keys. You can only define these keys: "routePath" and "routeName".', $dashboardFqcn, $action));
             }
 
-            if (isset($customRouteConfig['routeName']) && !preg_match('/^[a-zA-Z0-9_-]+$/', $customRouteConfig['routeName'])) {
+            if (isset($customRouteConfig['routeName']) && 1 !== preg_match('/^[a-zA-Z0-9_-]+$/', $customRouteConfig['routeName'])) {
                 throw new \RuntimeException(sprintf('In the #[AdminDashboard] attribute of the "%s" dashboard controller, the route name "%s" for the "%s" action is not valid. It can only contain letter, numbers, dashes, and underscores.', $dashboardFqcn, $customRouteConfig['routeName'], $action));
             }
 
@@ -298,6 +300,11 @@ private function getDashboardsRouteConfig(): array
         return $config;
     }
 
+    /**
+     * @param class-string<CrudControllerInterface> $crudControllerFqcn
+     *
+     * @return array{routeName: string, routePath: string}
+     */
     private function getCrudControllerRouteConfig(string $crudControllerFqcn): array
     {
         $crudControllerConfig = [];
@@ -320,7 +327,7 @@ private function getCrudControllerRouteConfig(string $crudControllerFqcn): array
             }
 
             if (null !== $attributeInstance->routeName) {
-                if (!preg_match('/^[a-zA-Z0-9_-]+$/', $attributeInstance->routeName)) {
+                if (1 !== preg_match('/^[a-zA-Z0-9_-]+$/', $attributeInstance->routeName)) {
                     throw new \RuntimeException(sprintf('In the #[AdminCrud] attribute of the "%s" CRUD controller, the route name "%s" is not valid. It can only contain letter, numbers, dashes, and underscores.', $crudControllerFqcn, $attributeInstance->routeName));
                 }
 
@@ -340,6 +347,11 @@ private function getCrudControllerRouteConfig(string $crudControllerFqcn): array
         return $crudControllerConfig;
     }
 
+    /**
+     * @param class-string<CrudControllerInterface> $crudControllerFqcn
+     *
+     * @return array<string, array{routeName?: string, routePath?: string, methods?: array<string>}>
+     */
     private function getCustomActionsConfig(string $crudControllerFqcn): array
     {
         $customActionsConfig = [];
@@ -370,7 +382,7 @@ private function getCustomActionsConfig(string $crudControllerFqcn): array
             }
 
             if (null !== $attributeInstance->routeName) {
-                if (!preg_match('/^[a-zA-Z0-9_-]+$/', $attributeInstance->routeName)) {
+                if (1 !== preg_match('/^[a-zA-Z0-9_-]+$/', $attributeInstance->routeName)) {
                     throw new \RuntimeException(sprintf('In the "%s" CRUD controller, the #[AdminAction] attribute applied to the "%s()" action defines an invalid route name: "%s". Valid route names can only contain letters, numbers, dashes, and underscores.', $crudControllerFqcn, $action, $attributeInstance->routeName));
                 }
 
@@ -397,6 +409,8 @@ private function getCustomActionsConfig(string $crudControllerFqcn): array
     }
 
     /**
+     * @param class-string<DashboardControllerInterface> $dashboardFqcn
+     *
      * @return array{routeName: string, route: Route}|null
      */
     private function createDashboardRoute(string $dashboardFqcn): ?array