Fixed phpstan analysis issues and bad code that showed up with phpstan 2.0

Author: jbtronics

phpstan.dist.neon

@@ -57,4 +57,7 @@ parameters:
         - '#Part::getParameters\(\) should return .*AbstractParameter#'
 
         # Ignore doctrine type mapping mismatch
-        - '#Property .* type mapping mismatch: property can contain .* but database expects .*#'
+        - '#Property .* type mapping mismatch: property can contain .* but database expects .*#'
+
+        # Ignore error of unused WithPermPresetsTrait, as it is used in the migrations which are not analyzed by Phpstan
+        - '#Trait App\\Migration\\WithPermPresetsTrait is used zero times and is not analysed#'

src/Command/CheckRequirementsCommand.php

@@ -79,7 +79,7 @@ protected function checkPHP(SymfonyStyle $io, bool $only_issues = false): void
         //Checking 32-bit system
         if (PHP_INT_SIZE === 4) {
             $io->warning('You are using a 32-bit system. You will have problems with working with dates after the year 2038, therefore a 64-bit system is recommended.');
-        } elseif (PHP_INT_SIZE === 8) {
+        } elseif (PHP_INT_SIZE === 8) { //@phpstan-ignore-line //PHP_INT_SIZE is always 4 or 8
             if (!$only_issues) {
                 $io->success('You are using a 64-bit system.');
             }

src/Command/Migrations/ConvertBBCodeCommand.php

@@ -79,6 +79,7 @@ protected function configure(): void
 
     /**
      * Returns a list which entities and which properties need to be checked.
+     * @return array<class-string<AbstractNamedDBElement>, string[]>
      */
     protected function getTargetsLists(): array
     {
@@ -109,7 +110,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $class
             ));
             //Determine which entities of this type we need to modify
-            /** @var EntityRepository $repo */
             $repo = $this->em->getRepository($class);
             $qb = $repo->createQueryBuilder('e')
                 ->select('e');

src/Command/User/UsersPermissionsCommand.php

@@ -206,12 +206,15 @@ protected function getPermissionValue(User $user, string $permission, string $op
             return '<fg=green>Allow</>';
         } elseif ($permission_value === false) {
             return '<fg=red>Disallow</>';
-        } elseif ($permission_value === null && !$inherit) {
+        }
+        // Permission value is null by this point
+        elseif (!$inherit) {
             return '<fg=blue>Inherit</>';
-        } elseif ($permission_value === null && $inherit) {
+        } elseif ($inherit) {
             return '<fg=red>Disallow (Inherited)</>';
         }
 
+        //@phpstan-ignore-next-line This line is never reached, but PHPstorm complains otherwise
         return '???';
     }
 }

src/Controller/AdminPages/BaseAdminController.php

@@ -221,7 +221,6 @@ protected function _edit(AbstractNamedDBElement $entity, Request $request, Entit
             }
         }
 
-        /** @var AbstractPartsContainingRepository $repo */
         $repo = $this->entityManager->getRepository($this->entity_class);
 
         return $this->render($this->twig_template, [
@@ -397,7 +396,7 @@ protected function deleteCheck(AbstractNamedDBElement $entity): bool
     {
         if ($entity instanceof AbstractPartsContainingDBElement) {
             /** @var AbstractPartsContainingRepository $repo */
-            $repo = $this->entityManager->getRepository($this->entity_class);
+            $repo = $this->entityManager->getRepository($this->entity_class); //@phpstan-ignore-line
             if ($repo->getPartsCount($entity) > 0) {
                 $this->addFlash('error', t('entity.delete.must_not_contain_parts', ['%PATH%' => $entity->getFullPath()]));
 

src/Controller/LabelController.php

@@ -152,7 +152,7 @@ protected function findObjects(LabelSupportedElement $type, string $ids): array
     {
         $id_array = $this->rangeParser->parse($ids);
 
-        /** @var DBElementRepository $repo */
+        /** @var DBElementRepository<AbstractDBElement> $repo */
         $repo = $this->em->getRepository($type->getEntityClass());
 
         return $repo->getElementsFromIDArray($id_array);

src/Controller/PartListsController.php

@@ -60,6 +60,7 @@ public function tableAction(Request $request, PartsTableActionHandler $actionHan
         $ids = $request->request->get('ids');
         $action = $request->request->get('action');
         $target = $request->request->get('target');
+        $redirectResponse = null;
 
         if (!$this->isCsrfTokenValid('table_action', $request->request->get('_token'))) {
             $this->addFlash('error', 'csfr_invalid');
@@ -80,7 +81,7 @@ public function tableAction(Request $request, PartsTableActionHandler $actionHan
         }
 
         //If the action handler returned a response, we use it, otherwise we redirect back to the previous page.
-        if (isset($redirectResponse) && $redirectResponse instanceof Response) {
+        if ($redirectResponse !== null) {
             return $redirectResponse;
         }
 

src/Controller/TypeaheadController.php

@@ -22,6 +22,7 @@
 
 namespace App\Controller;
 
+use App\Entity\Parameters\AbstractParameter;
 use Symfony\Component\HttpFoundation\Response;
 use App\Entity\Attachments\Attachment;
 use App\Entity\Parts\Category;
@@ -92,7 +93,7 @@ public function builtInResources(Request $request, BuiltinAttachmentsFinder $fin
 
     /**
      * This function map the parameter type to the class, so we can access its repository
-     * @return class-string
+     * @return class-string<AbstractParameter>
      */
     private function typeToParameterClass(string $type): string
     {
@@ -155,7 +156,7 @@ public function parameters(string $type, EntityManagerInterface $entityManager,
         //Ensure user has the correct permissions
         $this->denyAccessUnlessGranted('read', $test_obj);
 
-        /** @var ParameterRepository $repository */
+        /** @var ParameterRepository<AbstractParameter> $repository */
         $repository = $entityManager->getRepository($class);
 
         $data = $repository->autocompleteParamName($query);

src/Controller/UserSettingsController.php

@@ -240,7 +240,10 @@ public function userSettings(Request $request, EntityManagerInterface $em, UserP
                 $page_need_reload = true;
             }
 
-            /** @var Form $form We need a form implementation for the next calls */
+            if (!$form instanceof Form) {
+                throw new RuntimeException('Form is not an instance of Form, so we cannot retrieve the clicked button!');
+            }
+
             //Remove the avatar attachment from the user if requested
             if ($form->getClickedButton() && 'remove_avatar' === $form->getClickedButton()->getName() && $user->getMasterPictureAttachment() instanceof Attachment) {
                 $em->remove($user->getMasterPictureAttachment());

src/DataTables/Filters/Constraints/Part/TagsConstraint.php

@@ -133,6 +133,7 @@ public function apply(QueryBuilder $queryBuilder): void
             return;
         }
 
+        //@phpstan-ignore-next-line Keep this check to ensure that everything has the same structure even if we add a new operator
         if ($this->operator === 'NONE') {
             $queryBuilder->andWhere($queryBuilder->expr()->not($queryBuilder->expr()->orX(...$tagsExpressions)));
             return;