Update PHPDoc and remove unnecessary PHPDoc applied to fix PHP-CS-Fixer errors #1334

Author: kniziol

phpstan-baseline.neon

@@ -0,0 +1,6 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Parameter \\#1 \\$function of class ReflectionFunction constructor expects Closure\\|string, callable\\(\\)\\: mixed given\\.$#"
+			count: 1
+			path: src/Twig/SourceCodeExtension.php

phpstan.neon.dist

@@ -1,3 +1,6 @@
+includes:
+    - phpstan-baseline.neon
+
 parameters:
     level: max
     paths:

src/Command/ListUsersCommand.php

@@ -105,7 +105,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         };
 
         // Doctrine query returns an array of objects, and we need an array of plain arrays
-        /** @var callable $createUserArray */
         $usersAsPlainArrays = array_map($createUserArray, $allUsers);
 
         // In your console commands you should always use the regular output type,
@@ -124,7 +123,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $usersAsATable = $bufferedOutput->fetch();
         $output->write($usersAsATable);
 
-        /** @var string $email */
+        /** @var string|null $email */
         $email = $input->getOption('send-to');
 
         if (null !== $email) {

src/Controller/BlogController.php

@@ -13,7 +13,6 @@
 
 use App\Entity\Comment;
 use App\Entity\Post;
-use App\Entity\Tag;
 use App\Entity\User;
 use App\Event\CommentCreatedEvent;
 use App\Form\CommentType;
@@ -53,7 +52,6 @@ public function index(Request $request, int $page, string $_format, PostReposito
     {
         $tag = null;
         if ($request->query->has('tag')) {
-            /** @var Tag $tag */
             $tag = $tags->findOneBy(['name' => $request->query->get('tag')]);
         }
         $latestPosts = $posts->findLatest($page, $tag);

src/DataFixtures/AppFixtures.php

@@ -68,8 +68,6 @@ private function loadTags(ObjectManager $manager): void
 
     private function loadPosts(ObjectManager $manager): void
     {
-        /** @var User $author */
-        /** @var array<Tag> $tags */
         foreach ($this->getPostData() as [$title, $slug, $summary, $content, $publishedAt, $author, $tags]) {
             $post = new Post();
             $post->setTitle($title);
@@ -132,21 +130,25 @@ private function getTagData(): array
     /**
      * @throws \Exception
      *
-     * @return array<int, array{0: string, 1: AbstractUnicodeString, 2: string, 3: string, 4: \DateTime, 5: object, 6: array<object>}>
+     * @return array<int, array{0: string, 1: AbstractUnicodeString, 2: string, 3: string, 4: \DateTime, 5: User, 6: array<Tag>}>
      */
     private function getPostData(): array
     {
         $posts = [];
         foreach ($this->getPhrases() as $i => $title) {
             // $postData = [$title, $slug, $summary, $content, $publishedAt, $author, $tags, $comments];
+
+            /** @var User $user */
+            $user = $this->getReference(['jane_admin', 'tom_admin'][0 === $i ? 0 : random_int(0, 1)]);
+
             $posts[] = [
                 $title,
                 $this->slugger->slug($title)->lower(),
                 $this->getRandomText(),
                 $this->getPostContent(),
                 new \DateTime('now - '.$i.'days'),
                 // Ensure that the first post is written by Jane Doe to simplify tests
-                $this->getReference(['jane_admin', 'tom_admin'][0 === $i ? 0 : random_int(0, 1)]),
+                $user,
                 $this->getRandomTags(),
             ];
         }
@@ -249,14 +251,19 @@ private function getPostContent(): string
     /**
      * @throws \Exception
      *
-     * @return array<object>
+     * @return array<Tag>
      */
     private function getRandomTags(): array
     {
         $tagNames = $this->getTagData();
         shuffle($tagNames);
         $selectedTags = \array_slice($tagNames, 0, random_int(2, 4));
 
-        return array_map(function ($tagName) { return $this->getReference('tag-'.$tagName); }, $selectedTags);
+        return array_map(function ($tagName) {
+            /** @var Tag $tag */
+            $tag = $this->getReference('tag-'.$tagName);
+
+            return $tag;
+        }, $selectedTags);
     }
 }

src/Form/DataTransformer/TagArrayToStringTransformer.php

@@ -36,8 +36,6 @@ public function __construct(
 
     /**
      * {@inheritdoc}
-     *
-     * @phpstan-param array<Tag>|null $tags
      */
     public function transform($tags): string
     {

src/Security/PostVoter.php

@@ -35,7 +35,7 @@ class PostVoter extends Voter
     /**
      * {@inheritdoc}
      *
-     * @phpstan-param Post $subject
+     * @phpstan-param object $subject
      */
     protected function supports(string $attribute, $subject): bool
     {

src/Twig/AppExtension.php

@@ -30,7 +30,7 @@ class AppExtension extends AbstractExtension
     private array $localeCodes;
 
     /**
-     * @var array<int, array<string, string>>|null
+     * @var list<array{code: string, name: string}>|null
      */
     private ?array $locales = null;
 

src/Twig/SourceCodeExtension.php

@@ -117,7 +117,6 @@ private function getCallableReflector(callable $callable): \ReflectionFunctionAb
             return $r->getMethod('__invoke');
         }
 
-        // @phpstan-ignore-next-line
         return new \ReflectionFunction($callable);
     }
 

tests/Command/AddUserCommandTest.php

@@ -91,12 +91,11 @@ private function assertUserCreated(bool $isAdmin): void
         /** @var UserRepository $repository */
         $repository = $this->getContainer()->get(UserRepository::class);
 
-        /** @var \App\Entity\User $user */
-        $user = $repository->findOneByEmail($this->userData['email']);
-
         /** @var UserPasswordHasherInterface $passwordHasher */
         $passwordHasher = $this->getContainer()->get('test.user_password_hasher');
 
+        $user = $repository->findOneByEmail($this->userData['email']);
+
         $this->assertNotNull($user);
         $this->assertSame($this->userData['full-name'], $user->getFullName());
         $this->assertSame($this->userData['username'], $user->getUsername());