bug symfony#61106 Fix @var phpdoc (fabpot)

fabpot · fabpot · commit c50356b0550b · 2025-07-14T18:38:29.000+02:00
This PR was squashed before being merged into the 6.4 branch. Discussion ---------- Fix `@var` phpdoc | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Issues | Fix #...  | License | MIT refs symfony#61105 Commits ------- 732fbe8 Fix `@var` phpdoc
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -30,6 +30,7 @@
         '@PHPUnit75Migration:risky' => true,
         '@Symfony' => true,
         '@Symfony:risky' => true,
+        'phpdoc_var_annotation_correct_order' => true,
         'protected_to_private' => false,
         'no_superfluous_phpdoc_tags' => [
             'remove_inheritdoc' => true,
diff --git a/src/Symfony/Bridge/ProxyManager/Tests/LazyProxy/ContainerBuilderTest.php b/src/Symfony/Bridge/ProxyManager/Tests/LazyProxy/ContainerBuilderTest.php
@@ -38,7 +38,7 @@ public function testCreateProxyServiceWithRuntimeInstantiator()
 
         $builder->compile();
 
-        /* @var $foo1 \ProxyManager\Proxy\LazyLoadingInterface|\ProxyManager\Proxy\ValueHolderInterface */
+        /** @var \ProxyManager\Proxy\LazyLoadingInterface|\ProxyManager\Proxy\ValueHolderInterface $foo1 */
         $foo1 = $builder->get('foo1');
 
         $foo1->__destruct();
diff --git a/src/Symfony/Bridge/ProxyManager/Tests/LazyProxy/Instantiator/RuntimeInstantiatorTest.php b/src/Symfony/Bridge/ProxyManager/Tests/LazyProxy/Instantiator/RuntimeInstantiatorTest.php
@@ -41,7 +41,7 @@ public function testInstantiateProxy()
         $definition = new Definition('stdClass');
         $instantiator = fn () => $instance;
 
-        /* @var $proxy LazyLoadingInterface|ValueHolderInterface */
+        /** @var LazyLoadingInterface|ValueHolderInterface $proxy */
         $proxy = $this->instantiator->instantiateProxy($container, $definition, 'foo', $instantiator);
 
         $this->assertInstanceOf(LazyLoadingInterface::class, $proxy);
diff --git a/src/Symfony/Bridge/Twig/Extension/FormExtension.php b/src/Symfony/Bridge/Twig/Extension/FormExtension.php
@@ -157,7 +157,7 @@ private function createFieldChoicesList(iterable $choices, string|false|null $tr
                 continue;
             }
 
-            /* @var ChoiceView $choice */
+            /** @var ChoiceView $choice */
             $translatableLabel = $this->createFieldTranslation($choice->label, $choice->labelTranslationParameters, $translationDomain);
             yield $translatableLabel => $choice->value;
         }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/AbstractControllerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/AbstractControllerTest.php
@@ -233,7 +233,7 @@ public function testFile()
         $controller = $this->createController();
         $controller->setContainer($container);
 
-        /* @var BinaryFileResponse $response */
+        /** @var BinaryFileResponse $response */
         $response = $controller->file(new File(__FILE__));
         $this->assertInstanceOf(BinaryFileResponse::class, $response);
         $this->assertSame(200, $response->getStatusCode());
@@ -248,7 +248,7 @@ public function testFileAsInline()
     {
         $controller = $this->createController();
 
-        /* @var BinaryFileResponse $response */
+        /** @var BinaryFileResponse $response */
         $response = $controller->file(new File(__FILE__), null, ResponseHeaderBag::DISPOSITION_INLINE);
 
         $this->assertInstanceOf(BinaryFileResponse::class, $response);
@@ -264,7 +264,7 @@ public function testFileWithOwnFileName()
     {
         $controller = $this->createController();
 
-        /* @var BinaryFileResponse $response */
+        /** @var BinaryFileResponse $response */
         $fileName = 'test.php';
         $response = $controller->file(new File(__FILE__), $fileName);
 
@@ -281,7 +281,7 @@ public function testFileWithOwnFileNameAsInline()
     {
         $controller = $this->createController();
 
-        /* @var BinaryFileResponse $response */
+        /** @var BinaryFileResponse $response */
         $fileName = 'test.php';
         $response = $controller->file(new File(__FILE__), $fileName, ResponseHeaderBag::DISPOSITION_INLINE);
 
@@ -298,7 +298,7 @@ public function testFileFromPath()
     {
         $controller = $this->createController();
 
-        /* @var BinaryFileResponse $response */
+        /** @var BinaryFileResponse $response */
         $response = $controller->file(__FILE__);
 
         $this->assertInstanceOf(BinaryFileResponse::class, $response);
@@ -314,7 +314,7 @@ public function testFileFromPathWithCustomizedFileName()
     {
         $controller = $this->createController();
 
-        /* @var BinaryFileResponse $response */
+        /** @var BinaryFileResponse $response */
         $response = $controller->file(__FILE__, 'test.php');
 
         $this->assertInstanceOf(BinaryFileResponse::class, $response);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/TestBundle.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/TestBundle.php
@@ -24,7 +24,7 @@ public function build(ContainerBuilder $container): void
     {
         parent::build($container);
 
-        /** @var $extension DependencyInjection\TestExtension */
+        /** @var DependencyInjection\TestExtension $extension */
         $extension = $container->getExtension('test');
 
         if (!$container->getParameterBag() instanceof FrozenParameterBag) {
diff --git a/src/Symfony/Component/AssetMapper/ImportMap/Resolver/JsDelivrEsmResolver.php b/src/Symfony/Component/AssetMapper/ImportMap/Resolver/JsDelivrEsmResolver.php
@@ -196,7 +196,7 @@ public function downloadPackages(array $importMapEntries, ?callable $progressCal
 
             $dependencies = [];
             $extraFiles = [];
-            /* @var ImportMapEntry $entry */
+            /** @var ImportMapEntry $entry */
             $contents[$package] = [
                 'content' => $this->makeImportsBare($response->getContent(), $dependencies, $extraFiles, $entry->type, $entry->getPackagePathString()),
                 'dependencies' => $dependencies,
diff --git a/src/Symfony/Component/AssetMapper/Tests/ImportMap/ImportMapManagerTest.php b/src/Symfony/Component/AssetMapper/Tests/ImportMap/ImportMapManagerTest.php
@@ -248,7 +248,7 @@ public function testUpdateAll()
             ->method('resolvePackages')
             ->with($this->callback(function ($packages) {
                 $this->assertInstanceOf(PackageRequireOptions::class, $packages[0]);
-                /* @var PackageRequireOptions[] $packages */
+                /** @var PackageRequireOptions[] $packages */
                 $this->assertCount(2, $packages);
 
                 $this->assertSame('lodash', $packages[0]->packageModuleSpecifier);
diff --git a/src/Symfony/Component/Console/Tests/Formatter/OutputFormatterTest.php b/src/Symfony/Component/Console/Tests/Formatter/OutputFormatterTest.php
@@ -177,7 +177,7 @@ public function testInlineStyleOptions(string $tag, ?string $expected = null, ?s
             $expected = $tag.$input.'</'.$styleString.'>';
             $this->assertSame($expected, $formatter->format($expected));
         } else {
-            /* @var OutputFormatterStyle $result */
+            /** @var OutputFormatterStyle $result */
             $this->assertInstanceOf(OutputFormatterStyle::class, $result);
             $this->assertSame($expected, $formatter->format($tag.$input.'</>'));
             $this->assertSame($expected, $formatter->format($tag.$input.'</'.$styleString.'>'));
diff --git a/src/Symfony/Component/DependencyInjection/Tests/ContainerBuilderTest.php b/src/Symfony/Component/DependencyInjection/Tests/ContainerBuilderTest.php
@@ -1128,7 +1128,7 @@ public function testAddObjectResource()
 
         $this->assertCount(1, $resources);
 
-        /* @var $resource \Symfony\Component\Config\Resource\FileResource */
+        /** @var \Symfony\Component\Config\Resource\FileResource $resource */
         $resource = end($resources);
 
         $this->assertInstanceOf(FileResource::class, $resource);
diff --git a/src/Symfony/Component/Form/Extension/Validator/Constraints/FormValidator.php b/src/Symfony/Component/Form/Extension/Validator/Constraints/FormValidator.php
@@ -42,7 +42,7 @@ public function validate(mixed $form, Constraint $formConstraint)
             return;
         }
 
-        /* @var FormInterface $form */
+        /** @var FormInterface $form */
         $config = $form->getConfig();
 
         $validator = $this->context->getValidator()->inContext($this->context);
diff --git a/src/Symfony/Component/Form/Extension/Validator/ValidatorExtension.php b/src/Symfony/Component/Form/Extension/Validator/ValidatorExtension.php
@@ -43,7 +43,7 @@ public function __construct(ValidatorInterface $validator, bool $legacyErrorMess
         // the DIC, where the XML file is loaded automatically. Thus the following
         // code must be kept synchronized with validation.xml
 
-        /* @var $metadata ClassMetadata */
+        /** @var ClassMetadata $metadata */
         $metadata->addConstraint(new Form());
         $metadata->addConstraint(new Traverse(false));
 
diff --git a/src/Symfony/Component/Form/Extension/Validator/ViolationMapper/ViolationMapper.php b/src/Symfony/Component/Form/Extension/Validator/ViolationMapper/ViolationMapper.php
@@ -253,7 +253,7 @@ private function matchChild(FormInterface $form, PropertyPathIteratorInterface $
 
             // Test mapping rules as long as we have any
             foreach ($rules as $key => $rule) {
-                /* @var MappingRule $rule */
+                /** @var MappingRule $rule */
 
                 // Mapping rule matches completely, terminate.
                 if (null !== ($form = $rule->match($chunk))) {
@@ -317,7 +317,7 @@ private function reconstructPath(ViolationPath $violationPath, FormInterface $or
                 // Cut the piece out of the property path and proceed
                 $propertyPathBuilder->remove($i);
             } else {
-                /* @var \Symfony\Component\PropertyAccess\PropertyPathInterface $propertyPath */
+                /** @var \Symfony\Component\PropertyAccess\PropertyPathInterface $propertyPath */
                 $propertyPath = $scope->getPropertyPath();
 
                 if (null === $propertyPath) {
diff --git a/src/Symfony/Component/Form/FormBuilder.php b/src/Symfony/Component/Form/FormBuilder.php
@@ -147,7 +147,7 @@ public function count(): int
 
     public function getFormConfig(): FormConfigInterface
     {
-        /** @var $config self */
+        /** @var self $config */
         $config = parent::getFormConfig();
 
         $config->children = [];
diff --git a/src/Symfony/Component/Form/FormErrorIterator.php b/src/Symfony/Component/Form/FormErrorIterator.php
@@ -77,7 +77,7 @@ public function __toString(): string
             if ($error instanceof FormError) {
                 $string .= 'ERROR: '.$error->getMessage()."\n";
             } else {
-                /* @var self $error */
+                /** @var self $error */
                 $string .= $error->getForm()->getName().":\n";
                 $string .= self::indent((string) $error);
             }
diff --git a/src/Symfony/Component/Form/ResolvedFormType.php b/src/Symfony/Component/Form/ResolvedFormType.php
@@ -130,7 +130,7 @@ public function finishView(FormView $view, FormInterface $form, array $options)
         $this->innerType->finishView($view, $form, $options);
 
         foreach ($this->typeExtensions as $extension) {
-            /* @var FormTypeExtensionInterface $extension */
+            /** @var FormTypeExtensionInterface $extension */
             $extension->finishView($view, $form, $options);
         }
     }
diff --git a/src/Symfony/Component/Form/Tests/SimpleFormTest.php b/src/Symfony/Component/Form/Tests/SimpleFormTest.php
@@ -1052,7 +1052,7 @@ public function testInitializeSetsDefaultData()
         $config = $this->getBuilder()->setData('DEFAULT')->getFormConfig();
         $form = new Form($config);
 
-        /* @var Form $form */
+        /** @var Form $form */
         $form->initialize();
 
         $this->assertSame('DEFAULT', $form->getData());
diff --git a/src/Symfony/Component/HttpClient/Response/AmpResponse.php b/src/Symfony/Component/HttpClient/Response/AmpResponse.php
@@ -222,7 +222,7 @@ private static function generateResponse(Request $request, AmpClientState $multi
         });
 
         try {
-            /* @var Response $response */
+            /** @var Response $response */
             if (null === $response = yield from self::getPushedResponse($request, $multi, $info, $headers, $options, $logger)) {
                 $logger?->info(\sprintf('Request: "%s %s"', $info['http_method'], $info['url']));
 
diff --git a/src/Symfony/Component/HttpClient/Tests/MockHttpClientTest.php b/src/Symfony/Component/HttpClient/Tests/MockHttpClientTest.php
@@ -501,7 +501,7 @@ public function testHttp2PushVulcainWithUnusedResponse()
 
     public function testChangeResponseFactory()
     {
-        /* @var MockHttpClient $client */
+        /** @var MockHttpClient $client */
         $client = $this->getHttpClient(__METHOD__);
         $expectedBody = '{"foo": "bar"}';
         $client->setResponseFactory(new MockResponse($expectedBody));
diff --git a/src/Symfony/Component/Mailer/Tests/EventListener/MessengerTransportListenerTest.php b/src/Symfony/Component/Mailer/Tests/EventListener/MessengerTransportListenerTest.php
@@ -41,7 +41,7 @@ public function testMessengerTransportStampViaHeader()
         $event = new MessageEvent($message, $envelope, 'smtp', true);
         $l->onMessage($event);
         $this->assertCount(1, $event->getStamps());
-        /* @var TransportNamesStamp $stamp */
+        /** @var TransportNamesStamp $stamp */
         $this->assertInstanceOf(TransportNamesStamp::class, $stamp = $event->getStamps()[0]);
         $this->assertSame(['async'], $stamp->getTransportNames());
         $this->assertFalse($message->getHeaders()->has('X-Bus-Transport'));
@@ -57,7 +57,7 @@ public function testMessengerTransportStampsViaHeader()
         $event = new MessageEvent($message, $envelope, 'smtp', true);
         $l->onMessage($event);
         $this->assertCount(1, $event->getStamps());
-        /* @var TransportNamesStamp $stamp */
+        /** @var TransportNamesStamp $stamp */
         $this->assertInstanceOf(TransportNamesStamp::class, $stamp = $event->getStamps()[0]);
         $this->assertSame(['async', 'async1', $name], $stamp->getTransportNames());
         $this->assertFalse($message->getHeaders()->has('X-Bus-Transport'));
diff --git a/src/Symfony/Component/Messenger/Bridge/Amqp/Tests/Transport/AmqpExtIntegrationTest.php b/src/Symfony/Component/Messenger/Bridge/Amqp/Tests/Transport/AmqpExtIntegrationTest.php
@@ -116,7 +116,7 @@ public function testRetryAndDelay()
 
         // this should be the custom routing key message first
         $this->assertCount(1, $envelopes);
-        /* @var Envelope $envelope */
+        /** @var Envelope $envelope */
         $receiver->ack($envelopes[0]);
         $this->assertEquals($customRoutingKeyMessage, $envelopes[0]->getMessage());
 
@@ -125,7 +125,7 @@ public function testRetryAndDelay()
         // duration should be about 2 seconds
         $this->assertApproximateDuration($startTime, 2);
 
-        /* @var RedeliveryStamp|null $retryStamp */
+        /** @var RedeliveryStamp|null $retryStamp */
         // verify the stamp still exists from the last send
         $this->assertCount(1, $envelopes);
         $retryStamp = $envelopes[0]->last(RedeliveryStamp::class);
diff --git a/src/Symfony/Component/Messenger/Middleware/RouterContextMiddleware.php b/src/Symfony/Component/Messenger/Middleware/RouterContextMiddleware.php
@@ -58,7 +58,7 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
         $currentPathInfo = $context->getPathInfo();
         $currentQueryString = $context->getQueryString();
 
-        /* @var RouterContextStamp $contextStamp */
+        /** @var RouterContextStamp $contextStamp */
         $context
             ->setBaseUrl($contextStamp->getBaseUrl())
             ->setMethod($contextStamp->getMethod())
diff --git a/src/Symfony/Component/Messenger/Tests/EventListener/SendFailedMessageToFailureTransportListenerTest.php b/src/Symfony/Component/Messenger/Tests/EventListener/SendFailedMessageToFailureTransportListenerTest.php
@@ -26,7 +26,7 @@ public function testItSendsToTheFailureTransportWithSenderLocator()
         $receiverName = 'my_receiver';
         $sender = $this->createMock(SenderInterface::class);
         $sender->expects($this->once())->method('send')->with($this->callback(function ($envelope) use ($receiverName) {
-            /* @var Envelope $envelope */
+            /** @var Envelope $envelope */
             $this->assertInstanceOf(Envelope::class, $envelope);
 
             /** @var SentToFailureTransportStamp $sentToFailureTransportStamp */
@@ -101,7 +101,7 @@ public function testItSendsToTheFailureTransportWithMultipleFailedTransports()
         $receiverName = 'my_receiver';
         $sender = $this->createMock(SenderInterface::class);
         $sender->expects($this->once())->method('send')->with($this->callback(function ($envelope) use ($receiverName) {
-            /* @var Envelope $envelope */
+            /** @var Envelope $envelope */
             $this->assertInstanceOf(Envelope::class, $envelope);
 
             /** @var SentToFailureTransportStamp $sentToFailureTransportStamp */
diff --git a/src/Symfony/Component/Messenger/Tests/Middleware/SendMessageMiddlewareTest.php b/src/Symfony/Component/Messenger/Tests/Middleware/SendMessageMiddlewareTest.php
@@ -41,7 +41,7 @@ public function testItSendsTheMessageToAssignedSender()
 
         $envelope = $middleware->handle($envelope, $this->getStackMock(false));
 
-        /* @var SentStamp $stamp */
+        /** @var SentStamp $stamp */
         $this->assertInstanceOf(SentStamp::class, $stamp = $envelope->last(SentStamp::class), 'it adds a sent stamp');
         $this->assertSame('my_sender', $stamp->getSenderAlias());
         $this->assertStringMatchesFormat('Mock_SenderInterface_%s', $stamp->getSenderClass());
diff --git a/src/Symfony/Component/OptionsResolver/Tests/OptionsResolverTest.php b/src/Symfony/Component/OptionsResolver/Tests/OptionsResolverTest.php
@@ -1368,7 +1368,7 @@ public function testNormalizerCanAccessOtherOptions()
         $this->resolver->setDefault('norm', 'baz');
 
         $this->resolver->setNormalizer('norm', function (Options $options) {
-            /* @var TestCase $test */
+            /** @var TestCase $test */
             Assert::assertSame('bar', $options['default']);
 
             return 'normalized';
@@ -1386,7 +1386,7 @@ public function testNormalizerCanAccessLazyOptions()
         $this->resolver->setDefault('norm', 'baz');
 
         $this->resolver->setNormalizer('norm', function (Options $options) {
-            /* @var TestCase $test */
+            /** @var TestCase $test */
             Assert::assertEquals('bar', $options['lazy']);
 
             return 'normalized';
diff --git a/src/Symfony/Component/PropertyAccess/PropertyPath.php b/src/Symfony/Component/PropertyAccess/PropertyPath.php
@@ -72,7 +72,7 @@ public function __construct(self|string $propertyPath)
     {
         // Can be used as copy constructor
         if ($propertyPath instanceof self) {
-            /* @var PropertyPath $propertyPath */
+            /** @var PropertyPath $propertyPath */
             $this->elements = $propertyPath->elements;
             $this->length = $propertyPath->length;
             $this->isIndex = $propertyPath->isIndex;
diff --git a/src/Symfony/Component/PropertyInfo/Extractor/PhpDocExtractor.php b/src/Symfony/Component/PropertyInfo/Extractor/PhpDocExtractor.php
@@ -73,7 +73,7 @@ public function __construct(?DocBlockFactoryInterface $docBlockFactory = null, ?
 
     public function getShortDescription(string $class, string $property, array $context = []): ?string
     {
-        /** @var $docBlock DocBlock */
+        /** @var DocBlock $docBlock */
         [$docBlock] = $this->getDocBlock($class, $property);
         if (!$docBlock) {
             return null;
@@ -100,7 +100,7 @@ public function getShortDescription(string $class, string $property, array $cont
 
     public function getLongDescription(string $class, string $property, array $context = []): ?string
     {
-        /** @var $docBlock DocBlock */
+        /** @var DocBlock $docBlock */
         [$docBlock] = $this->getDocBlock($class, $property);
         if (!$docBlock) {
             return null;
@@ -113,7 +113,7 @@ public function getLongDescription(string $class, string $property, array $conte
 
     public function getTypes(string $class, string $property, array $context = []): ?array
     {
-        /** @var $docBlock DocBlock */
+        /** @var DocBlock $docBlock */
         [$docBlock, $source, $prefix] = $this->getDocBlock($class, $property);
         if (!$docBlock) {
             return null;
diff --git a/src/Symfony/Component/Translation/Bridge/Crowdin/CrowdinProvider.php b/src/Symfony/Component/Translation/Bridge/Crowdin/CrowdinProvider.php
@@ -131,7 +131,7 @@ public function read(array $domains, array $locales): TranslatorBag
             }
         }
 
-        /* @var ResponseInterface $response */
+        /** @var ResponseInterface $response */
         $downloads = [];
         foreach ($responses as [$response, $locale, $domain]) {
             if (204 === $response->getStatusCode()) {
diff --git a/src/Symfony/Component/Validator/Constraints/Composite.php b/src/Symfony/Component/Validator/Constraints/Composite.php
@@ -55,7 +55,7 @@ public function __construct(mixed $options = null, ?array $groups = null, mixed
 
         $this->initializeNestedConstraints();
 
-        /* @var Constraint[] $nestedConstraints */
+        /** @var Constraint[] $nestedConstraints */
         $compositeOption = $this->getCompositeOption();
         $nestedConstraints = $this->$compositeOption;
 
@@ -137,7 +137,7 @@ abstract protected function getCompositeOption(): string;
      */
     public function getNestedConstraints(): array
     {
-        /* @var Constraint[] $nestedConstraints */
+        /** @var Constraint[] $nestedConstraints */
         return $this->{$this->getCompositeOption()};
     }
 
diff --git a/src/Symfony/Component/Validator/Tests/Validator/RecursiveValidatorTest.php b/src/Symfony/Component/Validator/Tests/Validator/RecursiveValidatorTest.php
diff --git a/src/Symfony/Component/Validator/Validator/RecursiveContextualValidator.php b/src/Symfony/Component/Validator/Validator/RecursiveContextualValidator.php
diff --git a/src/Symfony/Contracts/Service/ServiceSubscriberTrait.php b/src/Symfony/Contracts/Service/ServiceSubscriberTrait.php

Original file line number	Diff line number	Diff line change
`@@ -157,7 +157,7 @@ private function createFieldChoicesList(iterable $choices, string\|false\|null $tr`
`157`	`157`	`continue;`
`158`	`158`	`}`
`159`	`159`
`160`		`- /* @var ChoiceView $choice */`
	`160`	`+ /** @var ChoiceView $choice */`
`161`	`161`	`$translatableLabel = $this->createFieldTranslation($choice->label, $choice->labelTranslationParameters, $translationDomain);`
`162`	`162`	`yield $translatableLabel => $choice->value;`
`163`	`163`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public function build(ContainerBuilder $container): void`
`24`	`24`	`{`
`25`	`25`	`parent::build($container);`
`26`	`26`
`27`		`- /** @var $extension DependencyInjection\TestExtension */`
	`27`	`+ /** @var DependencyInjection\TestExtension $extension */`
`28`	`28`	`$extension = $container->getExtension('test');`
`29`	`29`
`30`	`30`	`if (!$container->getParameterBag() instanceof FrozenParameterBag) {`